在庫更新API

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

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

ご注意事項

予約在庫、予定在庫の更新について

管理画面にて商品情報(予約)商品情報(予定在庫)、もしくはCSV一括登録(予約在庫予定在庫)にて在庫数を登録済みの商品のみ更新可能です。

※なお、予定在庫については、入荷予定日の登録が必須です。(CSV一括登録は予定在庫設定登録

基本仕様

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

<目次>

URL

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

HTTPメソッド

POST

リクエストヘッダー

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

リクエストボディ(json)

key 項目名 必須 byte 内容
productList 商品リスト Array - 商品ごとに配列。最大100件
productNo 商品番号 String 32
inventoryInfo 在庫情報 - -
regular 通常在庫リスト - - 通常在庫を更新する際に設定
inventoryList 在庫リスト Array - SKUごとに配列
verticalNo 枝番(縦軸) String 9
horizontalNo 枝番(横軸) String 9
count 在庫数 Number
String
9 Number:指定数更新時に使用
String:指定数更新、加減算更新時に使用”+1”、 ”-1”
preorder 予約在庫リスト - - 予約在庫を更新する際に設定
※注意事項
inventoryList 在庫リスト Array - SKUごとに配列
verticalNo 枝番(縦軸) String 9
horizontalNo 枝番(横軸) String 9
count 在庫数 Number
String
9 Number:指定数更新時に使用
String:指定数更新、加減算更新時に使用”+1”、 ”-1”
plannedList 予定在庫リスト Array - 予定在庫を更新する際に設定
※注意事項
date 予定日 String 10 「yyyy-mm-dd」形式
inventoryList 在庫リスト Array - SKUごとに配列
verticalNo 枝番(縦軸) String 9
horizontalNo 枝番(横軸) String 9
count 在庫数 Number
String
9 Number:指定数更新時に使用
String:指定数更新、加減算更新時に使用”+1”、 ”-1”
サンプル(リクエストボディ)
{
    "productList": [
        {
            "productNo": "gd1",
            "inventoryInfo": {
                "regular": {
                    "inventoryList": [
                        {
                            "verticalNo": "01",
                            "horizontalNo": "",
                            "count": 9
                        }
                    ]
                },
                "preorder": {
                    "inventoryList": [
                        {
                            "verticalNo": "01",
                            "horizontalNo": "",
                            "count": "+10"
                        }
                    ]
                },
                "plannedList": [
                    {
                        "date": "2030-10-24",
                        "inventoryList": [
                            {
                                "verticalNo": "02",
                                "horizontalNo": "",
                                "janCode": "",
                                "count": "-10"
                            }
                        ]
                    }
                ]
            }
        }
    ]
}

レスポンス

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

コード メッセージ 説明
TooMany productListの指定は100件までです 商品リストの数が100件を超過した場合に返却されます。
TooLong verticalNoは100文字以内で指定してください verticalNoが長過ぎます。100文字以下で指定して下さい。
TooLong horizontalNoは100文字以内で指定してください horizontalNoが長過ぎます。100文字以下で指定して下さい。
InvalidFormat countの形式に誤りがあります 数値が正しく指定されてない場合に返却されます。
TooLong countは9桁以内で指定してください countが9桁以上の場合に返却されます。
WrongDateFormat dateの日付フォーマットを正しく指定してください 「yyyy-mm-dd」の形式で指定して下さい。
Required productNoを指定してください 商品番号が指定されていない場合に返却されます。
DuplicatedProductNo productNoが重複しています productList内に同じ商品番号が存在する場合に返却されます。
DuplicatedPlannedDate dateが重複しています plannedList内に同じ日付が存在する場合に返却されます。
DuplicatedStock 在庫指定が重複しています 在庫数更新情報に同じ商品が存在する場合に返却されます。
ProductNotFound 指定された商品が登録されていません 更新対象の商品データが存在しない場合に返却されます。
NotManagementSettings 指定商品は、在庫管理を行わない設定になっています 在庫管理を行う設定の商品のみ更新が可能となります。
OverStock 在庫数が999,999,999を越える為、登録できません 更新後999,999,999以上の数値となる場合に返却されます。
StockNotFound 指定された在庫が登録されていません 指定した在庫情報が存在しない場合に返却されます。
PlannedStockDateNotFound 指定された入荷予定日が登録されていません 指定した予定在庫情報が存在しない場合に返却されます。

サンプル

サンプル(エラー時)

{
  "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"
        }
    ]
}