Seller Reference Number で Resend を検索
Enterprise-only. Returns the resends whose resend shipment carries one of the supplied sellerReferenceNumber values.
sellerReferenceNumber で resend を検索し、一致した各 resend の resendId を返します。resend に対する操作には引き続き Return Helper の resendId が必要です。本エンドポイントはその resendId を取得する手段であり、お客様側で resendId を保存しておく必要はありません。値は完全一致で照合され、部分一致やワイルドカード検索はできません。
自社の参照番号しか分からない場合に resend をキャンセルする
- お客様の
sellerReferenceNumberを指定して本エンドポイントを呼び出します。 - 結果から
resendIdとresendStatusCodeを読み取り、対象の resend を選びます。 - その
resendIdで Cancel resend order を呼び出します。
sellerReferenceNumber は一意ではありません。キャンセルして再作成すると、同じ値を持つ resend が複数生じることが正常にあり得るため、検索が複数件を返す場合があります。どの resendId を操作するか決める前に、必ず resendStatusCode を確認してください。検索できる resend
Create resend order で作成した resend はsellerReferenceNumber を持たないため、本エンドポイントの結果には現れません。それらは resendId を使って Get resend order details で参照してください。
ステータス更新を自社のレコードと突き合わせる
再送ステータス更新 webhook(category: resend / action: updateResendStatus)は resendShipmentList[] に sellerReferenceNumber を含みます。このイベントを購読し、届いた時点でお客様自身の注文レコードと突き合わせてください。これが resend のライフサイクルを追跡する推奨方法です。本検索エンドポイントは、キャンセル直前など、必要なときに参照する用途に使用します。
ページネーション
このエンドポイントはカーソルベースのページネーションを使用します。各レスポンスにはnextCursor と previousCursor が含まれます。
nextCursorは次のページのカーソルです。最後のページに達した場合はnullになります。previousCursorは前のページのカーソルです。最初のページではnullになります。
nextCursor の値を cursor クエリパラメータとして渡し、isForward=true を指定します。1 つのページネーションシーケンス内では、同じ pageSize とフィルタを維持してください。
関連
- SKU で Resend を作成 —
sellerReferenceNumberはここで指定します。 - Resend Order をキャンセル — 本エンドポイントで見つけた
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.