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