出庫承認

PATCH

/shipping/{shipping_id}/approval

curl --request PATCH \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipping/7/approval \
  --header 'Content-Type: application/json' \
  --data '{ "receivingExpectedDateFrom": "2025-01-01", "receivingExpectedDateTo": "2025-01-02", "shippingDate": "2025-01-01", "memo": "出庫メモ", "approvalStatus": "1" }'

• サンドボックス
• 本番

出庫承認ステータスを更新します。

未承認となっている出庫情報／出庫依頼情報に対し、出庫を承認／拒否する場合に本APIを実行します。

承認済にすると、承認ステータスが承認済、ステータスが未入庫(出庫済)の状態に更新します。

承認拒否にすると、承認ステータスが承認拒否の状態に更新します。

対象プラン

• リテールビジネス

Authorizations

• AppAccessToken
  pos.transfers:write

Parameters

Path Parameters

shipping_id

required

string

出庫ID

Example

7

Request Body

Media typeapplication/json

object

receivingExpectedDateFrom

入庫予定日From

入庫予定日From：[YYYY-MM-DD]
出庫情報の承認ステータスが3:依頼未承認時に必須

string format: date

receivingExpectedDateTo

入庫予定日To

入庫予定日To：[YYYY-MM-DD]
出庫情報の承認ステータスが3:依頼未承認時に必須

string format: date

shippingDate

出庫日

出庫日：[YYYY-MM-DD]
出庫情報の承認ステータスが3:依頼未承認時に必須

string format: date

memo

メモ

メモ

string

<= 1000 characters

approvalStatus

required

承認ステータス

承認ステータス：0:未承認、1:承認済、2:承認拒否、3:依頼未承認
3:依頼未承認 → 0:未承認、1:承認済に変更可
0:未承認 → 1:承認済、2:承認拒否に変更可
2:承認拒否 → 0:未承認に変更可

string

0

Allowed values: 0 1 2

Example

{
  "receivingExpectedDateFrom": "2025-01-01",
  "receivingExpectedDateTo": "2025-01-02",
  "shippingDate": "2025-01-01",
  "memo": "出庫メモ",
  "approvalStatus": "1"
}

Responses

200

取得成功

Media typeapplication/json

object

shippingId

出庫ID

string

receivingStoreId

入庫店舗ID

string

shippingStoreId

出庫店舗ID

string

receivingDesiredDate

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

string

nullable

receivingExpectedDateFrom

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

string

receivingExpectedDateTo

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

string

shippingDate

出庫日：[YYYY-MM-DD]

string

staffId

スタッフID

string

requestStaffId

出庫依頼スタッフID

string

nullable

memo

メモ

string

identificationNo

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

string

status

状態：出庫/入庫の状況を設定。
0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了
出庫承認時に1:未入庫に自動更新される

string

approvalStatus

承認ステータス：0:未承認、1:承認済、2:承認拒否、3:依頼未承認
3:依頼未承認 → 0:未承認、1:承認済、2:承認拒否に変更可
0:未承認 → 1:承認済、2:承認拒否に変更可
2:承認拒否 → 0:未承認に変更可

string

approvalDateTime

承認日時：出荷承認日時／承認拒否日時 出庫承認時に自動更新される

string

modificationRequestStatus

修正依頼ステータス：出庫情報の修正依頼ステータスを設定。 0:修正依頼なし、1:修正依頼あり、2:修正完了

string

modificationRequestDateTime

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

string

nullable

modificationRequestCheckedDateTime

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

string

nullable

insDateTime

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

string

updDateTime

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

string

Example

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

400

• 承認ステータスが1:承認済の場合
• 承認ステータスが2:承認拒否のものを1:承認済に変更しようとした場合
• 出庫の承認設定を利用しない設定で1:承認済以外を設定した場合
• 承認ステータスが3:依頼未承認のデータを0:未承認または 1:承認済以外に更新しようとした場合
• 承認ステータスが3:依頼未承認のデータを0:未承認または 1:承認済に更新する際に出庫予定日Fromが未設定の場合
• 承認ステータスが3:依頼未承認のデータを0:未承認または 1:承認済に更新する際に出庫予定日Toが未設定の場合
• 承認ステータスが3:依頼未承認のデータを0:未承認または 1:承認済に更新する際に出庫日が未設定の場合

Media typeapplication/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "未出庫のデータのみ承認状態を変更できます",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "承認拒否のデータは承認済に更新できません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "出庫の承認設定を利用しない場合、1:承認済のみ設定できます",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "依頼未承認のデータは0:未承認または1:承認済以外への更新はできません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "出庫依頼承認時には出庫予定日Fromが必須です",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "出庫依頼承認時には出庫予定日Toが必須です",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "出庫依頼承認時には出庫日が必須です",
  "status": 400
}

404

• リソースがない場合

Media typeapplication/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

Exampleリソースが存在しない場合

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