質問完了API
- お客様から受けたお問い合わせを出店者様側で「完了」にすることができます。
変更履歴
2022年03月28日
完了条件「(未指定)」「1」の条件を下記のように修正しました。修正前)なし
修正後)出店者の返信が1回以上ある場合(※1)に指定可能
実施時期:5月中
※詳細な日程が決まり次第改めてご案内いたします。
2022年02月22日
完了条件「(未指定)」「1」の条件を下記のように修正しました。修正前)出店者の返信が最後の場合指定可能
修正後)なし
リクエストURL
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkComplete
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkComplete
リクエストパラメータ
「Web APIの使い方#PUTとは」をご参照ください。
リクエストURL
パラメータ | 必須 | 型 | 値の例 | 説明 |
---|---|---|---|---|
topicId | 〇 | string | xxxxx1c9d64b3a2bcd89926e43bece987ad80457420dc7e94c7dedfd153a88bd | 質問のトピックID |
リクエストボディ(Content-Type: application/json)
パラメータ | 必須 | 値 | 説明 |
---|---|---|---|
sellerId | 〇 | string | ストアアカウント |
completeConditionId | string | 完了条件 (設定値は下記表を参照) |
完了条件
値 | 意味 | 条件 |
---|---|---|
(未指定) | 通常完了 | |
1 | 通常完了 | |
2 | 電話完了 | なし |
3 | メール対応 | なし |
4 | 同一質問 | なし |
5 | 回答不要 | なし |
- ※1「メッセージ投稿API」より1回以上返信していること
サンプルリクエストURL
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkComplete?
topicId=xxxxx1c9d64b3a2bcd89926e43bece987ad80457420dc7e94c7dedfd153a88bd
サンプルリクエスト
PUT https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkComplete?
topicId=xxxxx1c9d64b3a2bcd89926e43bece987ad80457420dc7e94c7dedfd153a88bd HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
Content-Type: application/json; charset=UTF-8
{"sellerId": "teststore", "completeConditionId": "3"}
レスポンスフィールド
要素 | 型 | 値の例 | 説明 |
---|---|---|---|
status | string | ok | ok:成功 |
サンプルレスポンス
レスポンス(JSON)
{
"status": "ok",
}
エラー
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に関する利用約款はこちら。