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

修正依頼中出庫取得

GET
/shipping_modification_requests/{shipping_id}

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

対象プラン

  • リテールビジネス

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
shipping_id
required
string

出庫ID

Example
10

Query Parameters

Section titled “Query Parameters ”
fields
array

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

Example
shippingId,receivingStoreId
with_details
string
default: none
Allowed values: all none

明細取得フラグ：出庫明細を付加するか(付加する場合はall, しない場合はnone)

Example
all
with_receiving
string
default: none
Allowed values: all none

入庫取得フラグ：入庫情報を付加するか(付加する場合はall, しない場合はnone)

Example
all

Responses

Section titled “ Responses ”

200

Section titled “200 ”

取得成功

object
shippingId

出庫ID

string
10
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:02: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:02:00+09:00
details

出庫明細

Array<object>
>= 1 items <= 1000 items
object
shippingDetailId

出庫明細ID

string
10
shippingId

出庫ID

string
10
productId

商品ID

string
8000001
requestQuantity

出庫依頼数：出庫依頼された数量を設定。0〜99999の整数。

string
nullable
quantity

出庫数：出庫した数量を設定。0〜99999の整数。

string
1
rfidTags

RFIDタグリスト

Array<string>
[
  "RFID001"
]
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:00:00+09:00
receiving

入庫情報

object
receivingId

入庫ID

string
10
details

入庫明細

Array<object>
>= 1 items <= 1000 items
object
receivingDetailId

入庫明細ID：自動採番

string
10
receivingId

入庫ID：自動採番

string
10
productId

商品ID：同一入庫ID内でユニーク

string
8000001
scheduledQuantity

予定数：0〜99999の整数。

string
1
inspectionQuantity

検品数：0〜99999の整数。

string
2
stockoutQuantity

欠品数：0〜99999の整数。

string
0
stockoutReason

欠品理由

string
nullable <= 255 characters 
欠品理由
inspectionDate

検品日：[YYYY-MM-DD]
検品数、欠品数が非nullの場合は必須。

string format: date 
2025-01-01
rfidTags

RFIDタグリスト。入庫検品分。

Array<string>
[
  "RFID001",
  "RFID002"
]
status

ステータス：(0:未検品、1:検品完了)【自動設定】

string
0
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": "10",
  "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:02:00+09:00",
  "modificationRequestCheckedDateTime": null,
  "insDateTime": "2025-01-01T00:00:00+09:00",
  "updDateTime": "2025-01-01T00:02:00+09:00",
  "details": [
    {
      "shippingDetailId": "10",
      "shippingId": "10",
      "productId": "8000001",
      "requestQuantity": null,
      "quantity": "1",
      "rfidTags": [
        "RFID001"
      ],
      "insDateTime": "2025-01-01T00:00:00+09:00",
      "updDateTime": "2025-01-01T00:00:00+09:00"
    }
  ],
  "receiving": {
    "receivingId": "10",
    "details": [
      {
        "receivingDetailId": "10",
        "receivingId": "10",
        "productId": "8000001",
        "scheduledQuantity": "1",
        "inspectionQuantity": "2",
        "stockoutQuantity": "0",
        "stockoutReason": "欠品理由",
        "inspectionDate": "2025-01-01",
        "rfidTags": [
          "RFID001",
          "RFID002"
        ],
        "status": "0",
        "insDateTime": "2025-01-01T00:00:00+09:00",
        "updDateTime": "2025-01-01T00:01:00+09:00"
      }
    ]
  }
}

404

Section titled “404 ”
  • リソースがない場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{
  "type": "about:blank",
  "title": "NotFound",
  "detail": "指定されたIDのリソースが見つかりません",
  "status": 404
}