出荷一覧取得

GET

/shipments

• サンドボックス
• 本番

出荷情報一覧を取得します。

対象プラン

• リテールビジネス

Authorizations

• AppAccessToken
  pos.orders:read

Parameters

Query Parameters

fields

array

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

Example

shipmentStoreId,shipmentDate

sort

string

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

指定可能なパラメータ

• shipmentId：出荷ID
• shipmentStoreId：出荷店舗ID
• shipmentDivision：出荷区分：0:出荷、1:返品、2:販促品
• shipmentDate：出荷日：[YYYY-MM-DD]
• status：出荷ステータス：(0:未出荷、2:出荷済、3:出荷検品中)※3:出荷検品中はAPIでの指定のみ
• updDateTime：更新日時：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

Example

shipmentStoreId

limit

integer

上限数

Example

10

page

integer

ページ

Example

2

shipment_store_id

string

出荷店舗ID

Example

2

shipment_division

string

Allowed values: 0 1 2

出荷区分：0:出荷、1:返品、2:販促品

Example

0

shipment_date

string

出荷日：[YYYY-MM-DD]

Example

2025-01-01

status

string

Allowed values: 0 2 3

出荷ステータス：(0:未出荷、2:出荷済、3:出荷検品中)※3:出荷検品中はAPIでの指定のみ

Example

2

Responses

200

取得成功

Array<object>

object

shipmentId

出荷ID

string

1

shipmentStoreId

出荷店舗ID

string

2

recipientType

受取先タイプ：1：仕入先、3：その他

string

Allowed values: 1 3

1

recipientId

受取先ID：受取先タイプのID。1：仕入先→仕入先ID、3：その他→null

string

2

recipientName

受取先名：登録時の受取先名

string

仕入先2

shipmentDivision

出荷区分：0:出荷、1:返品、2:販促品

string

Allowed values: 0 1 2

0

shipmentDate

出荷日：[YYYY-MM-DD]

string

2025-01-01

memo

メモ

string

出荷メモ

staffId

スタッフID

string

1

taxRate

税率：出荷時の税率

string

10.000

identificationNo

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

string

123456789

roundingDivision

税丸め（0:四捨五入、1:切り捨て、2:切り上げ）

string

Allowed values: 0 1 2

1

status

出荷ステータス：(0:未出荷、2:出荷済、3:出荷検品中)※3:出荷検品中はAPIでの指定のみ

string

Allowed values: 0 2 3

2

approvalStatus

承認ステータス：0:未承認, 1:承認済, 2:承認拒否

string

Allowed values: 0 1 2

1

approvalDateTime

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

string

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

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

[
  {
    "shipmentId": "1",
    "shipmentStoreId": "2",
    "recipientType": "1",
    "recipientId": "2",
    "recipientName": "仕入先2",
    "shipmentDivision": "0",
    "shipmentDate": "2025-01-01",
    "memo": "出荷メモ",
    "staffId": "1",
    "taxRate": "10.000",
    "identificationNo": "123456789",
    "roundingDivision": "1",
    "status": "2",
    "approvalStatus": "1",
    "approvalDateTime": "2025-01-01T00:00:00+09:00",
    "insDateTime": "2025-01-01T00:00:00+09:00",
    "updDateTime": "2025-01-01T00:00:00+09:00"
  }
]