Shipments 一覧(ページネーション付き)
呼び出してよいタイミング(それ以外では呼ばないでください)
- 一回限りのバックフィル — 初回統合時、webhook 購読の前にローカル DB に既存のシップメントを書き込むため。
- 定期的な整合性チェック — webhook 配信の漏れや順序ずれを検知するため。ローカルキャッシュとこのエンドポイントの結果を差分し、webhook 再送やサポート連携で穴埋めしてください。
必須パラメータ
createFrom/createTo— どちらも必須、ISO 8601 タイムスタンプ。範囲は 90 日が上限(SearchConfig.simpleRecordsMaxDays)。それ以上はソフトエラーで拒否されます。pageSize—1から50の間。offset— 非負整数。pageSizeと組み合わせてオフセットページングを行います。
レスポンスの注意
- 総件数は 返されません。あるページで
pageSize未満のレコードが返ってきたら、それが末尾です。 labelRequestStatusCodeはクエリ時点の最新状態を表します。状態遷移の履歴が必要な場合は webhook イベントを購読してください——本エンドポイントでは履歴を取得できません。- レスポンスの国コードは ISO3 です。
関連
- 返品シップメントを作成 — 書き込み側エンドポイント。
- すべてのシップメントステータスを取得 —
shipmentStatusCodeを可読ラベルへ変換。 - Webhooks — シップメントライフサイクル イベントの正規チャネル。本エンドポイントを利用する前に必ず webhook を設定してください。
承認
Your API key
Your API token — keep this private
クエリパラメータ
Number of records per page (max 50)
1 <= x <= 50Pagination offset
Filter by creation date from (ISO 8601)
Filter by creation date to (ISO 8601)
レスポンス
Success
Full record of a return shipment. Successful responses also carry the standard envelope fields (correlationId, meta) alongside the fields below.
Return request identifier
Return request number
Your merchant-supplied reference, echoed back for reconciliation
Current return status code
Return title
Declared total value of the return
ISO 4217 currency code of totalValue (e.g. USD)
Warehouse-assigned RMA reference (uppercased). Populated once the warehouse processes the parcel.
Free-text remarks
Whether the return request is archived
Origin/source of the return request
Shipments belonging to this return request, each with its label.
Line items included in the return request.
Return inventory records derived from this request, populated once the warehouse has received the parcel. Empty before receipt — use Get return inventory details for full inventory data at that stage.
Custom fields attached to the return shipment.