Skip to main content
GET
Search SKU inventory
This is an Enterprise-only feature, enabled only for Return Helper Enterprise customers. To learn more about pricing for this service, contact enterprise-solution@returnhelper.com.
Returns warehouse-scoped SKU inventory for your account, using cursor-based pagination. Each row reports both the total quantity and the availableQuantity for one SKU in one warehouse.

Rows are keyed by warehouse and SKU

The same SKU held in more than one warehouse is returned as separate rows — one per warehouse. A response row is uniquely identified by its warehouseId + sku pair, and searchTotalCount counts warehouse-SKU rows, not distinct SKU values. To see only one warehouse, pass warehouseIdList.
Cursors issued by the previous version of this endpoint are rejected. If you cached an old cursor value, restart pagination with no cursor — the versioned cursor is not backward-compatible, and old API-ID cursor values are not reinterpreted as warehouse IDs.

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 any warehouseIdList / skuList filters) across every request in a pagination sequence.
availableQuantity is a summary figure for an early availability check — it is not a reservation. It can differ briefly from live return inventory (projection delay), and it may count records with pending VAS that are not actually resend-eligible. Create resend by SKU performs the authoritative, locked allocation against MySQL at request time.

Authorizations

x-rr-apikey
string
header
required

Your API key

x-rr-apitoken
string
header
required

Your API token — keep this private

Query Parameters

pageSize
integer
required

Number of warehouse-SKU rows to return per page. Required. Minimum 1, maximum 1000.

Required range: 1 <= x <= 1000
cursor
string

Opaque, versioned cursor token encoding cursor version, warehouse ID, and SKU. Pass the nextCursor (or previousCursor) from a previous response to fetch the adjacent page. Omit to fetch the first page. Cursors issued by the previous (pre-redesign) version of this endpoint are rejected — restart pagination without a cursor.

isForward
boolean

Pagination direction. Set true to page forward through results using the returned nextCursor. Defaults to false when omitted. Optional.

warehouseIdList
string

Comma-separated list of warehouse IDs to filter by (e.g. 1001,1002). When provided, each value must be a positive integer, the list must contain no duplicates, the number of entries must not exceed 100, and every warehouse must be owned by the authenticated account. Omit to return rows across all owned warehouses. Optional.

skuList
string

Comma-separated list of SKUs to filter by (e.g. SKU-006,SKU-001). When provided, the number of entries must not exceed 100 and each SKU must match the SKU pattern (alphanumerics plus #, -, _; maximum 32 characters). SKUs are matched after trim and uppercase normalization. Omit to return all SKUs. Optional.

Response

Success

Cursor-paginated list of SKU inventory records. 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[]

SKU inventory records for the current page