メッセージ投稿API

お客様から受けたお問い合わせに対して、メッセージの投稿（返答）を行います。
※お客様には、出店者様から投稿があったことをメールで通知します。

変更履歴

2023年10月30日

サービス名称変更に伴い下記文言を修正しました。
ヤフオク!、ヤフオク　→　Yahoo!オークション

2022年3月4日

・リクエストパラメータに下記項目を追加しました。
　orderId（注文ID）
・リクエストパラメータの「説明」を修正しました。
　対象項目：filePath
　修正前）ファイルパス
　修正後）ファイル投稿API入稿時に発行されるobjectKeyをfilePathに指定してください

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkAdd
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkAdd

リクエストパラメータ

「Web APIの使い方#POSTとは」をご参照ください。

リクエストURL

パラメータ 必須 型 値の例 説明
topicId 〇 string xxxxx1c9d64b3a2bcd89926e43bece987ad80457420dc7e94c7dedfd153a88bd 質問のトピックID

リクエストボディ（Content-Type: application/json）

パラメータ 必須 型 値の例 説明
body 〇 string "お問い合わせありがとうございます。こちらの商品の発送日は明日を予定しております。" 本文（2000文字まで）
本文中に「LF（0x0A）」を入力することで改行できます
sellerId 〇 string teststore ストアアカウント
orderId string "teststore-10050744" 注文ID（ストアアカウント_注文番号）
※Yahoo!オークションの注文前落札が注文後落札になった場合のみ指定
fileList array （ファイル添付がある場合配列で指定）
fileName string "file0001.png" ファイル名
filePath string "dbea2267f4636019f533dde/20180901000000_USER.png" ファイル投稿API入稿時に発行されるobjectKeyをfilePathに指定してください。
fileExt string "png" ファイルの拡張子

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkAdd?topicId=
xxxxx1c9d64b3a2bcd89926e43bece987ad80457420dc7e94c7dedfd153a88bd

サンプルリクエスト

POST https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkAdd?topicId=
xxxxx1c9d64b3a2bcd89926e43bece987ad80457420dc7e94c7dedfd153a88bd HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
Content-Type: application/json; charset=UTF-8

{
  "sellerId": "teststore",
  "body": "お問い合わせありがとうございます。こちらの商品の発送日は明日を予定しております。",
  "fileList": [
    {
      "fileName": "file0001.png",
      "filePath": "dbea2267f4636019f533dde/20180901000000_USER.png",
      "fileExt": "png"
    }]
  }
}

レスポンスフィールド

フィールド 型 値の例 説明
topicid string リクエスト時に指定したトピックID
messageid string 1 発行されたメッセージID
postdate string "1513776685" メッセージ投稿時間(UNIX時間)

サンプルレスポンス

レスポンス（JSON）

{
  "topicid": "dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde",
  "messageid":1,
  "postdate":"1513776685"
}

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

メッセージ投稿APIで固有に返すエラーコードは以下をご覧ください。

HTTPステータスコード 説明
400 Bad request. 渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。
401 Unauthorized. 認証に失敗した場合に返されます。
404 Not found. 存在しないリソースにアクセスされた場合に返されます。
500 Internal Server Error. サーバー側で異常が発生した場合に返されます。
503 Service unavailable. 内部的な問題によってデータを返すことができない場合に返されます。

各エラーにおいて、次の形式のJSONレスポンスを返します。

フィールド 説明
error.reason エラー事由が記載されます。 
{
     error : {
        reason: "Bad Request"
     }
}

ご注意

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。

※こちらのAPIを利用する場合は、こちらからClient ID（アプリケーションID）を取得してください。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

このAPIに関する利用約款はこちら。

アプリケーションの管理

利用のルール

開発のヒント