店舗在庫情報登録更新API
店舗在庫情報を登録・更新することができます。
変更履歴
2020年10月06日
仕様書を公開しました。
リクエストURL
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/setRealStock
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/setRealStock
テスト用APIを利用したい場合は、こちらから利用申請をお願いします。
リクエストパラメータ
「Web APIの使い方#POSTとは」をご参照ください。
リクエストURL
パラメータ | 必須 | デフォルト値 | 値の例 | 説明 | 補足 |
---|---|---|---|---|---|
/sellerId | 〇 | teststore | セラーID | ||
/stocks | 〇 | 店舗在庫情報の配列 | |||
/stocks/srId | 〇 | item0001 | セラーリソース識別子 | ||
/stocks/skuId | blue_s | 商品在庫単品管理ID | skuの無い商品はNULL可 | ||
/stocks/storeInStock | 〇 | 1:3:10 | 店頭在庫ありの店舗コードリスト | ||
/stocks/storeInStockFew | 〇 | 1:3:10 | 店頭在庫わずかの店舗コードリスト | ||
/stocks/storeInStockUpdatedTime | 〇 | 2020-01-31 23:05:00 | 店頭在庫更新日時 |
サンプルリクエストURL
curl -X POST "https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/setRealStock" -H "accept: application/json" -H "Content-Type: application/json" -d
'{
"sellerId": "teststore",
"stocks": [
{
"srId": "item0001",
"skuId": "blue_s",
"storeInStock": "1:3:10",
"storeInStockFew": "1:3:10",
"storeInStockUpdatedTime": "2020-01-31 23:05:00"
},
{
"srId": "item0002",
"skuId": "red_l",
"storeInStock": "1:3:10",
"storeInStockFew": "1:3:10",
"storeInStockUpdatedTime": "2020-01-31 23:05:00"
}
]
}'
レスポンスフィールド
要素 | 型 | 値の例 | 説明 |
---|---|---|---|
/status | string | ok | ステータス |
サンプルレスポンス
レスポンス(JSON)
{
"status": "ok"
}
エラー
Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。
店舗在庫情報登録更新APIで固有に返すエラーは、以下のJSONレスポンスを返します。
要素 | 型 |
---|---|
/type | string |
/title | string |
/detail | string |
/status | integer |
サンプルエラーレスポンス
{
"type":"about:blank",
"title":"Bad Request",
"detail":"Failed to read HTTP message",
"status":400
}
ご注意
※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。
※こちらのAPIを利用する場合は、こちらからClient ID(アプリケーションID)を取得してください。
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
利用約款
このAPIに関する利用約款はこちら。