Skip to main content
GET
Get base 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
required

Required. Account identifier.

Minimum string length: 1
Example:

"acc123456"

Path Parameters

baseProductId
string<uuid>
required

Base-product UUID.

Example:

"048392af-5f4c-4ddc-b0e2-7a0edf152268"

Query Parameters

page[number]
integer
default:1

1-indexed page number.

Required range: x >= 1
Example:

1

page[size]
integer
default:100

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

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

100

location
string
required

Required ISO 3166-1 alpha-2 country code.

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

"US"

Response

Paginated list of base variants.

Paginated base variant list response (page-number pagination).

data
object[]
required

Base 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 September 23, 2026