出庫更新

PATCH

/shipping/{shipping_id}

const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipping/6';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"receivingExpectedDateFrom":"2025-01-01","receivingExpectedDateTo":"2025-01-02","shippingDate":"2025-01-01","staffId":"1","memo":"出庫メモ","identificationNo":"123456789","status":"1","details":[{"shippingDetailId":"6","productId":"8000001","quantity":"5"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipping/6 \
  --header 'Content-Type: application/json' \
  --data '{ "receivingExpectedDateFrom": "2025-01-01", "receivingExpectedDateTo": "2025-01-02", "shippingDate": "2025-01-01", "staffId": "1", "memo": "出庫メモ", "identificationNo": "123456789", "status": "1", "details": [ { "shippingDetailId": "6", "productId": "8000001", "quantity": "5" } ] }'

出庫を更新します。

承認ステータスの更新については出庫承認APIを実行して下さい。

対象プラン

リテールビジネス

Authorizations

AppAccessToken
pos.transfers:write

Parameters

Path Parameters

shipping_id

required

string

出庫ID

Example

Request Body

application/json

object

receivingExpectedDateFrom

入庫予定日From

入庫予定日From：[YYYY-MM-DD] ※statusが未入庫の場合に必須

string format: date

receivingExpectedDateTo

入庫予定日To

入庫予定日To：[YYYY-MM-DD] ※statusが未入庫の場合に必須

string format: date

shippingDate

出庫日

出庫日：[YYYY-MM-DD] ※statusが未入庫の場合に必須

string format: date

staffId

スタッフID

スタッフID

string format: int

>= 1 <= 999999999

memo

メモ

string

<= 1000 characters

identificationNo

識別番号

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

string

<= 32 characters

status

状態

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

0: 未出庫
1: 未入庫
2: 入庫検品中
3: 入庫完了（指定不可）

状態の遷移には以下の制約があります。

0:未出庫 から 1:未入庫 への変更不可
1:未入庫 から 0:未出庫 への変更不可
2:入庫検品中 以外から 2:入庫検品中 への変更不可
2:入庫検品中 から 2:入庫検品中以外 への変更不可
2:入庫検品中 かつ出庫依頼ステータスが 1:修正依頼あり 以外の場合、変更不可
3:入庫完了 の場合、変更不可

※statusの更新が不可能なため、status項目の廃止を予定しています。 0:未出庫 から 1:未入庫 への変更を行う際は、出庫承認APIをご使用ください。

string

Allowed values: 0 1 2

details

出庫明細

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

Array<object>

object

shippingDetailId

出庫明細ID

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

string format: int

>= 1 <= 999999999

productId

商品ID

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

string format: int

>= 1 <= 999999999999999

quantity

出庫数

出庫数：出庫した数量を設定。
追加登録する場合、必須

string format: int

<= 99999

Example

{
  "receivingExpectedDateFrom": "2025-01-01",
  "receivingExpectedDateTo": "2025-01-02",
  "shippingDate": "2025-01-01",
  "staffId": "1",
  "memo": "出庫メモ",
  "identificationNo": "123456789",
  "status": "1",
  "details": [
    {
      "shippingDetailId": "6",
      "productId": "8000001",
      "quantity": "5"
    }
  ]
}

Responses

200

取得成功

application/json

object

shippingId

出庫ID

string

receivingStoreId

入庫店舗ID

string

shippingStoreId

出庫店舗ID

string

receivingDesiredDate

入庫希望日：[YYYY-MM-DD] ※statusが未出庫の場合に必須

string

nullable

receivingExpectedDateFrom

入庫予定日From：[YYYY-MM-DD] ※statusが未入庫の場合に必須

string

receivingExpectedDateTo

入庫予定日To：[YYYY-MM-DD] ※statusが未入庫の場合に必須

string

shippingDate

出庫日：[YYYY-MM-DD] ※statusが未入庫の場合に必須

string

staffId

スタッフID

string

requestStaffId

出庫依頼スタッフID

string

nullable

memo

メモ

string

identificationNo

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

string

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

承認日時：出荷承認日時／承認拒否日時

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

details

出庫明細

Array<object>

object

shippingDetailId

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

string

shippingId

出庫ID

string

productId

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

string

requestQuantity

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

string

nullable

quantity

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

string

insDateTime

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

string

updDateTime

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

string

Example

{
  "shippingId": "6",
  "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:01:00+09:00",
  "details": [
    {
      "shippingDetailId": "6",
      "shippingId": "6",
      "productId": "8000001",
      "requestQuantity": null,
      "quantity": "5",
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:01:00+09:00"
    }
  ]
}

400

商品IDが重複している場合
商品IDが存在しない場合
スタッフIDが存在しない場合
出庫明細IDが存在しない場合
状態を0:未出庫から1:未入庫に変更しようとした場合
状態を1:未入庫から0:未出庫に変更しようとした場合
承認状態が2:承認拒否の場合
出庫明細件数が1000件を超過した場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "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": "staffId:171 スタッフが存在しません",
  "status": 400
}

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

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "状態を1:未入庫に変更できません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "状態を0:未出庫に変更できません",
  "status": 400
}

{
  "type": "about:blank",
  "title": "Bad Request",
  "detail": "承認状態が2:承認拒否の場合変更できません",
  "status": 400
}

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

404

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

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

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

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

409

状態が2:入庫検品中以外から2:入庫検品中へ変更しようとした場合
状態が2:入庫検品中から他の状態へ変更しようとした場合
状態が2:入庫検品中かつ修正依頼ステータスが1:修正依頼あり以外の場合
状態が3:入庫完了の場合

application/json

object

type

required

string

title

required

string

detail

string

status

integer

Examples

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "状態が2:入庫検品中以外から2:入庫検品中へは変更できません",
  "status": 409
}

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "状態が2:入庫検品中の場合、他の状態へ変更できません",
  "status": 409
}

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "状態が2:入庫検品中の場合、修正依頼ステータスが1:修正依頼あり以外は変更できません",
  "status": 409
}

{
  "type": "about:blank",
  "title": "Conflict",
  "detail": "状態が3:入庫完了の場合変更できません",
  "status": 409
}