Skip to main content
GET
Get product variants

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

Headers

snappy-account-id
string

Optional account identifier for swag validation/filtering.

Example:

"acc123456"

snappy-company-id
string

Optional company identifier for swag validation/filtering.

Example:

"cmp123456"

Path Parameters

productId
string
required

Stable product ID.

Pattern: ^(?:^[A-Za-z0-9]{8,}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$)$
Example:

"655277e68e0719000d6c3fd5"

Query Parameters

location
string
default:US

ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$
Example:

"US"

filter[price][gte]
number | null

Inclusive minimum variant price filter.

Required range: x >= 0
Example:

10

filter[price][lte]
number | null

Inclusive maximum variant price filter.

Required range: x >= 0
Example:

200

include
enum<string>[]

Related entities to include.

Related entities to include.

Available options:
brand
Example:
fields
enum<string>[]

Comma-separated list of variant-level field expansions.

  • pricing - includes price and priceBreakdown.
  • details - includes the variant details wrapper.

Use include=brand to include the variant's brand object (nullable).

When omitted, price, priceBreakdown, and details are not returned in the public response.

Variant-level field expansions.

Available options:
pricing,
details
Example:
page[number]
integer
default:1

1-indexed page number.

Required range: x >= 1
Example:

1

page[size]
integer
default:100

Number of variants per page (max 300, default 100).

Required range: 1 <= x <= 300
Example:

100

Response

Paginated list of variants.

Paginated variant list response (page-number pagination).

data
object[]
required

Variants for the requested page.

Top-level JSON:API-style pagination links for paginated list responses. first, next, and prev are all required and all nullable. prev is null on cursor-paginated endpoints (backward navigation not supported).

Last modified on June 17, 2026