Skip to main content
GET
Search products

Authorizations

x-api-key
string
header
required

Your Upstack API key. Starts with upstack_.

x-pixel-id
string
header
required

The pixel id the request targets.

Query Parameters

q
string

Search term (matched against title / SKU / variant).

pageSize
integer
default:20
Required range: 1 <= x <= 100
cursor
string

Pagination cursor from a previous response's pagination.cursor.

ids
string

Comma-separated product ids. Fetches those products directly instead of searching. Duplicates are ignored; at most 100 ids per request.

includeVariants
boolean

Whether each product carries its variants. Defaults to true when searching and false when fetching by ids.

Response

A page of products with their variants.

products
object[]
required
pagination
object
required