Update products
Bulk-patches products by id. Successful entities are returned in data; per-item failures in errors.
PATCH
/api/v2/{team_slug}/{app_slug}/productsAuthorization
AuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
Path parameters
team_slugstringrequiredapp_slugstringrequiredRequest body
requiredapplication/jsonproductsPatchProductItem[]requiredmin items 1 · max items 20
Show propertiesHide properties
Array of
PatchProductItemidUUIDrequiredproduct_namestringproduct_numberstringslugstringstatusstringAllowed:
activedraftinactivearchivedmeta_titlestringmeta_descriptionstringhtml_descriptionstringhtml_short_descriptionstringtax_group_idUUIDproduct_dimensionsProductDimensionShow propertiesHide properties
widthintegerheightintegerlengthintegerdepthintegerweightintegerdiameterintegercapacity_milliliterintegerpackage_dimensionsProductDimensionShow propertiesHide properties
widthintegerheightintegerlengthintegerdepthintegerweightintegerdiameterintegercapacity_milliliterintegerbrand_idUUIDcustom_fieldsobjectexclude_from_feedsbooleanproduct_typestringAllowed:
simpleflexiblemarket_statusProductMarketStatus[]Show propertiesHide properties
Array of
ProductMarketStatusmarket_idUUIDrequiredstore_group_idUUIDrequiredmarket_slugstringstore_group_slugstringstatusstringrequiredAllowed:
activeinactivedraftincompletearchivedResponses
200
Patched (partial success possible)
dataProductWrite[]requiredShow propertiesHide properties
Array of
ProductWriteidUUIDrequiredproduct_namestringrequiredproduct_numberstringrequiredslugstringstatusstringrequiredmeta_titlestringmeta_descriptionstringhtml_descriptionstringhtml_short_descriptionstringdescriptionstringshort_descriptionstringtax_group_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullbrand_idUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullproduct_typestringexclude_from_feedsbooleanproduct_dimensionsProductDimension | nullShow propertiesHide properties
Any of:
ProductDimension
widthintegerheightintegerlengthintegerdepthintegerweightintegerdiameterintegercapacity_milliliterintegernull
nullpackage_dimensionsProductDimension | nullShow propertiesHide properties
Any of:
ProductDimension
widthintegerheightintegerlengthintegerdepthintegerweightintegerdiameterintegercapacity_milliliterintegernull
nullcustom_fieldsobject | nullmarket_statusProductWriteMarketStatus[] | nullShow propertiesHide properties
Array of
ProductWriteMarketStatusmarketProductNamedRefrequiredShow propertiesHide properties
idUUIDrequirednamestringrequiredslugstringrequiredstore_groupProductNamedRefrequiredstatusstringrequiredAllowed:
activeinactivedraftincompletearchivedchannel_statusesProductChannelStatus[] | nullShow propertiesHide properties
Array of
ProductChannelStatuschannel_idUUIDrequiredchannel_slugstringstatusstringrequiredcreated_atstring<date-time>requiredupdated_atstring<date-time> | nullerrorsProductError[]requiredShow propertiesHide properties
Array of
ProductErrorproduct_numberstringidUUID | 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