Get product variants
Use this endpoint to retrieve a paginated list of variants for a specific product.
Filtering options:
- Selected options (e.g., size, color) - exact match, multiple options are ANDed together
- Price range (min and max)
Optional parameters
include=brand- include the variant’sbrandobject (same shape as the product-level brand, nullable)fields=price,priceBreakdown,details- include variant pricing and the structureddetailswrapper.priceBreakdownimpliesprice.filter[price][gte]/filter[price][lte]- inclusive min/max variant price filterlocation- ISO 3166-1 alpha-2 country code (defaultUS) to scope pricingpage[number]/page[size]- page-number pagination (1-indexed; max 300 per page, default 100)Snappy-Account-Id/Snappy-Company-Idheaders - optional scoping
Please note
When fields is omitted, price, priceBreakdown, and details are not returned. Unknown filter keys will return a 400 error.
Permissions
- Requires:
products:read
Authorizations
Company Level Authentication
Include your API key in the X-Api-Key header for every request:
X-Api-Key: YOUR_API_KEYHeaders
Optional account identifier for swag validation/filtering.
"acc123456"
Optional company identifier for swag validation/filtering.
"cmp123456"
Path Parameters
Stable product ID.
^[A-Za-z0-9]{8,}$"655277e68e0719000d6c3fd5"
Query Parameters
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$"US"
Inclusive minimum variant price filter.
x >= 010
Inclusive maximum variant price filter.
x >= 0200
Related entities to include.
Related entities to include.
brand ["brand"]Comma-separated list of variant-level field expansions.
price- includesprice(andpartnerPricefor partner companies).priceBreakdown- includespriceBreakdownand impliesprice(andpartnerPricefor partner companies).details- includes the variantdetailswrapper.
Use include=brand to include the variant's brand object (nullable).
When omitted, price, priceBreakdown, partnerPrice, and details are not returned.
Variant-level field expansions.
price, priceBreakdown, details ["price", "priceBreakdown"]1-indexed page number.
x >= 11
Number of variants per page (max 300, default 100).
1 <= x <= 300100
Response
Paginated list of variants.
Paginated variant list response (page-number pagination).