Skip to main content
GET
/
accounts
/
api
/
products
/
search
Search products
curl --request GET \
  --url https://api.upstackdata.com/accounts/api/products/search \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "title": "<string>",
      "vendor": "<string>",
      "variants": [
        {
          "id": "<string>",
          "productId": "<string>",
          "sku": "<string>",
          "title": "<string>",
          "handlingFee": 123,
          "manualCostHistory": [
            {
              "id": "<string>",
              "cost": 123,
              "effectiveStartDate": "<string>",
              "effectiveEndDate": "<string>",
              "description": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "nextCursor": "<string>"
}

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 nextCursor.

Response

A page of products with their variants.

​
items
object[]
required
​
nextCursor
string | null

Cursor to pass as ?cursor= to fetch the next page. null when no more pages.