Update product lists
Bulk-patches product lists by id. Omitted fields are left unchanged. Static lists hold products and smart lists hold rules; a smart list with rules cannot be converted to static. Successful entities are returned in data; per-item failures in errors.
PATCH
/api/v2/{team_slug}/{app_slug}/product-listsAuthorization
AuthorizationBearer token · headerrequiredManagement API token, sent as Authorization: Bearer <token>.
Path parameters
team_slugstringrequiredapp_slugstringrequiredRequest body
requiredapplication/jsonproduct_listsPatchProductListItem[]requiredmin items 1 · max items 20
Show propertiesHide properties
Array of
PatchProductListItemidUUIDrequiredtitlestringslugstringhtml_descriptionstringmeta_titlestringmeta_descriptionstringstaticbooleanResponses
200
Patched (partial success possible)
dataProductList[]requiredShow propertiesHide properties
Array of
ProductListidUUIDrequiredtitlestringrequiredslugstringrequiredhtml_descriptionstringrequiredstaticbooleanrequiredmeta_titlestring | nullmeta_descriptionstring | nulltranslationsProductListTranslation | nullShow propertiesHide properties
Any of:
ProductListTranslation
titleTranslation[]Show propertiesHide properties
Array of
TranslationidUUIDlocalestringvaluestringslugTranslation[]html_descriptionTranslation[]meta_titleTranslation[]meta_descriptionTranslation[]null
nullrulesProductListRule[]Show propertiesHide properties
Array of
ProductListRuleidUUIDrequiredproduct_list_idUUIDrequiredtargetProductListRuleTargetrequiredAllowed:
stockpricesale_priceis_on_saleattributecategorycollectiontagbrandserieoperatorProductListRuleOperatorrequiredAllowed:
less-thangreater-thanequalnot-equaltarget_idsUUID[]target_stockinteger | nulltarget_price_centsinteger | nullGross cents (amount_cents_with_tax or sale_price_with_tax) for the selected store group and market.
target_is_on_saleboolean | nullstore_group_idUUID | nullPrice scope for price and sale_price targets.
Show propertiesHide properties
Any of:
UUID
UUIDnull
nullmarket_idUUID | nullPrice scope for price and sale_price targets.
Show propertiesHide properties
Any of:
UUID
UUIDnull
nullcreated_atstring<date-time>requiredupdated_atstring<date-time> | nullcreated_atstring<date-time>requiredupdated_atstring<date-time> | nullerrorsProductListError[]requiredShow propertiesHide properties
Array of
ProductListErroridUUID | nullShow propertiesHide properties
Any of:
UUID
string<uuid>null
nullslugstring | 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