出庫修正依頼

POST

/shipping/{shipping_id}/modification_request

サンドボックス
本番

出庫修正依頼を行います。

入庫検品中となっている出庫情報に対し、出庫の修正依頼をする際に本APIを実行します。

修正依頼ステータスが 1:修正依頼ありに更新され、出庫更新APIで出庫情報を更新できますが、入庫更新APIでの更新ができなくなります。

出庫修正依頼完了APIを実行すると、修正依頼ステータスが 2:修正完了に更新され、修正依頼中の出庫更新内容が入庫情報に反映された後、入庫更新が可能になります。

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.transfers:write

Parameters

Path Parameters

shipping_id

required

string

出庫ID

Example

Request Body

object

memo

メモ

入出庫メモを入力してください。パラメータがある場合は入出庫のメモは指定されたパラメータで更新されます

string

<= 1000 characters

修正依頼メモ

Example

{
  "memo": "修正依頼メモ"
}

Responses

200

取得成功

object

shippingId

出庫ID

string

receivingStoreId

入庫店舗ID

string

shippingStoreId

出庫店舗ID

string

receivingDesiredDate

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

string format: date

nullable

receivingExpectedDateFrom

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

string format: date

2025-01-01

receivingExpectedDateTo

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

string format: date

2025-01-02

shippingDate

出庫日：[YYYY-MM-DD]

string format: date

2025-01-01

staffId

スタッフID

string

requestStaffId

出庫依頼スタッフID

string

nullable

memo

メモ

string

<= 1000 characters

修正依頼メモ

identificationNo

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

string

<= 32 characters

123456789

status

状態：出庫/入庫の状況を設定。

0: 未出庫
1: 未入庫
2: 入庫検品中
3: 入庫完了

string

Allowed values: 0 1 2 3

approvalStatus

承認ステータス

0: 未承認
1: 承認済
2: 承認拒否
3: 依頼未承認

string

Allowed values: 0 1 2 3

approvalDateTime

承認日時：出荷承認日時／承認拒否日時。未設定の場合null

string format: date-time

nullable

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

modificationRequestStatus

修正依頼ステータス：出庫情報の修正依頼ステータスを設定。

0: 修正依頼なし
1: 修正依頼あり
2: 修正完了

string

Allowed values: 0 1 2

modificationRequestDateTime

修正依頼日時：修正依頼を行った日時を設定。未設定の場合null

string format: date-time

nullable

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

modificationRequestCheckedDateTime

修正依頼確認完了日時：修正依頼ステータスが修正完了になった日時を設定。未設定の場合null

string format: date-time

nullable

insDateTime

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

string format: date-time

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

updDateTime

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

string format: date-time

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

Example

{
  "shippingId": "8",
  "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": "2",
  "approvalStatus": "1",
  "approvalDateTime": "2025-01-01T00:00:00+09:00",
  "modificationRequestStatus": "1",
  "modificationRequestDateTime": "2025-01-01T00:01:00+09:00",
  "modificationRequestCheckedDateTime": null,
  "insDateTime": "2025-01-01T00:00:00+09:00",
  "updDateTime": "2025-01-01T00:01:00+09:00"
}

404

リソースがない場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

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

409

出庫の修正依頼ステータスが 1:修正依頼ありの場合
入庫の状態が 1:検品中以外の場合

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "既に修正依頼中です",
  "status": 409
}

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "入庫が検品中以外の場合は修正依頼できません",
  "status": 409
}