入庫更新

PATCH

/receiving/{receiving_id}

• サンドボックス
• 本番

入庫を更新します。

※入庫情報は出庫情報を登録後、status=1:未入庫 に設定されたときに自動生成されます。

※入庫明細を本APIで新規追加した場合、status=1:検品中 のままとなり、検品完了しません。スマレジ管理画面上で出庫修正依頼を実施して下さい。

対象プラン

• リテールビジネス

Authorizations

• AppAccessToken
  pos.transfers:write

Parameters

Path Parameters

receiving_id

required

string

入庫ID

Example

3

Request Body

object

receivingDate

required

入庫日

入庫日：[YYYY-MM-DD]

string format: date

2025-01-01

memo

メモ

メモ:（出庫情報のメモと共有される）

string

<= 1000 characters

入庫メモ

staffId

スタッフID

スタッフID

string format: int

>= 1 <= 999999999999999

2

details

入庫明細

入庫明細
※明細は既存件数と追加件数の合計が1000件以下になるようにしてください

Array<object>

object

receivingDetailId

入庫明細ID

入庫明細ID
更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）

string format: int

>= 1 <= 999999999

3

productId

商品ID

商品ID
同一入庫IDでの重複不可。
追加登録する場合、必須

string format: int

>= 1 <= 999999999999999

8000001

inspectionQuantity

required

検品数

検品数

string format: int

<= 99999

2

stockoutQuantity

required

欠品数

欠品数

string format: int

<= 99999

3

stockoutReason

欠品理由

欠品理由

string

<= 255 characters

欠品理由

inspectionDate

required

検品日

検品日：[YYYY-MM-DD]

string format: date

2025-01-01

Example

{
  "receivingDate": "2025-01-01",
  "memo": "入庫メモ",
  "staffId": "2",
  "details": [
    {
      "receivingDetailId": "3",
      "productId": "8000001",
      "inspectionQuantity": "2",
      "stockoutQuantity": "3",
      "stockoutReason": "欠品理由",
      "inspectionDate": "2025-01-01"
    }
  ]
}

Responses

200

取得成功

object

receivingId

入庫ID(出庫登録、更新時に自動登録される)

string

3

shippingId

出庫ID

string

3

receivingStoreId

入庫店舗ID

string

2

shippingStoreId

出庫店舗ID

string

1

receivingExpectedDateFrom

入庫予定日From：[YYYY-MM-DD]

string

2025-01-01

receivingExpectedDateTo

入庫予定日To：[YYYY-MM-DD]

string

2025-01-02

receivingDate

入庫日：[YYYY-MM-DD]

string

2025-01-01

memo

メモ:（出庫情報のメモと共有される）

string

入庫メモ

staffId

スタッフID

string

2

identificationNo

入庫情報を管理するための任意の文字列を設定出来る項目。
出庫情報側の識別番号が自動入力される

string

123456789

status

入庫ステータス：
0:未入庫、1:検品中、2:入庫完了
入庫明細の検品結果を元に自動入力される

string

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:01:00+09:00

details

入庫明細

Array<object>

object

receivingDetailId

入庫明細ID
更新の場合は指定、新規追加の場合は設定しないこと（自動採番されます。）

string

3

receivingId

入庫ID

string

3

productId

商品ID
同一入庫IDでの重複不可。
追加登録する場合、必須

string

8000001

scheduledQuantity

予定数：出庫時に確定する値のため更新不可

string

5

inspectionQuantity

検品数

string

2

stockoutQuantity

欠品数

string

3

stockoutReason

欠品理由

string

欠品理由

inspectionDate

検品日：[YYYY-MM-DD]

string

2025-01-01

status

ステータス：自動設定。
0:未検品、1:検品完了

string

1

insDateTime

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

string

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

updDateTime

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

string

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

Example

{
  "receivingId": "3",
  "shippingId": "3",
  "receivingStoreId": "2",
  "shippingStoreId": "1",
  "receivingExpectedDateFrom": "2025-01-01",
  "receivingExpectedDateTo": "2025-01-02",
  "receivingDate": "2025-01-01",
  "memo": "入庫メモ",
  "staffId": "2",
  "identificationNo": "123456789",
  "status": "2",
  "insDateTime": "2025-01-01T00:00:00+09:00",
  "updDateTime": "2025-01-01T00:01:00+09:00",
  "details": [
    {
      "receivingDetailId": "3",
      "receivingId": "3",
      "productId": "8000001",
      "scheduledQuantity": "5",
      "inspectionQuantity": "2",
      "stockoutQuantity": "3",
      "stockoutReason": "欠品理由",
      "inspectionDate": "2025-01-01",
      "status": "1",
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:01:00+09:00"
    }
  ]
}

400

• スタッフIDが存在しない場合
• 入庫明細IDが存在しない場合
• 商品IDが重複している場合
• 商品IDが存在しない場合
• 登録済みの入庫明細の商品IDを変更しようとした場合
• 入庫明細を追加登録時に商品IDが指定されていない場合
• 入庫完了後の編集可否が編集不可に設定されており、ステータスが入庫完了の入庫データを更新しようとした場合
• 入庫明細件数が1000件を超過した場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "staffId:171 スタッフが存在しません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "details: receivingDetailId-[1171] receivingDetailIdが見つかりません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "details: productId[171] 指定が重複しています",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "details: productId[171] の商品が見つかりません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "details: productId:[171] 登録済みの入庫明細レコードの商品IDは変更できません receivingDetailId-[1171]",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "details: [productId,receivingDetailId]いずれかの指定が必須です",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "在庫管理設定の入庫完了後の編集可否で編集不可が設定されているため、入庫完了の入庫データは更新できません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "details: 入庫明細は1000件以内にしてください",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "入庫情報が修正依頼中のため更新できません",
  "status": 400
}

404

• リソースがない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}

409

• 関連する出庫情報の修正依頼ステータスが1:修正依頼ありの場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "入庫情報が修正依頼中のため更新できません",
  "status": 409
}