put https://app.ecwid.com/api/v3//categories/
Update an existing category in an Ecwid store referring to its ID.
Access scopes
Requires the following access scope: update_catalog
Request
A JSON object with the following fields:
Field | Type | Description |
---|---|---|
name | string | Category name |
nameTranslated | <Translations> | Available translations for category name |
customSlug | string | A custom slug set for the category URL. |
parentId | number | ID of the parent category |
orderBy | number | Sort order of the category in the parent category subcategories list with a step of 10, e.g. 10 , 20 , 30 , etc. |
description | string | The category description in HTML |
descriptionTranslated | <Translations> | Available translations for category description |
enabled | boolean | true to make category enabled, false to disable it. true is default |
productIds | Array<number> | IDs of the products to assign to the category |
Translations
Field | Type | Description |
---|---|---|
<ISO_LANG_CODE> | string | Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings |
Response
A JSON object of type 'UpdateStatus' with the following fields:
UpdateStatus
Field | Type | Description |
---|---|---|
updateCount | number | The number of updated categories (1 or 0 depending on whether the update was successful) |
Errors
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
HTTP codes
HTTP Status | Meaning |
---|---|
400 | Malformed request parameters |
400 | Category name must not be empty |
404 | The parent category or one of the assigned products is not found |
409 | There was a conflict modifying the store (updating a category while it's being edited elsewhere). Retry later. |
415 | Unsupported content-type: expected application/json or text/json |
449 | Store catalog cannot be modified at the moment because import is in progress. Retry later. |
500 | Server error |