質問既読API

お客様から受けたお問い合わせを出店者様側で「既読」にすることができます。

リクエストURL

リクエストパラメータ

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

リクエストURL

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

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

パラメータ	必須	値	説明
sellerId	〇	string	ストアアカウント

サンプルリクエストURL

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

サンプルリクエスト

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

{"sellerId": "teststore"}

レスポンスフィールド

要素	型	値の例	説明
status	string	ok	ok：成功

サンプルレスポンス

レスポンス（JSON）

{
    "status": "ok",
}

エラー

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

• 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アクセス方法の詳細は、以下のページをご確認ください。

• Yahoo! ID連携
• Yahoo! ID連携によるAPIアクセス実装方法

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

利用制限

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

利用約款

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