Get variant by ID
Use this endpoint to retrieve a single product variant by its ID. Returns the same Variant object shape as items in the Get product variants list response.
Optional parameters
fields=pricing- includepriceandpriceBreakdownfields=details- include thedetailswrapperinclude=brand- include the variant’sbrandobject
Please note
When fields is omitted, price, priceBreakdown, and details are not returned in the public response.
Permissions
- Requires:
products:read
Authorizations
Company Level Authentication
Include your API key in the X-Api-Key header for every request:
Headers
Optional account identifier for swag validation/filtering.
"acc123456"
Optional company identifier for swag validation/filtering.
"cmp123456"
Path Parameters
Variant ID.
^(?:^[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}$)$"FB6bgFV4lf"
Query Parameters
ISO 3166-1 alpha-2 country code.
^[A-Z]{2}$"US"
Related entities to include.
Related entities to include.
brand Comma-separated list of variant-level field expansions.
pricing- includespriceandpriceBreakdown.details- includes the variantdetailswrapper.
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.
pricing, details Response
Single variant.
Single variant.
Variant identifier.
"FB6bgFV4lf"
Variant title.
"NFL 25-Layer StadiumView Wall Art"
Selected option values for this variant.
Whether the variant is taxable.
true
Variant media.
Personalization metadata, or null when unavailable.
Parent product identifier.
"655277e68e0719000d6c3fd5"
Variant price in a given currency.
Detailed breakdown of the variant price.
HTML full narrative description.
"<p>The 25-Layer StadiumViews 3D Wall Art</p>"
Variant-level structured details wrapper. Returned only when fields includes details.
Product or variant brand. Returned only when include=brand. Nullable when the product or variant has no brand.