Skip to main content
GET
Search resend by seller reference number
此页面由 AI 自动翻译。API 技术规格以英文呈现为标准。如有任何疑问,请参阅英文版本
此为 Enterprise 专属 功能,仅对 Return Helper Enterprise 客户开放。未启用的账户其请求会被拒绝。如需了解更多,请联系 enterprise-solution@returnhelper.com
以您调用 Create resend by SKU 时提供的 sellerReferenceNumber 搜索补寄,并返回每笔匹配结果的 resendId。补寄相关操作仍需使用 Return Helper 的 resendId——本接口正是获取该值的方式,让您不必自行存储 resendId。值采用完全匹配,不支持部分匹配或通配符搜索。

只知道自有参考编号时如何取消补寄

  1. 以您的 sellerReferenceNumber 调用本接口。
  2. 从结果中读取 resendIdresendStatusCode,挑选您要处理的补寄。
  3. 以该 resendId 调用 Cancel resend order
sellerReferenceNumber 并非唯一值。取消后重新创建补寄,会合理地产生多笔带有相同值的补寄,因此一次搜索可能返回多笔结果。请务必先检查 resendStatusCode,再决定要对哪个 resendId 执行操作。

哪些补寄可被搜索

Create resend order 创建的补寄不带 sellerReferenceNumber,因此永远不会出现在本接口的结果中——请改以 resendId 通过 Get resend order details 查询。

将状态更新对应到您自己的记录

重寄状态更新 webhookcategory: resend / action: updateResendStatus)会在 resendShipmentList[] 中带上 sellerReferenceNumber。请订阅该事件,并在事件送达时与您自己的订单记录比对——这才是追踪补寄生命周期的建议做法。本搜索接口则适用于即时查询,例如在取消前立即查找。

分页

此接口采用游标式分页。每个响应都包含 nextCursorpreviousCursor
  • nextCursor 是下一页的游标;已到最后一页时为 null
  • previousCursor 是上一页的游标;在第一页时为 null
若要向前翻页,将 nextCursor 的值作为 cursor 查询参数传回,并带上 isForward=true。在同一个分页序列中,请保持相同的 pageSize 与筛选条件。

授权

x-rr-apikey
string
header
必填

Your API key

x-rr-apitoken
string
header
必填

Your API token — keep this private

查询参数

sellerReferenceNumberList
string
必填

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.

pageSize
integer
必填

Number of resends to return per page. Required. Minimum 1, maximum 1000.

必填范围: 1 <= x <= 1000
resendStatusCode
enum<string>

Filter 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
cursor
string

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.

isForward
boolean

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.

nextCursor
string | null

Cursor token for the next page, or null when there is no next page. Pass it back as cursor with isForward=true to page forward.

previousCursor
string | null

Cursor token for the previous page, or null when there is no previous page.

data
object[]

Resends for the current page