コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

在庫一括相対値更新

POST
/stock/add/bulk

在庫情報を一括更新します。

在庫数は、現在の値に対し、入力された値を加算（入力値が負の場合は減算）した値に更新します。

※ 在庫の更新処理は非同期で実行されます。処理完了後、指定されたコールバックURLにWebhook通知されます。

※ 在庫は1リクエストにつき100件（店舗）まで登録できます。

対象プラン

  • スタンダード
  • プレミアム
  • プレミアムプラス
  • フードビジネス
  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
stock
required
在庫情報
Array<object>
object
productId
required
商品ID

商品ID
※ ユーザーアクセストークンを利用する場合でも、ユーザーの所属する店舗で販売しているかに関わらず商品IDを指定できます。

string format: int
storeId
required
店舗ID

店舗ID
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗IDを指定してください。

string format: int
<= 999999999
stockAmount
required
在庫数

現在の在庫数に対して加算する在庫数
※ 負数が設定された場合は減算します。0は指定できません。

string format: int
>= -1999999998 <= 1999999998
stockHistory
在庫変動履歴
object
memo
メモ

在庫変動履歴に設定するメモ

string
<= 100 characters
callbackUrl
required
処理完了通知URL

処理が完了した際にその結果をWebhook通知するURL

string format: string
<= 511 characters /^https?://\S+$/
Example
{
  "stock": [
    {
      "productId": "1",
      "storeId": "123456789",
      "stockAmount": "1234567890",
      "stockHistory": {
        "memo": "string"
      }
    }
  ],
  "callbackUrl": "string"
}

Responses

Section titled “ Responses ”

202

Section titled “202 ”

処理受付完了

object
requestId

問い合わせ用ID：弊社への問い合わせの際にご利用ください

integer
callbackUrl

処理完了通知URL：処理が完了した際にその結果をWebhook通知するURL

Webhook通知について ■ Request Header:
key value
Content-Type application/json;charset=UTF-8
■ Request Body (更新成功): Array of Objects
key value
requestId レスポンス時に返却したリクエストID (Integer)
処理結果（Array） id 在庫変動履歴ID：数字12桁以内（String）
productId 商品ID：数字15桁以内（String）
storeId 店舗ID：数字15桁以内（String）
リクエスト例
  
  Content-Type: application/json;charset=UTF-8

  {

   "requestId":700,

   "result":[

    {

     "id":"1234"

     "productId":"567"

     "storeId":"8"

    },

    {

     "id":"1235"

     "productId":"678"

     "storeId":"9"

    }

   ]

  }

■ Request Body (更新失敗):
key value
requestId レスポンス時に返却したリクエストID (Integer)
message エラーメッセージ (String)
リクエスト例
    
    Content-Type: application/json;charset=UTF-8

    {

     "requestId":700,

     "message":"[stock][2行目]更新後の在庫数は[-999999999]以上[999999999]以下である必要があります。"

    }

■ 更新失敗時のエラーメッセージの詳細:
※ Webhook通知では、既存データを参照した上での結果を返します
※「 [ 大項目 ] [ 何番目のオブジェクトで発生したか ] エラーメッセージ 」の形式で返されます
※「大項目」は下記のリクエストボディの項目と対応します
stock 在庫項目
※「何番目のオブジェクトで発生したか」は「〇〇行目」と表現されます
※「エラーメッセージ」の一覧は下記です
ケースエラーメッセージ
存在しない商品IDを指定した場合商品IDが存在しません。
存在しない店舗IDを指定した場合店舗IDが存在しません。
計算後の在庫数が-999999999〜999999999の範囲内にない場合更新後の在庫数は[-999999999]以上[999999999]以下である必要があります。
string
Example
{
  "requestId": 700,
  "callbackUrl": "string"
}

400

Section titled “400 ”
  • 商品IDと店舗IDの組み合わせがリクエスト内で重複している場合
  • 在庫数に0が指定された場合
  • リクエスト上限数が超えている場合
  • 在庫情報が1件も送られてこなかった場合
  • リクエスト内の全ての在庫情報で指定しているフィールドが揃っていない場合
  • リクエスト内の全ての在庫変動履歴で指定しているフィールドが揃っていない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "指定された商品IDと店舗IDの組み合わせが重複しています。(商品ID:店舗ID-{商品ID}:{店舗ID})",
  "status": 400
}