在庫検索API

指定した商品の在庫情報の取得を行います。

商品ごとに最大100件まで取得できます。

まずはじめに、「概要」「共通仕様」について、futureshop APIv2についてをご覧ください。

ご注意事項

• 商品ごと」とは、レスポンスデータ「productList」内の「id（商品ID）」単位を指します。
  なお、バリエーション数（レスポンスデータ「inventoryInfo」内の「skuNo（SKU番号）」）はカウントしません。
• 在庫検索APIでは商品情報の一部を取得ができますが、呼び出し回数に制限がございます(1秒間に1回) 。
  そのため、他のAPIと同様、ECサイトやアプリでの画面表示の用途にはご利用いただけません。

基本仕様

• 実店舗在庫情報も検索できます。（実店舗在庫表示機能ご利用店舗のみ）

＜目次＞

• URL
• HTTPメソッド
• リクエストヘッダー
• リクエストボディ
• パラメータ
• レスポンス
• エラーレスポンス
  • エラーコード
• サンプル

URL

https://{APIドメイン}/admin-api/v1/inventory

HTTPメソッド

GET

リクエストヘッダー

アクセストークンなどの詳細はアクセストークンによる認証を参照してください。

リクエストボディ

なし

パラメータ

※実店舗在庫情報に関するパラメータは、実店舗在庫表示機能ご利用店舗のみご利用可能です。

レスポンス

※実店舗在庫情報については、実店舗在庫表示機能ご利用店舗のみ検索可能です。

エラーレスポンス

エラー発生時に以下のレスポンスが返却されます。

エラーコード

サンプル

{
    "status": "failed",
    "errors": [
        {
            "code": "InvalidValue",
            "path": "types",
            "message": "typesの指定が不正です"
        }
    ]
}