按 Seller Reference Number 搜索 Resend
Enterprise-only. Returns the resends whose resend shipment carries one of the supplied sellerReferenceNumber values.
sellerReferenceNumber 搜索补寄,并返回每笔匹配结果的 resendId。补寄相关操作仍需使用 Return Helper 的 resendId——本接口正是获取该值的方式,让您不必自行存储 resendId。值采用完全匹配,不支持部分匹配或通配符搜索。
只知道自有参考编号时如何取消补寄
- 以您的
sellerReferenceNumber调用本接口。 - 从结果中读取
resendId与resendStatusCode,挑选您要处理的补寄。 - 以该
resendId调用 Cancel resend order。
sellerReferenceNumber 并非唯一值。取消后重新创建补寄,会合理地产生多笔带有相同值的补寄,因此一次搜索可能返回多笔结果。请务必先检查 resendStatusCode,再决定要对哪个 resendId 执行操作。哪些补寄可被搜索
以 Create resend order 创建的补寄不带sellerReferenceNumber,因此永远不会出现在本接口的结果中——请改以 resendId 通过 Get resend order details 查询。
将状态更新对应到您自己的记录
重寄状态更新 webhook(category: resend / action: updateResendStatus)会在 resendShipmentList[] 中带上 sellerReferenceNumber。请订阅该事件,并在事件送达时与您自己的订单记录比对——这才是追踪补寄生命周期的建议做法。本搜索接口则适用于即时查询,例如在取消前立即查找。
分页
此接口采用游标式分页。每个响应都包含nextCursor 与 previousCursor:
nextCursor是下一页的游标;已到最后一页时为null。previousCursor是上一页的游标;在第一页时为null。
nextCursor 的值作为 cursor 查询参数传回,并带上 isForward=true。在同一个分页序列中,请保持相同的 pageSize 与筛选条件。
相关
- 按 SKU 创建 Resend —
sellerReferenceNumber于此提供。 - 取消补寄订单 — 以本接口查得的
resendId取消。 - Webhooks — 重寄状态更新事件,会一并带上
sellerReferenceNumber。
授权
Your API key
Your API token — keep this private
查询参数
Comma-separated list of seller reference numbers to match (e.g. ORDER-0001,ORDER-0002). Required, at least one value. Each value must be non-empty, single-line, and 1–50 characters. The number of entries must not exceed 100.
Number of resends to return per page. Required. Minimum 1, maximum 1000.
1 <= x <= 1000Filter to a single resend status. Not a list. Omit to return resends in every status. Optional.
pending, canceled, in-progress, completed, failed, queued, label-success Opaque, versioned cursor token. Pass the nextCursor (or previousCursor) from a previous response to fetch the adjacent page. Omit to fetch the first page. Optional.
Pagination direction. Set true to page forward through results using the returned nextCursor. Defaults to false when omitted. Optional.
响应
Success
Cursor-paginated list of resends matching the supplied seller reference numbers. The business payload (nextCursor, previousCursor, data) is returned as top-level fields alongside the standard correlationId and meta envelope.