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

入荷登録

POST
/storage

入荷を登録します。

対象プラン

  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
object
supplierId
required
仕入先ID

仕入先ID 仕入先IDを設定

string format: int
>= 1 <= 9999999999 
2
storageStoreId
required
入荷店舗ID

入荷店舗ID

string format: int
>= 1 <= 999999999 
1
storageExpectedDateFrom
入荷予定日From

入荷予定日From [YYYY-MM-DD]

string format: date 
2025-01-01
storageExpectedDateTo
入荷予定日To

入荷予定日To [YYYY-MM-DD]

string format: date 
2025-01-02
storageDate
required
入荷日

入荷日

string format: date 
2025-01-01
memo
メモ

メモ

string
<= 1000 characters 
入荷メモ
staffId
スタッフID

入荷登録時のスタッフID

string format: int
>= 1 <= 999999999 
1
identificationNo
識別番号

識別番号 入荷情報を管理するための任意の文字列を設定出来る項目。

string
<= 32 characters 
123456789
roundingDivision
税丸め

税丸め（0:四捨五入、1:切り捨て、2:切り上げ）
未設定の場合、1:切り捨てで設定する。

string
Allowed values: 0 1 2 
1
details
required
入荷明細

入荷明細
※明細の最大件数は1000件です

Array<object>
object
productId
商品ID

商品ID
※商品マスタが存在しない場合エラー
同一入荷IDでの重複不可

string format: int
>= 1 <= 999999999999999 
8000001
taxRate
税率

税率
小数点3桁まで
未設定の場合、入荷登録時の税率を設定する。

<= 100 
10.000
cost
原価(外税)

原価(外税) 未設定の場合、商品マスタの原価を自動で設定する。

string format: decimal
>= -9999999999.99999 <= 9999999999.99999 
100
scheduledQuantity
予定数

予定数

string format: int
<= 99999 
3
inspectionQuantity
検品数

検品数

string format: int
<= 99999 
2
stockoutQuantity
欠品数

欠品数

string format: int
<= 99999 
1
stockoutReason
欠品理由

欠品理由

string
<= 255 characters 
欠品理由
inspectionDate
検品日

検品日：[YYYY-MM-DD] 検品数、欠品数が非nullの場合は必須。

string format: date 
2025-01-01
numberMemo
数字メモ

数字メモ

string format: int
>= -999999999999 <= 999999999999 
123456789
dateMemo
日付メモ

日付メモ：[YYYY-MM-DD]

string format: date 
2025-01-01
compulsoryCompleteFlag
強制終了フラグ

強制終了フラグ（0:通常、1:強制終了）

string
Allowed values: 0 1 
0
Example
{
  "supplierId": "2",
  "storageStoreId": "1",
  "storageExpectedDateFrom": "2025-01-01",
  "storageExpectedDateTo": "2025-01-02",
  "storageDate": "2025-01-01",
  "memo": "入荷メモ",
  "staffId": "1",
  "identificationNo": "123456789",
  "roundingDivision": "1",
  "details": [
    {
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100",
      "scheduledQuantity": "3",
      "inspectionQuantity": "2",
      "stockoutQuantity": "1",
      "stockoutReason": "欠品理由",
      "inspectionDate": "2025-01-01",
      "numberMemo": "123456789",
      "dateMemo": "2025-01-01",
      "compulsoryCompleteFlag": "0"
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

object
storageId

入荷ID 自動採番

string
2
storageInfoId

発注ID：発注登録から作成された入荷の場合のみ、発注IDを設定。

string
nullable
supplierId

仕入先ID 仕入先IDを設定

string
2
storageStoreId

入荷店舗ID

string
1
storageExpectedDateFrom

入荷予定日From [YYYY-MM-DD]

string
2025-01-01
storageExpectedDateTo

入荷予定日To [YYYY-MM-DD]

string
2025-01-02
storageDate

入荷日

string
2025-01-01
memo

メモ

string
入荷メモ
staffId

入荷登録時のスタッフID

string
1
identificationNo

識別番号 入荷情報を管理するための任意の文字列を設定出来る項目。

string
123456789
roundingDivision

税丸め（0:四捨五入、1:切り捨て、2:切り上げ）

string
Allowed values: 0 1 2 
1
status

入荷ステータス(0:未入荷、1:検品中、2:入荷完了)【自動設定】

string
Allowed values: 0 1 2 
2
insDateTime

登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
2025-01-01T00:00:00+09:00
updDateTime

登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
2025-01-01T00:00:00+09:00
details

入荷明細

Array<object>
object
storageDetailId

入荷明細ID 自動採番

string
2
storageId

入荷ID 自動採番

string
2
storageInfoId

発注ID：発注登録から作成された入荷の場合のみ、発注IDを設定。

string
nullable
productId

商品ID 同一入荷ID内でユニーク

string
8000001
taxRate

税率

string
10.000
cost

原価(外税) 未設定の場合、商品マスタの原価を自動で設定する。

string
100.00000
scheduledQuantity

予定数

string
3
inspectionQuantity

検品数

string
2
stockoutQuantity

欠品数

string
1
stockoutReason

欠品理由

string
欠品理由
inspectionDate

検品日：[YYYY-MM-DD] 検品数、欠品数が非nullの場合は必須。

string
2025-01-01
numberMemo

数字メモ

string
123456789
dateMemo

日付メモ：[YYYY-MM-DD]

string
2025-01-01
status

ステータス（0:未検品、1:検品完了）【自動設定】

string
Allowed values: 0 1 
1
compulsoryCompleteFlag

強制終了フラグ（0:通常、1:強制終了）

string
Allowed values: 0 1 
0
insDateTime

作成日時：登録時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
2025-01-01T00:00:00+09:00
updDateTime

更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

string
2025-01-01T00:00:00+09:00
Example
{
  "storageId": "2",
  "storageInfoId": null,
  "supplierId": "2",
  "storageStoreId": "1",
  "storageExpectedDateFrom": "2025-01-01",
  "storageExpectedDateTo": "2025-01-02",
  "storageDate": "2025-01-01",
  "memo": "入荷メモ",
  "staffId": "1",
  "identificationNo": "123456789",
  "roundingDivision": "1",
  "status": "2",
  "insDateTime": "2025-01-01T00:00:00+09:00",
  "updDateTime": "2025-01-01T00:00:00+09:00",
  "details": [
    {
      "storageDetailId": "2",
      "storageId": "2",
      "storageInfoId": null,
      "productId": "8000001",
      "taxRate": "10.000",
      "cost": "100.00000",
      "scheduledQuantity": "3",
      "inspectionQuantity": "2",
      "stockoutQuantity": "1",
      "stockoutReason": "欠品理由",
      "inspectionDate": "2025-01-01",
      "numberMemo": "123456789",
      "dateMemo": "2025-01-01",
      "status": "1",
      "compulsoryCompleteFlag": "0",
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:00:00+09:00"
    }
  ]
}

400

Section titled “400 ”
  • 仕入先IDが存在しない場合
  • 店舗IDが存在しない場合
  • 商品IDが存在しない場合
  • スタッフIDが存在しない場合
  • 同一発注IDの範囲で商品IDがユニークでない場合(products)
  • 入荷予定日To < 入荷予定日Fromの場合
  • 入荷明細がない場合
  • 入荷明細件数が1000件を超過した場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "supplierId:171 仕入先が存在しません",
  "status": 400
}