variantId from the Product’s variants array.
V3 has shipped a refreshed Catalog API split into two sections: Products (V3) and Variants (V3). V3 introduces JSON:API conventions, per-country availability, and a cleaner separation between the two entities. V2 and V3 are supported in parallel.
The Product Object
The Variant Object
A Variant represents a specific, orderable version of a Product. When placing an order you must always specify thevariantId - the Product ID alone is not sufficient.
Key Concepts & Business Rules
Always order by Variant ID
Products are the display-level object - they represent what a recipient sees when browsing. Variants are the orderable units. When placing an order, always use thevariantId, not the productId.
Every Product contains a variants array with at least one entry, even if the product has no variations. For products without variations, the array will contain a single Variant representing the product itself. Always retrieve the variantId from this array before placing an order.
Options vs. Variant Attributes
Theoptions field on the Product object shows the available option dimensions (e.g. color, size). The optionAttributes field on each Variant shows the specific combination of those options that Variant represents. Use options to understand what choices exist, and optionAttributes to identify the exact Variant.
Pricing is per country
Variantpricing is keyed by country code and only returned when requested via the fields parameter (fields=pricing or fields=full). Always check that a Variant’s supportedCountries includes the recipient’s country before placing an order.
Product types
Products and Variants carry atypes array. The enum includes:
physical- physical items shipped to the recipient’s addressdigital- digital items delivered electronicallyexperience- local experiences and bookingspersonalized- items with recipient-specific personalizationbase-product-swag/on-demand-swag/on-demand-plus-swag/premium-swag- swag fulfillment categories
Tags
Tags exist at both the Product and Variant level and can be used to filter and categorize items when building a catalog UI. Retrieve all available tags usingGET /v2/products/tags.
Field projection with fields
By default, response objects return a slim set of fields. Use the fields query parameter to include additional data:
mediaItems,tags,brand,optionAttributes,notices,pricing,supportedCountriesfull- return everything
How to Work with Products & Variants
List Products Search for and retrieve a list of available products based on your specified criteria:- Budget range (required) -
minBudgetandmaxBudget - Specific Collection (
collectionId) - Brand (
brandNameorbrands) - Tags (
tags) - Title or description text match
title parameter (minimum 3 characters). Results are paginated.
Get a Product (with Variants) by ID
Retrieve a Product by its ID, including the full list of Variants:
- Budget range
- Country
Despite the endpoint summary “Get variants by product ID,” this endpoint returns the full Product object with its
variants array - not just the variants in isolation.This endpoint returns the parent Product object with the requested Variant in its
variants array, not the Variant alone. Use the variant ID to locate the specific variant within the returned variants list.