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 で resend を検索し、一致した各 resend の resendId を返します。resend に対する操作には引き続き Return Helper の resendId が必要です。本エンドポイントはその resendId を取得する手段であり、お客様側で resendId を保存しておく必要はありません。値は完全一致で照合され、部分一致やワイルドカード検索はできません。

自社の参照番号しか分からない場合に resend をキャンセルする

  1. お客様の sellerReferenceNumber を指定して本エンドポイントを呼び出します。
  2. 結果から resendIdresendStatusCode を読み取り、対象の resend を選びます。
  3. その resendIdCancel resend order を呼び出します。
sellerReferenceNumber一意ではありません。キャンセルして再作成すると、同じ値を持つ resend が複数生じることが正常にあり得るため、検索が複数件を返す場合があります。どの resendId を操作するか決める前に、必ず resendStatusCode を確認してください。

検索できる resend

Create resend order で作成した resend は sellerReferenceNumber を持たないため、本エンドポイントの結果には現れません。それらは resendId を使って Get resend order details で参照してください。

ステータス更新を自社のレコードと突き合わせる

再送ステータス更新 webhookcategory: resend / action: updateResendStatus)は resendShipmentList[]sellerReferenceNumber を含みます。このイベントを購読し、届いた時点でお客様自身の注文レコードと突き合わせてください。これが resend のライフサイクルを追跡する推奨方法です。本検索エンドポイントは、キャンセル直前など、必要なときに参照する用途に使用します。

ページネーション

このエンドポイントはカーソルベースのページネーションを使用します。各レスポンスには nextCursorpreviousCursor が含まれます。
  • nextCursor は次のページのカーソルです。最後のページに達した場合は null になります。
  • previousCursor は前のページのカーソルです。最初のページでは null になります。
前方向にページ送りするには、nextCursor の値を cursor クエリパラメータとして渡し、isForward=true を指定します。1 つのページネーションシーケンス内では、同じ pageSize とフィルタを維持してください。
  • SKU で Resend を作成sellerReferenceNumber はここで指定します。
  • Resend Order をキャンセル — 本エンドポイントで見つけた resendId を使ってキャンセルします。
  • Webhooks — 再送ステータス更新イベント。sellerReferenceNumber を伴って配信されます。

承認

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