API ReferenceProductsVariants

Get Product Variants

View as Markdown
Retrieves all variants for a specific product.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Path parameters

productIdstringRequiredformat: "int64"
The product id

Response

Success
additional_hazmat_attributesobject
Additional hazardous materials attributes for lithium batteries and dangerous goods
associated_bundleslist of objects or null
List of bundle products that include this variant as a component
barcodeslist of objects or null

List of barcodes associated with this variant (UPC, EAN, etc.)

bundle_definitionlist of objects or null
If this variant is a bundle, defines which variants and quantities make up the bundle
channel_metadatalist of objects or null

Platform-specific metadata for sales channels (e.g., Amazon ASIN, Shopify product IDs)

created_ondatetime
Timestamp when the variant was created
customsobject

Customs and international shipping information (tariff codes, country of origin, declared value)

dimensionobject

Physical dimensions of the variant (length, width, height)

fulfillment_settingsobject

Fulfillment-specific settings (Prop 65, dangerous goods, serial scanning, case pick)

gtinstring or null

Global Trade Item Number - standardized product identifier

idlong
Unique identifier for the variant
inventoryobject

Current inventory information including on-hand quantity

is_digitalboolean

Flag indicating whether this is a digital product (no physical fulfillment)

is_image_uploadedboolean
Flag indicating whether a product image has been uploaded for this variant
lot_informationobject
Lot tracking settings including whether lot tracking is enabled and minimum shelf life requirements
merge_childrenlist of objects or null
List of variants that have been merged into this variant
namestring or null
Variant name or descriptor
packaging_material_typeobject

Type of packaging material used for this variant (ID and name)

packaging_requirementobject

Special packaging requirements for this variant (ID and name)

return_preferencesobject
Customer return handling preferences including primary and backup actions
reviews_pendinglist of strings or null

List of pending review types for this variant (e.g., compliance checks, quality reviews)

skustring or null

Stock Keeping Unit - unique identifier for the variant used in inventory management

statusstring or null

Current status of the variant (e.g., ‘Active’, ‘Inactive’)

upcstring or null

Universal Product Code - 12-digit barcode identifier

updated_ondatetime or null
Timestamp when the variant was last updated
weightobject
Weight of the variant including unit of measure

Errors

400
Bad Request Error
404
Not Found Error