質問非公開API

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

リクエストURL

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

テスト用APIを利用したい場合は、こちらから利用申請をお願いします。

リクエストパラメータ

リクエストURL

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

リクエストボディ

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

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

サンプルリクエストURL

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

サンプルリクエスト

PUT https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkPrivate?
topicId=xxxxx1c9d64b3a2bcd89926e43bece987ad80457420dc7e94c7dedfd153a88bd HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>

レスポンスフィールド

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

サンプルレスポンス

レスポンス（JSON）

{
    "status": "ok",
}

エラー

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

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

利用制限

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

利用約款

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

アプリケーションの管理

開発のヒント