コンテンツにスキップ

出庫登録

POST
/shipping

出庫を登録します。

対象プラン

  • リテールビジネス
object
receivingStoreId
required
入庫店舗ID

入庫店舗ID

string format: int
>= 1 <= 999999999
2
shippingStoreId
required
出庫店舗ID

出庫店舗ID

string format: int
>= 1 <= 999999999
1
receivingExpectedDateFrom
required
入庫予定日From

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

string format: date
2025-01-01
receivingExpectedDateTo
required
入庫予定日To

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

string format: date
2025-01-02
shippingDate
required
出庫日

出庫日:[YYYY-MM-DD]

string format: date
2025-01-01
staffId
スタッフID

スタッフID

string format: int
>= 1 <= 999999999
1
memo
メモ

メモ

string
<= 1000 characters
出庫メモ
identificationNo
識別番号

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

string
<= 32 characters
123456789
status
required
状態

状態:出庫/入庫の状況を設定。 0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了 ※0:未出庫、1:未入庫のみ指定可能

string
Allowed values: 0 1
1
approvalStatus
承認ステータス

承認ステータス:0:未承認、1:承認済、2:承認拒否、3:依頼未承認 未設定の場合、在庫管理設定の「承認機能」を利用しない場合、1承認済が設定されます。利用する場合、0:未承認が設定されます。

string
0
Allowed values: 0 1 2
1
details
required
出庫明細

出庫明細
※明細の最大件数は1000件です

Array<object>
object
productId
required
商品ID

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

string format: int
>= 1 <= 999999999999999
8000001
quantity
required
出庫数

出庫数:出庫した数量を設定。

string format: int
<= 99999
5
Example
{
"receivingStoreId": "2",
"shippingStoreId": "1",
"receivingExpectedDateFrom": "2025-01-01",
"receivingExpectedDateTo": "2025-01-02",
"shippingDate": "2025-01-01",
"staffId": "1",
"memo": "出庫メモ",
"identificationNo": "123456789",
"status": "1",
"approvalStatus": "1",
"details": [
{
"productId": "8000001",
"quantity": "5"
}
]
}

取得成功

object
shippingId

出庫ID:自動採番

string
2
receivingStoreId

入庫店舗ID

string
2
shippingStoreId

出庫店舗ID

string
1
receivingDesiredDate

入庫希望日:[YYYY-MM-DD]

string
nullable
receivingExpectedDateFrom

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

string
2025-01-01
receivingExpectedDateTo

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

string
2025-01-02
shippingDate

出庫日:[YYYY-MM-DD]

string
2025-01-01
staffId

スタッフID

string
1
requestStaffId

出庫依頼スタッフID:出庫依頼登録時のスタッフID

string
nullable
memo

メモ

string
出庫メモ
identificationNo

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

string
123456789
status

状態:出庫/入庫の状況を設定。 0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了 ※0:未出庫、1:未入庫のみ指定可能

string
1
approvalStatus

承認ステータス:0:未承認、1:承認済、2:承認拒否、3:依頼未承認 未設定の場合、在庫管理設定の「承認機能」を利用しない場合、1承認済が設定されます。利用する場合、0:未承認が設定されます。

string
1
approvalDateTime

承認日時:出荷承認日時/承認拒否日時 ※承認ステータス=1,2の場合、自動設定されます。

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

修正依頼ステータス:出庫情報の修正依頼ステータスを設定。 0:修正依頼なし、1:修正依頼あり、2:修正完了 0:修正依頼なしが自動設定されます

string
0
modificationRequestDateTime

修正依頼日時:修正依頼を行った日時を設定。

string
nullable
modificationRequestCheckedDateTime

修正依頼確認完了日時:修正依頼ステータスが修正完了になった日時を設定。

string
nullable
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
shippingDetailId

出庫明細ID

string
2
shippingId

出庫ID

string
2
productId

商品ID 同一出庫IDでの重複不可

string
8000001
requestQuantity

出庫依頼数:出庫依頼された数量を設定。

string
nullable
quantity

出庫数:出庫した数量を設定。

string
5
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
{
"shippingId": "2",
"receivingStoreId": "2",
"shippingStoreId": "1",
"receivingDesiredDate": null,
"receivingExpectedDateFrom": "2025-01-01",
"receivingExpectedDateTo": "2025-01-02",
"shippingDate": "2025-01-01",
"staffId": "1",
"requestStaffId": null,
"memo": "出庫メモ",
"identificationNo": "123456789",
"status": "1",
"approvalStatus": "1",
"approvalDateTime": "2025-01-01T00:00:00+09:00",
"modificationRequestStatus": "0",
"modificationRequestDateTime": null,
"modificationRequestCheckedDateTime": null,
"insDateTime": "2025-01-01T00:00:00+09:00",
"updDateTime": "2025-01-01T00:00:00+09:00",
"details": [
{
"shippingDetailId": "2",
"shippingId": "2",
"productId": "8000001",
"requestQuantity": null,
"quantity": "5",
"insDateTime": "2025-01-01T00:00:00+09:00",
"updDateTime": "2025-01-01T00:00:00+09:00"
}
]
}
  • 入庫店舗IDが存在しない場合
  • 出庫店舗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": "receivingStoreId:171 入庫店舗が存在しません",
"status": 400
}