列出 Shipments(分頁)
僅在以下情況呼叫
- 一次性回填:首次整合時,於訂閱 webhook 之前,將既有運貨單寫入本地資料庫。
- 定期對帳:用以偵測遺漏或亂序的 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.