Add Product Variants
Adds new variants to an existing product. The request body must be an array of variant objects, each requiring a unique SKU.
Authorizations
Authentication using Personal Access Token (PAT) token
Path Parameters
Body
The product variants to add to product
Additional hazardous material attributes for variants containing lithium batteries or other regulated materials
For bundle products, defines which variants and quantities make up the bundle
Channel-specific metadata for different sales platforms (Amazon, Shopify, BigCommerce, etc.)
Customs information for international shipping including HS tariff code, country of origin, and declared value
The physical dimensions (length, width, height) of the variant
Fulfillment settings including Prop 65 requirements, dangerous goods, serial scanning, and case pick settings
The Global Trade Item Number (GTIN) for the variant
Indicates whether this is a digital product that requires no physical fulfillment
Lot tracking information including whether the variant is lot-tracked and minimum shelf life
The name of the variant
The ID of the packaging material type (e.g., Box, Envelope, Poly Mailer)
The ID of the packaging requirement for the variant (e.g., IsFragile, RequiresBubbleWrap)
Return handling preferences including primary and backup actions for returns
The unique stock keeping unit (SKU) for the variant
The status ID of the variant (0 = Active, 1 = Inactive)
0, 1 The Universal Product Code (UPC) for the variant
The weight of the variant in ounces
Array of barcode values for the variant
[
{
"additional_hazmat_attributes": {
"charge_state_percentage": 0.1,
"container_metal": true,
"container_type": "string",
"lithium_battery_packaging": "string",
"lithium_battery_type": "string",
"magnet": true,
"net_volume": 0.1,
"net_weight": 0.1
},
"barcodes": [
{
"sticker_url": "string",
"value": "string"
}
],
"bundle_definition": [{ "quantity": 0, "variant_id": 0 }],
"channel_metadata": [
{
"asin": "string",
"channel_id": 0,
"currency": "string",
"fnsku": "string",
"fulfillment_channel": "string",
"id": 0,
"is_inventory_sync_enabled": true,
"legacy_product_id": 0,
"platform": "string",
"platform_identifier": "string",
"platform_inventory_item_id": "string",
"price": 0.1,
"seller_sku": "string"
}
],
"customs": {
"country_code_of_origin": "string",
"description": "string",
"hs_tariff_code": "string",
"is321_eligible": true,
"value": 0
},
"dimension": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"fulfillment_settings": {
"dangerous_goods": true,
"is_bpm_parcel": true,
"is_case_pick": true,
"msds_url": "string",
"requires_prop65": true,
"serial_scan": {
"exact_character_length": 0,
"is_enabled": true,
"prefix": "string",
"suffix": "string"
}
},
"gtin": "string",
"is_digital": true,
"lot_information": {
"is_lot": true,
"minimum_shelf_life_days": 0
},
"name": "string",
"packaging_material_type_id": 0,
"packaging_requirement_id": 0,
"return_preferences": {
"backup_action_id": 0,
"instructions": "string",
"primary_action_id": 0,
"return_to_sender_backup_action_id": 0,
"return_to_sender_primary_action_id": 0
},
"sku": "string",
"status_id": 0,
"upc": "string",
"weight": 0.1
}
]Response
Created
Timestamp when the product was created
Unique identifier for the product
Product name
Product categorization information including category hierarchy
Product type (e.g., 'Regular' or 'Bundle')
Timestamp when the product was last updated
ID of the user who owns this product
List of variants belonging to this product. Each variant represents a specific SKU.
- Option 1
- Option 2