ショッピング用セラー新規問い合わせ投稿API

注文されたお客様に対して出店者様から問い合わせを投稿できます。

変更履歴

リクエストURL

リクエストパラメータ

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

リクエストURL

パラメータ	必須	型	値の例	説明
（なし）

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

※2023年4月17日(月)以降、
　以前のリクエストボディ（application/x-www-form-urlencode）は利用不可となります。

パラメータ	必須	型	値の例	説明
sellerId	〇	string	"teststore"	投稿するストアのセラーID（ストアアカウント）
categoryId	〇	int	42	投稿する質問のカテゴリー （別表：「カテゴリID一覧」の項に記載のIDを指定してください）
orderId	〇	string	"teststore-10174841"	注文ID
title	〇	string	"ストアからの連絡事項です"	質問のタイトル
body	〇	string	"メッセージ本文が入ります"	質問の本文 本文中に「LF（0x0A）」を入力することで改行できます

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V2/externalStoreTopic

サンプルリクエスト

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

{
  "sellerId": "teststore",
  "categoryId": 42,
  "orderId": "teststore-10174841",
  "title": "ストアからの連絡事項です",
  "body": "メッセージ本文が入ります"
}

レスポンスフィールド

要素	型	値の例	説明
topicId	string	"dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde"	生成したトピックID

サンプルレスポンス

レスポンス（JSON）

{
  "topicid": "dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde",
}

カテゴリID一覧

※「投稿時に選択可能」項目について
質問投稿時には親カテゴリ、子カテゴリ双方の選択が必須のため、「✕」となっているカテゴリ（子カテゴリ選択が必須なカテゴリ）IDは指定できません。

カテゴリID	カテゴリ名	対象サービス	投稿時に選択可能
30	お支払い	ショッピング	✕
31	お支払い（支払い方法の連絡）	ショッピング	〇
32	お支払い（未入金の連絡）	ショッピング	〇
33	お支払い（その他）	ショッピング	〇
34	発送	ショッピング	✕
35	発送（発送先の確認）	ショッピング	〇
36	発送（発送日時の連絡）	ショッピング	〇
37	発送（再発送の連絡）	ショッピング	〇
38	発送（その他）	ショッピング	〇
39	注文内容	ショッピング	✕
40	注文内容（注文内容の確認）	ショッピング	〇
41	注文内容（注文キャンセルの連絡）	ショッピング	〇
42	注文内容（その他）	ショッピング	〇
43	領収書	ショッピング	〇
44	その他	ショッピング	〇

エラー

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

• Yahoo! ショッピングAPI共通エラーコード一覧

ショッピング用セラー新規問い合わせ投稿APIで固有に返すエラーコードは以下をご覧ください。

HTTPステータスコード	説明
400	Bad request. 渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。
401	Unauthorized. 新規投稿へのアクセス権がない場合 ipaddress : 不正アドレスアクセスで認証失敗 user : ユーザー認証失敗
404	Not found. 存在しないリソースにアクセスされた場合に返されます。
409	Conflict. リクエストしたOrderIdのTopicIdがすでに存在する場合
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はショッピング専用のためYahoo!オークションの競り商品などにはご利用いただけません。
　　Yahoo!オークション用APIは「Yahoo!オークション用セラー新規問い合わせ投稿API」を別途ご用意しておりますのでこちらをご利用ください。
※こちらのAPIを利用する場合は、こちらからClient ID（アプリケーションID）を取得してください。

利用制限

短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）
1日50,000リクエストを超える場合は、Client ID（アプリケーションID）を追加してご対応ください。

利用約款

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