Create variants
Bulk-creates variants. Successful entities are returned in data; per-item failures in errors.
POST
/api/v2/{team_slug}/{app_slug}/products/variantsAuthorization
AuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
Path parameters
team_slugstringrequiredapp_slugstringrequiredRequest body
requiredapplication/jsonvariantsCreateVariantItem[]requiredmin items 1 · max items 20
Show propertiesHide properties
Array of
CreateVariantItemproduct_idUUIDrequiredvariant_namestringrequiredvariant_numberstringrequiredstatusstringrequiredAllowed:
activedraftinactivearchivedvariant_group_idUUIDvalidate_stockbooleanpurchase_priceVariantPurchasePriceShow propertiesHide properties
currencystringrequiredvalue_centsintegerrequiredvariant_dimensionsProductDimensionShow propertiesHide properties
widthintegerheightintegerlengthintegerdepthintegerweightintegerdiameterintegercapacity_milliliterintegercustom_fieldsobjectstockVariantStockInput[]Show propertiesHide properties
Array of
VariantStockInputwarehouse_idUUIDrequiredquantityintegershipping_attributesstring[]Responses
201
Created (partial success possible)
dataVariant[]requiredShow propertiesHide properties
Array of
VariantidUUIDrequiredvariant_namestringrequiredvariant_numberstringrequiredstatusstringrequiredproduct_idUUIDrequiredvariant_group_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullvalidate_stockbooleanpurchase_priceVariantPurchasePrice | nullShow propertiesHide properties
Any of:
VariantPurchasePrice
currencystringrequiredvalue_centsintegerrequirednull
nullvariant_dimensionsProductDimension | nullShow propertiesHide properties
Any of:
ProductDimension
widthintegerheightintegerlengthintegerdepthintegerweightintegerdiameterintegercapacity_milliliterintegernull
nullcustom_fieldsobjectshipping_attributesstring[] | nullwarehouse_stockVariantStock[] | nullShow propertiesHide properties
Array of
VariantStockidUUIDrequiredvariant_idUUIDrequiredwarehouse_idUUIDrequiredwarehouse_namestringwarehouse_slugstringquantityintegerrequiredinventory_datestring<date-time> | nullavailable_onlinebooleancreated_atstring<date-time>updated_atstring<date-time> | nullimagesProductImageRef[] | nullShow propertiesHide properties
Array of
ProductImageRefidUUIDrequiredurlstringtitlestringpriorityintegervideosProductVideoRef[] | nullShow propertiesHide properties
Array of
ProductVideoRefidUUIDrequiredurlstringtitlestringattributesProductAttribute[] | nullShow propertiesHide properties
Array of
ProductAttributeidUUIDrequiredkeystringtemplate_keystringtemplate_namestringnamestringdescriptionstringfilterablebooleantranslatablebooleanvaluesobjectpricesVariantPriceItem[] | nullShow propertiesHide properties
Array of
VariantPriceItemvariant_idUUIDrequiredstore_group_idUUIDrequiredmarket_idUUIDrequiredamount_cents_with_taxinteger<int64>sale_price_cents_with_taxinteger<int64> | nullreference_price_cents_with_taxinteger<int64> | nullon_salebooleanstatusstringAllowed:
activeinactivedraftsale_start_timestampstring<date-time> | nullsale_end_timestampstring<date-time> | nulllistingsVariantListings | nullShow propertiesHide properties
Any of:
VariantListings
smartVariantListing[] | nullShow propertiesHide properties
Array of
VariantListingidUUIDrequiredslugstringrequiredstaticVariantListing[] | nullnull
nulltranslationsVariantTranslations | nullShow propertiesHide properties
Any of:
VariantTranslations
nameTranslation[] | nullShow propertiesHide properties
Array of
TranslationidUUIDlocalestringvaluestringnull
nullcreated_atstring<date-time>requiredupdated_atstring<date-time> | nullerrorsVariantError[]requiredShow propertiesHide properties
Array of
VariantErrorvariant_numberstringproduct_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullidUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullmessagestringrequired400
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required401
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required403
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required500
Request-level failure
errorErrorBodyrequiredShow propertiesHide properties
messagestringrequireddetailsstring[]required