コマースクリエイターでのショップ開店がはじめての方はこちら ショップ開店ガイド
オプション
<ご契約状況管理画面の使い方>
  • [契約管理ポータル]
コマースクリエイターでのショップ開店がはじめての方はこちら ショップ開店ガイド
オプション
<ご契約状況管理画面の使い方>
  • [契約管理ポータル]
コマースクリエイターでのショップ開店がはじめての方はこちら ショップ開店ガイド
オプション
<ご契約状況管理画面の使い方>
  • [契約管理ポータル]
コマースクリエイターでのショップ開店がはじめての方はこちら ショップ開店ガイド
オプション
<ご契約状況管理画面の使い方>
  • [契約管理ポータル]

在庫検索API

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

商品ごとに最大100件まで取得できます。
※「商品ごと」とは、レスポンスデータ「productList」内の「id(商品ID)」単位を指します。
 なお、バリエーション数(レスポンスデータ「inventoryInfo」内の「skuNo(SKU番号)」)はカウントしません。

※実店舗在庫情報も検索できます。(実店舗在庫表示機能ご利用店舗のみ)
※在庫検索APIでは商品情報の一部を取得ができますが、呼び出し回数に制限がございます(1秒間に1回) 。
 そのため、他のAPIと同様、ECサイトやアプリでの画面表示の用途にはご利用いただけません。

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

更新/更新予定

※「(予定)」のものは、更新内容が変わる可能性がございます。

更新日/予定日 更新内容 更新理由
2022.06.23 レスポンス id(商品ID)のバイト数変更 参照

更新履歴はAPI更新履歴一覧をご覧ください。

URL

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

HTTPメソッド

GET

リクエストヘッダー

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

リクエストボディ

なし

パラメータ

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

key 項目名 必須 内容
types 在庫種類 regular:通常在庫
preorder:予約在庫
planned:予定在庫
realstore:実店舗在庫
カンマ区切りで複数指定可能
createDateStart 商品登録日時(start) 「yyyy-mm-ddThh:mm:ss」形式
createDateEnd 商品登録日時(end) 「yyyy-mm-ddThh:mm:ss」形式
productNo 商品番号 カンマ区切りで複数指定可能
janCode JANコード カンマ区切りで複数指定可能
指定したJANコードが含まれる商品情報を検索

レスポンス

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

key 項目名 必須 byte 内容
nextUrl ネクストURL String - 100件を超過する結果の場合、次のデータ取得のURL を返却
productList 商品リスト Array - 商品ごとに配列出力。最大100件
id 商品ID Number 18
url 商品URL String 32 ※「URLコード」を出力
productNo 商品番号 String 32
name 商品名 String 300
visible 公開フラグ Boolean - true:公開
false:非公開
unitPrice 販売価格 Number 9
taxEnabled 消費税設定 Boolean - true:消費税込
false:消費税別
taxRate 税率 Number 2
coolDeliveryEnabled クール便指定 Boolean - true:クール便指定あり
false:クール便指定なし
mailDeliveryEnabled メール便指定 Boolean - true:メール便指定あり
false:メール便指定なし
inventoryEnabled 在庫管理フラグ Boolean - true:在庫管理する
false:在庫管理しない
variationEnabled バリエーション商品フラグ Boolean - true:バリエーション商品
false:非バリエーション商品
preorderEnabled 予約設定フラグ Boolean - true:予約在庫設定あり
false:予約在庫設定なし
type 商品種類 String 24 REGULAR:通常
SUBSCRIPTION_ONLY:定期
REGULAR_AND_SUBSCRIPTION:通常・定期
HANPUKAI:頒布会
plannedStockEnabled 予定在庫設定フラグ Boolean - true:予定在庫設定あり
false:予定在庫設定なし
dateCreated 登録日時 String 19 「yyyy-mm-ddThh:mm:ss」形式
inventoryInfo 在庫情報 - -
regular 通常在庫リスト - - 在庫タイプに通常在庫を指定した場合に出力
inventoryList 在庫リスト Array - SKUごとに配列出力
skuNo SKU番号 String 232 商品番号+枝番(横軸)+枝番(縦軸)
verticalNo 枝番(縦軸) String 100 バリエーション商品の場合に項目出力
horizontalNo 枝番(横軸) String 100 バリエーション商品の場合に項目出力
janCode JANコード String 30
count 在庫数 Number 9
preorder 予約在庫リスト - - 在庫タイプに予約在庫を指定した場合に出力
inventoryList 在庫リスト Array - SKUごとに配列出力
skuNo SKU番号 String 232 商品番号+枝番(横軸)+枝番(縦軸)
verticalNo 枝番(縦軸) String 100 バリエーション商品の場合に項目出力
horizontalNo 枝番(横軸) String 100 バリエーション商品の場合に項目出力
janCode JANコード String 30
count 在庫数 Number 9
plannedList 予定在庫リスト Array - 在庫タイプに予定在庫を指定した場合に出力
予定日ごとの配列出力
date 予定日 String 10 「yyyy-mm-dd」形式
enabled 予定在庫設定フラグ Boolean - true:予定在庫管理する
false:予定在庫管理しない
inventoryList 在庫リスト Array - SKUごとに配列出力
skuNo SKU番号 String 232 商品番号+枝番(横軸)+枝番(縦軸)
verticalNo 枝番(縦軸) String 100 バリエーション商品の場合に項目出力
horizontalNo 枝番(横軸) String 100 バリエーション商品の場合に項目出力
janCode JANコード String 30
count 在庫数 Number 9
realStoreList 実店舗在庫リスト Array
storeCode 実店舗コード String 10
inventoryList 在庫リスト Array - SKUごとに配列出力
skuNo SKU番号 String 232 商品番号+枝番(横軸)+枝番(縦軸)
verticalNo 枝番(縦軸) String 100 バリエーション商品の場合に項目出力
horizontalNo 枝番(横軸) String 100 バリエーション商品の場合に項目出力
janCode JANコード String 30
count 在庫数 Number 9
text 在庫表示テキスト String 100
dataTimestamp データ連携日時 String 19 1「yyyy-mm-ddThh:mm:ss」形式

エラーレスポンス

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

key 項目名 必須 byte 内容
stauts ステータス String -
errors エラーリスト Array -
code コード String -
path パス String - エラーが発生したパラメータ名が出力されます
message メッセージ String -

エラーコード

コード メッセージ 説明
InvalidDateFormat createDateStartの日付フォーマットを正しく指定してください
createDateEndの日付フォーマットを正しく指定してください
「yyyy-mm-ddThh:mm:ss」形式ではない場合に返却されます。
InvalidDateRange createDateStartはcreateDateEndより前の日時を指定してください 商品登録日時の開始日時が終了日時よりも未来日付の場合に返却されます。
TooLong productNoは60文字以内で指定してください 1商品の商品番号が60文字を超過した場合に返却されます。
TooMany productNoの指定は100件までです 商品番号の指定が100件を超過した場合に返却されます。
TooLong janCodeは30文字以内で指定してください 1商品のJANコードが30byteを超過した場合に返却されます。
TooMany janCodeの指定は100件までです JANコードの指定が100件を超過した場合に返却されます。
InvalidValue typesの指定が不正です 在庫種類ではない指定が行われた場合に返却されます。
Required typesを指定してください typesのパラメータが設定されていない場合に返却されます。
サンプル
{
    "status": "failed",
    "errors": [
        {
            "code": "InvalidValue",
            "path": "types",
            "message": "typesの指定が不正です"
        }
    ]
}