実店舗在庫更新API

指定した商品の実店舗在庫を更新します。

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

基本仕様

実店舗在庫表示機能ご利用店舗のみご利用いただけます。
※指定した商品の実店舗在庫情報がない場合、新規登録されます。
商品ごとに最大100件まで更新できます。

＜目次＞

URL
HTTPメソッド
リクエストヘッダー
リクエストボディ(json)
- サンプル（リクエストボディ）
レスポンス
- エラーコード
サンプル

更新/更新予定

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

更新日/予定日	更新内容		更新理由
2023.01.31	エラーコード	「StockNotFound」記載追加	-	参照
2023.01.13	エラーコード	「InvalidDateFormat,ProductNotFound,NotManagementSettings」記載追加	-	参照

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

URL

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

HTTPメソッド

POST

リクエストヘッダー

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

リクエストボディ(json)

key					項目名	必須	型	byte	内容
productList					商品リスト	○	Array	-	商品ごとに配列。最大100件
	productNo				商品番号	○	String	32
	inventoryInfo				在庫情報		-	-
		realStoreList			実店舗在庫リスト		-	-
			storeCode		実店舗コード	○	String	10
			inventoryList		在庫リスト	○	Array	-	SKUごとに配列
				verticalNo	枝番(縦軸)	○	String	9
				horizontalNo	枝番(横軸)	○	String	9
				count	在庫数	○	Number	9	指定値更新のみ
				text	在庫表示テキスト		String	100	指定がない場合、空文字が設定されます。
				dataTimestamp	データ連携日時	○	String	19	「yyyy-mm-ddThh:mm:ss」形式

サンプル（リクエストボディ）

{
  "productList": [
      {
          "productNo": "postage-nomal-no",
          "inventoryInfo": {
              "realStoreList": [
                  {
                      "storeCode": "tokyo",
                      "inventoryList": [
                          {
                              "verticalNo": "aaa",
                              "horizontalNo": "bbb",
                              "count": 1,
                              "text": "在庫残りわずか",
                              "dataTimestamp": "2021-12-12T22:22:22"
                          }
                      ]
                  }
              ]
          }
      }
  ]
}

レスポンス

key		項目名	必須	型	byte	内容
status		ステータス	○	String	-	成功：success 失敗：failed ※一部更新失敗の場合、failedを出力
errors		エラーリスト		Array	-	リクエストのエラー発生時に出力
	code	コード	○	String	-
	path	パス		String	-	入力値エラーの場合、対象のjson位置を出力
	message	メッセージ	○	String	-	エラーの概要が出力されます。
results		リザルト		Array	-	処理結果
	status	ステータス		String	-	成功：success 失敗：failed
	productNo	商品番号		String	-
	code	コード		String	-
	message	メッセージ		String	-

エラーコード

errors

コード	メッセージ	説明
WrongFormat	リクエストデータがjson形式ではありません	json形式ではない場合に返却されます。
InvalidDateFormat	◯◯の日付フォーマットを正しく指定してください	日付のフォーマットが不正の場合に出力します。
ErrorsPresent	エラーが発生した商品があります	更新時に問題が発生した場合に返却されます。resultsのエラー内容をご確認下さい。

results

サンプル

サンプル（エラー時）

{
  "status": "failed",
  "errors": [
        {
            "code": "ErrorsPresent",
            "message": "エラーが発生しました"
        }
    ],
  "results": [
    {
      "status": "failed",
      "productNo": "gd1",
      "code": "StockNotFound",
      "message": "指定された在庫が登録されていません"
    }
  ]
}

サンプル（成功時）

{
  "status": "success",
  "results": [
    {
      "status": "success",
      "productNo": "gd64"
    },
    {
      "status": "success",
      "productNo": "gd65"
    }
  ]
}

サンプル（一部失敗/一部成功時）

{
    "status": "failed",
    "errors": [
        {
            "code": "ErrorsPresent",
            "message": "エラーが発生しました"
        }
    ],
    "results": [
        {
            "status": "failed",
            "productNo": "gd1",
            "code": "StockNotFound",
            "message": "指定された在庫が登録されていません"
        },
        {
            "status": "failed",
            "productNo": "gd2",
            "code": "NotManagementSettings",
            "message": "指定商品は、在庫管理を行わない設定になっています"
        },
        {
            "status": "success",
            "productNo": "gd3"
        }
    ]
}