出庫明細取得

GET

/shipping/{shipping_id}/details

curl --request GET \
  --url 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/shipping/13/details?fields=shippingDetailId%2CproductId&sort=shippingDetailId&limit=10&page=2&product_id=8000001'

• サンドボックス
• 本番

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

対象プラン

• リテールビジネス

Authorizations

• AppAccessToken
  pos.transfers:read

Parameters

Path Parameters

shipping_id

required

string

出庫ID

Example

13

Query Parameters

fields

array

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

Example

shippingDetailId,productId

sort

string

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

指定可能なパラメータ

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

Example

shippingDetailId

limit

integer

上限数

Example

10

page

integer

ページ

Example

2

product_id

string

商品ID

Example

8000001

Responses

200

取得成功

Media typeapplication/json

Array<object>

object

shippingDetailId

出庫明細ID

string

shippingId

出庫ID

string

productId

商品ID

string

cost

原価(外税)

string

price

商品単価(内税)

string

requestQuantity

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

string

nullable

quantity

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

string

rfidTags

RFIDタグリスト

Array<string>

status

出庫明細ステータス：0 のみ。

string

Allowed values: 0

insDateTime

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

string

updDateTime

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

string

Example

[
  {
    "shippingDetailId": "13",
    "shippingId": "13",
    "productId": "8000001",
    "cost": "100.00000",
    "price": "500",
    "requestQuantity": null,
    "quantity": "2",
    "rfidTags": [
      "RFID001",
      "RFID002"
    ],
    "status": "0",
    "insDateTime": "2025-01-01T00:00:00+09:00",
    "updDateTime": "2025-01-01T00:00:00+09:00"
  }
]

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
}