ショッピング
メッセージ投稿API
お客様から受けたお問い合わせに対して、メッセージの投稿（返答）を行います。
※お客様には、出店者様から投稿があったことをメールで通知します。
変更履歴（2020年12月2日）
下記項目をリクエストURLのパラメータからリクエストボディのパラメータに変更しました。
・sellerId（ストアアカウント）
下記項目をリクエストURLのパラメータからリクエストボディのパラメータに変更しました。
・sellerId（ストアアカウント）
リクエストURL
リクエストURL
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkAdd
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkAdd
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
リクエストURL
| パラメータ | 必須 | 型 | 値の例 | 説明 |
|---|---|---|---|---|
| topicId | 〇 | string | xxxxx1c9d64b3a2bcd89926e43bece987ad80457420dc7e94c7dedfd153a88bd | 質問のトピックID |
リクエストボディ
「RESTリクエストの構築（POST）」をご参照ください。
| パラメータ | 必須 | 型 | 値の例 | 説明 | |
|---|---|---|---|---|---|
| body | 〇 | string | "お問い合わせありがとうございます。こちらの商品の発送日は明日を予定しております。" | 本文（2000文字まで） | |
| sellerId | 〇 | string | teststore | ストアアカウント | |
| fileList | array | （ファイル添付がある場合配列で指定） | |||
| fileName | string | "file0001.png" | ファイル名 | ||
| filePath | string | "dbea2267f4636019f533dde/20180901000000_USER.png" | ファイルパス | ||
| 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 <アクセストークン>
レスポンスフィールド
| フィールド | 型 | 値の例 | 説明 |
|---|---|---|---|
| topicid | string | リクエスト時に指定したトピックID | |
| messageid | string | 1 | 発行されたメッセージID |
| postdate | string | "1513776685" | メッセージ投稿時間(UNIX時間) |
サンプルレスポンス
レスポンス（JSON）
{
"topicid": "dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde",
"messageid":1,
"postdate":"1513776685"
}
エラー
メッセージ投稿APIはYahoo! JAPAN Web 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アクセス方法の詳細は、以下のページをご確認ください。
・Yahoo! ID連携
・Yahoo! ID連携によるAPIアクセス実装方法
※こちらのAPIを利用する場合は、こちらからアプリケーションIDを取得してください。
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。（無料）
申請受付は停止中です。
1日50,000リクエストを超える場合は、アプリケーションIDを追加してご対応ください。
利用約款
このAPIに関する利用約款はこちら。