API ReferenceProductsVariants

Add Product Variants

View as Markdown
Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Path parameters

productIdstringRequiredformat: "int64"

Request

The product variants to add to product
additional_hazmat_attributesobjectOptional
Additional hazardous material attributes for variants containing lithium batteries or other regulated materials
barcodeslist of objects or nullOptional
Array of barcode values for the variant
bundle_definitionlist of objects or nullOptional
For bundle products, defines which variants and quantities make up the bundle
channel_metadatalist of objects or nullOptional

Channel-specific metadata for different sales platforms (Amazon, Shopify, BigCommerce, etc.)

customsobjectOptional
Customs information for international shipping including HS tariff code, country of origin, and declared value
dimensionobjectOptional

The physical dimensions (length, width, height) of the variant

fulfillment_settingsobjectOptional
Fulfillment settings including Prop 65 requirements, dangerous goods, serial scanning, and case pick settings
gtinstring or nullOptional

The Global Trade Item Number (GTIN) for the variant

is_digitalbooleanOptional
Indicates whether this is a digital product that requires no physical fulfillment
lot_informationobjectOptional

Lot tracking information including whether the variant is lot-tracked and minimum shelf life

namestring or nullOptional
The name of the variant
packaging_material_type_idinteger or nullOptional

The ID of the packaging material type (e.g., Box, Envelope, Poly Mailer)

packaging_requirement_idinteger or nullOptional

The ID of the packaging requirement for the variant (e.g., IsFragile, RequiresBubbleWrap)

return_preferencesobjectOptional
Return handling preferences including primary and backup actions for returns
skustring or nullOptional

The unique stock keeping unit (SKU) for the variant

status_idenumOptional

The status ID of the variant (0 = Active, 1 = Inactive)

Allowed values:
upcstring or nullOptional

The Universal Product Code (UPC) for the variant

weightdoubleOptional
The weight of the variant in ounces

Response

Created
created_ondatetime or null
Timestamp when the product was created
idlong or null
Unique identifier for the product
namestring or null
Product name
taxonomyobject or null
Product categorization information including category hierarchy
typestring or null

Product type (e.g., ‘Regular’ or ‘Bundle’)

updated_ondatetime or null
Timestamp when the product was last updated
user_idlong or null
ID of the user who owns this product
variantslist of objects or null
List of variants belonging to this product. Each variant represents a specific SKU.