Skip to main content
List tracked variants

Authorizations

Authorization
string
header
required

Public API token passed as Authorization: Bearer .

Query Parameters

page
integer

One-based page number.

Required range: x >= 1
perPage
integer

Number of items per page.

Required range: x >= 1
variants
string[]

Preferred filter for Shopify product variant IDs. If present, this takes precedence over variantIds. Repeat the parameter or pass a comma-separated list.

Minimum array length: 1
variantIds
string[]

Legacy alias for variants. Use variants for new integrations. Repeat the parameter or pass a comma-separated list.

Minimum array length: 1
status
enum<string>[]

Filter by tracked-variant status. Repeat the parameter or pass a comma-separated list.

Available options:
active,
inactive,
missingPricingStrategy,
missingListing,
ambiguousListing,
highVolatility
collectionId
string

Filter tracked variants to a Shopify collection.

Response

Successful response.

variants
object[]
pagination
object