List shipments with pagination
返品配送
Shipments 一覧(ページネーション付き)
GET
List shipments with pagination
アカウントで作成された返品シップメントのページング付き一覧を返します。日付範囲、ステータス、倉庫、サービスタイプで任意にフィルタできます。
呼び出してよいタイミング(それ以外では呼ばないでください)
- 一回限りのバックフィル — 初回統合時、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
Return request identifier