出荷明細取得

GET

/shipments/{shipment_id}/details

• サンドボックス
• 本番

出荷明細情報を取得します。

対象プラン

• リテールビジネス

Authorizations

• AppAccessToken
  pos.orders:read

Parameters

Path Parameters

shipment_id

required

string

出荷ID

Example

5

Query Parameters

fields

array

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

Example

shipmentDetailId,productId

sort

string

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

指定可能なパラメータ

• shipmentDetailId：出荷明細ID：
• productId：商品ID
• updDateTime：更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

Example

productId

limit

integer

上限数

Example

10

page

integer

ページ

Example

2

product_id

string

商品ID

Example

8000001

Responses

200

取得成功

Array<object>

object

shipmentDetailId

出荷明細ID

string

5

shipmentId

出荷ID

string

5

productId

商品ID

string

8000001

taxRate

税率：出荷時の商品税率

string

10.000

cost

原価(外税)

string

100.00000

price

商品単価(内税)

string

500

quantity

出荷数

string

5

memo

メモ

string

出荷明細メモ5

rfidTags

RFIDタグリスト

Array<string>

[
  "RFID001",
  "RFID002"
]

insDateTime

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

string

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

updDateTime

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

string

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

Example

[
  {
    "shipmentDetailId": "5",
    "shipmentId": "5",
    "productId": "8000001",
    "taxRate": "10.000",
    "cost": "100.00000",
    "price": "500",
    "quantity": "5",
    "memo": "出荷明細メモ5",
    "rfidTags": [
      "RFID001",
      "RFID002"
    ],
    "insDateTime": "2025-01-01T00:00:00+09:00",
    "updDateTime": "2025-01-01T00:00:00+09:00"
  }
]