コンテンツにスキップ
スマレジ・プラットフォームAPI 仕様書

修正依頼中出庫一覧取得

GET
/shipping_modification_requests

修正依頼中の出庫情報一覧を取得します。

対象プラン

  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
fields
array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

Example
shippingId,receivingStoreId
sort
string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

  • shippingId：出庫ID
  • shippingStoreId：出庫店舗ID
  • receivingStoreId：入庫店舗ID
  • receivingDesiredDate：出庫希望日：[YYYY-MM-DD]
  • receivingExpectedDateFrom：入庫予定日From：[YYYY-MM-DD]
  • receivingExpectedDateTo：入庫予定日To：[YYYY-MM-DD]
  • shippingDate：出庫日：[YYYY-MM-DD]
  • updDateTime：更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
Example
shippingId
limit
integer

上限数

Example
10
page
integer

ページ

Example
2
receiving_store_id
string

入庫店舗ID

Example
2
shipping_store_id
string

出庫店舗ID

Example
1
identification_no
string

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

Example
123456789
modification_request_date
string format: date

修正依頼日：[YYYY-MM-DD]

Example
2025-01-01

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

Array<object>
object
shippingId

出庫ID

string
9
receivingStoreId

入庫店舗ID

string
2
shippingStoreId

出庫店舗ID

string
1
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
1
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 
2
approvalStatus

承認ステータス

  • 0: 未承認
  • 1: 承認済
  • 2: 承認拒否
  • 3: 依頼未承認
string
Allowed values: 0 1 2 3 
1
approvalDateTime

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

string format: date-time
nullable 
2025-01-01T00:00:00+09:00
modificationRequestStatus

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

  • 0: 修正依頼なし
  • 1: 修正依頼あり
  • 2: 修正完了
string
Allowed values: 0 1 2 
1
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": "9",
    "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"
  }
]