Skip to main content
GET
Get variant by ID

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

variantId
string
required

Variant 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:

"FB6bgFV4lf"

Query Parameters

location
string
default:US

ISO 3166-1 alpha-2 country code.

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

"US"

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:

Response

Single variant.

Single variant.

id
string
required

Variant identifier.

Example:

"FB6bgFV4lf"

title
string
required

Variant title.

Example:

"NFL 25-Layer StadiumView Wall Art"

selectedOptions
object
required

Selected option values for this variant.

Example:
taxable
boolean
required

Whether the variant is taxable.

Example:

true

media
object[]
required

Variant media.

personalization
object | null
required

Personalization metadata, or null when unavailable.

productId
string

Parent product identifier.

Example:

"655277e68e0719000d6c3fd5"

price
object

Variant price in a given currency.

priceBreakdown
object

Detailed breakdown of the variant price.

descriptionHtml
string

HTML full narrative description.

Example:

"<p>The 25-Layer StadiumViews 3D Wall Art</p>"

details
object

Variant-level structured details wrapper. Returned only when fields includes details.

brand
object | null

Product or variant brand. Returned only when include=brand. Nullable when the product or variant has no brand.

Last modified on June 17, 2026