List Product Aliases

get

https://api.warehance.com/v1/product-aliases

Required permission: read_products

Get a list of product aliases (alternate barcodes) for your organization or client. Filter by product_id to get the aliases of one product, or by barcode to check whether a barcode is already in use. Product aliases must be enabled for the organization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort_by

string

enum

Specifies the field by which to sort the returned product aliases:

created_at: Sort by the creation date of the product alias.
updated_at: Sort by the last updated date of the product alias.
barcode: Sort by the alias barcode.

Allowed:

limit

integer

1 to 100

Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

offset

integer

≥ 0

Defaults to 0

deprecated

Deprecated. Use cursor instead. Offset pagination will be removed on November 9, 2026. See Pagination.

The number of items to skip before starting to return results. Cannot be used together with the cursor parameter.

order_by

string

enum

Defaults to asc

Specifies the sort direction of the returned items:

asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.

Allowed:

client_id

integer

≥ 1

Only applicable for organizations. Filters items by the specified client_id, provided the client_id belongs to the organization. Note: API keys can belong to either client level or organization level.

cursor

string

A cursor for pagination. Omit it for the first page, then pass the next_cursor value from the previous response to fetch the next page. Keep the same filters and sort on every page. See Pagination.

product_id

integer

≥ 1

Only return aliases of this product.

barcode

string

length between 1 and 255

Only return aliases with this exact, case-sensitive barcode.

Responses

200A list of product aliases

400Example Error Response

403Forbidden - API Key does not have required permissions, or product aliases are not enabled