> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.returnhelper.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Search resend by seller reference number
> Enterprise-only. Returns the resends whose resend shipment carries one of the supplied `sellerReferenceNumber` values.
This is an **Enterprise-only** feature, enabled only for Return Helper Enterprise customers. Requests from accounts that are not enabled are denied. To learn more, contact [enterprise-solution@returnhelper.com](mailto:enterprise-solution@returnhelper.com).
Finds resends by the `sellerReferenceNumber` you supplied when calling [Create resend by SKU](/api-reference/resend/create-resend-by-sku), and returns the `resendId` of each match. Resend actions still take Return Helper's `resendId` — this endpoint is how you retrieve it, so you do not have to store it on your side. Values are matched exactly — no partial or wildcard search.
## Cancel a resend you only know by your own reference
1. Call this endpoint with your `sellerReferenceNumber`.
2. Read `resendId` and `resendStatusCode` from the results and pick the resend you want.
3. Call [Cancel resend order](/api-reference/resend/cancel-resend-order) with that `resendId`.
`sellerReferenceNumber` is **not unique**. Cancelling and re-creating a resend legitimately produces more than one resend carrying the same value, so a search can return several results. Always check `resendStatusCode` before choosing which `resendId` to act on.
## Which resends are searchable
Resends created with [Create resend order](/api-reference/resend/create-resend-order) carry no `sellerReferenceNumber` and never appear here — look those up by `resendId` with [Get resend order details](/api-reference/resend/get-resend-order-details).
## Matching status updates to your own records
The [resend status update webhook](/webhooks#resend-status-update) (`category: resend` / `action: updateResendStatus`) carries `sellerReferenceNumber` in `resendShipmentList[]`. Subscribe to it and reconcile each event against your own order record as it arrives — that is the intended way to track a resend's lifecycle. Use this search endpoint for on-demand lookups, such as immediately before cancelling.
## Pagination
This endpoint uses **cursor-based pagination**. Each response carries `nextCursor` and `previousCursor`:
* `nextCursor` is the token for the next page, or `null` when you have reached the last page.
* `previousCursor` is the token for the previous page, or `null` on the first page.
To page forward, send the `nextCursor` value back as the `cursor` query parameter with `isForward=true`. Keep the same `pageSize` and filters across every request in a pagination sequence.
## Related
* [Create resend by SKU](/api-reference/resend/create-resend-by-sku) — where `sellerReferenceNumber` is supplied.
* [Cancel resend order](/api-reference/resend/cancel-resend-order) — cancel using the `resendId` you found here.
* [Webhooks](/webhooks) — resend status update events, delivered with `sellerReferenceNumber`.
## OpenAPI
````yaml get /api/Resend/searchResendBySellerReferenceNumber
openapi: 3.1.0
info:
title: Return Helper API
description: API documentation for Return Helper — covering User and Public endpoints.
version: 1.0.0
servers:
- url: https://api.returnshelper.com/uat/user
description: Sandbox — User API
- url: https://api.returnshelper.com/uat/public
description: Sandbox — Public API
- url: https://api.returnhelpercentre.com/v1/user
description: Production — User API
- url: https://api.returnhelpercentre.com/v1/public
description: Production — Public API
- url: https://api.returnhelperchina.com/user
description: Production — User API (China)
security:
- ApiKey: []
ApiToken: []
paths:
/api/Resend/searchResendBySellerReferenceNumber:
get:
tags:
- Resend
summary: Search resend by seller reference number
description: >-
Enterprise-only. Returns the resends whose resend shipment carries one
of the supplied `sellerReferenceNumber` values.
operationId: ReturnUserApi_SearchResendBySellerReferenceNumber
parameters:
- name: sellerReferenceNumberList
in: query
required: true
schema:
type: string
description: >-
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.
- name: pageSize
in: query
required: true
schema:
type: integer
minimum: 1
maximum: 1000
description: >-
Number of resends to return per page. Required. Minimum 1, maximum
1000.
- name: resendStatusCode
in: query
required: false
schema:
type: string
enum:
- pending
- canceled
- in-progress
- completed
- failed
- queued
- label-success
description: >-
Filter to a single resend status. Not a list. Omit to return resends
in every status. Optional.
- name: cursor
in: query
required: false
schema:
type: string
description: >-
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.
- name: isForward
in: query
required: false
schema:
type: boolean
description: >-
Pagination direction. Set `true` to page forward through results
using the returned `nextCursor`. Defaults to `false` when omitted.
Optional.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: >-
#/components/schemas/SearchResendBySellerReferenceNumberResponse
'401':
description: >-
Authentication failed. Returned when the `x-rr-apikey` or
`x-rr-apitoken` header is missing or invalid. The body uses the
standard `ApiResponse` envelope with `meta.error.message` describing
the auth failure.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponse'
security:
- ApiKey: []
ApiToken: []
servers:
- url: https://api.returnshelper.com/uat/user
description: Sandbox — User API
components:
schemas:
SearchResendBySellerReferenceNumberResponse:
type: object
description: >-
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.
properties:
nextCursor:
type:
- string
- 'null'
description: >-
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:
type:
- string
- 'null'
description: >-
Cursor token for the previous page, or `null` when there is no
previous page.
data:
type: array
items:
$ref: '#/components/schemas/SearchResendBySellerReferenceNumberReply'
description: Resends for the current page
ApiResponse:
type: object
description: >-
Universal response envelope. Successful responses include the business
payload as additional top-level fields alongside `correlationId` and
`meta`. Failed responses (auth errors, validation errors) only populate
`correlationId` and `meta`, with `meta.errorCode` and `meta.error`
describing the failure.
properties:
correlationId:
type:
- string
- 'null'
description: >-
Unique correlation ID for tracing the request through Return Helper
systems.
meta:
$ref: '#/components/schemas/ApiResponseMeta'
SearchResendBySellerReferenceNumberReply:
type: object
properties:
resendId:
type: integer
format: int64
description: Resend identifier. Pass this to Cancel resend order.
resendStatusCode:
type:
- string
- 'null'
description: >-
Current resend status: `pending`, `canceled`, `in-progress`,
`completed`, `failed`, `queued`, or `label-success`.
description:
type:
- string
- 'null'
description: Free-text description set when the resend was created
remarks:
type:
- string
- 'null'
description: Merchant remarks/notes set when the resend was created
resendShipmentList:
type: array
items:
$ref: '#/components/schemas/ResendShipmentPayload'
description: Resend shipments belonging to this resend
ApiResponseMeta:
type: object
description: >-
Application-level metadata for every API response. Inspect `status` and
`errorCode` to detect soft-error responses (validation failures arrive
as HTTP 200 with `meta.status: 400`).
properties:
status:
type: integer
description: >-
Application-level status code. For successful operations this
mirrors the HTTP status (e.g. 200). For validation failures it
reports the logical status (e.g. 400) even though the wire HTTP
status is 200.
data:
type: object
additionalProperties:
type: string
description: Reserved free-form metadata key/value pairs. Usually empty.
errorCode:
type:
- string
- 'null'
description: >-
Machine-readable error code (e.g. `VALIDATION_FAILED`). Non-null
only when the operation failed.
error:
type: object
additionalProperties: true
description: >-
Field-level or message-level error detail keyed by request property
name. Empty object on success.
ResendShipmentPayload:
type: object
properties:
resendShipmentId:
type: integer
format: int64
resendId:
type: integer
format: int64
warehouseId:
type: integer
format: int32
resendShipmentNumber:
type:
- string
- 'null'
sellerReferenceNumber:
type:
- string
- 'null'
description: >-
The reference you supplied when creating the resend through Create
resend by SKU. Not unique — cancelling and re-creating a resend
produces more than one resend carrying the same value. `null` for
resends created any other way.
shipmentServiceType:
type:
- string
- 'null'
shipmentCountryCode:
type:
- string
- 'null'
description: Lowercase ISO3
shipmentName:
type:
- string
- 'null'
shipmentPhone:
type:
- string
- 'null'
shipmentFax:
type:
- string
- 'null'
shipmentEmail:
type:
- string
- 'null'
shipmentStreet1:
type:
- string
- 'null'
shipmentStreet2:
type:
- string
- 'null'
shipmentStreet3:
type:
- string
- 'null'
shipmentState:
type:
- string
- 'null'
shipmentCity:
type:
- string
- 'null'
shipmentPostalCode:
type:
- string
- 'null'
trackingNumber:
type:
- string
- 'null'
error:
type:
- string
- 'null'
securitySchemes:
ApiKey:
type: apiKey
in: header
name: x-rr-apikey
description: Your API key
ApiToken:
type: apiKey
in: header
name: x-rr-apitoken
description: Your API token — keep this private
````