店頭在庫情報取得API

店舗在庫情報を取得することができます。

変更履歴

リクエストURL

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

リクエストパラメータ

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

リクエストURL

パラメータ	必須	デフォルト値	値の例	説明	補足
sellerId	〇		teststore	セラーID
srId			item0001	セラーリソース識別子
skuId			blue_s	商品在庫単品管理ID

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/getRealStock?sellerId=teststore&srId=item0001&skuId=blue_s

レスポンスフィールド

要素	型	値の例	説明
/stocks	Array		在庫オブジェクト配列
/stocks/sellerId	string	teststore	セラーID
/stocks/srId	string	item0001	セラーリソース識別子
/stocks/skuId	string	blue_s	商品在庫単品管理ID
/stocks/storeInStock	string	1:3:10	店頭在庫ありの店舗コードリスト
/stocks/storeInStockFew	string	1:3:10	店頭在庫わずかの店舗コードリスト
/stocks/storeInStockUpdatedTime	string	2020-01-31 23:05:00	店頭在庫更新日時

サンプルレスポンス

レスポンス（JSON）

{
  "stocks": [
    {
      "sellerId": "teststore",
      "srId": "item0001",
      "skuId": "blue_s",
      "storeInStock": "1:3:10",
      "storeInStockFew": "1:3:10",
      "storeInStockUpdatedTime": "2020-01-31 23:05:00"
    },
    {
      "sellerId": "teststore",
      "srId": "item0002",
      "skuId": "red_l",
      "storeInStock": "1:3:10",
      "storeInStockFew": "1:3:10",
      "storeInStockUpdatedTime": "2020-01-31 23:05:00"
    }
  ]
}

エラー

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

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

店頭在庫情報取得APIで固有に返すエラーは、以下のJSONレスポンスを返します。

要素	型
/type	string
/title	int
/status	string
/detail	string

サンプルエラーレスポンス

{
    "type":"about:blank",
    "title":"Bad Request",
    "detail":"Failed to read HTTP message",
    "status":400
}

ご注意

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。

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

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

利用制限

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

利用約款

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