List shipments with pagination
退件运货单
列出 Shipments(分页)
GET
List shipments with pagination
返回您账户上已建立的退件运货单分页列表,可按日期范围、状态、仓库或服务类型筛选。
仅在以下情况调用
- 一次性回填:首次集成时,于订阅 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
Return request identifier