put https://app.ecwid.com/api/v3//classes/
Update the details of a specific product type referring to its ID. If you need to update existing product attributes, refer to their IDs in your request.
If you want to add new product attributes to existing product type, send your new attributes AND all existing attributes for that product type. Otherwise you will reset the existing attributes in that product type.
Access scopes
Requires the following access scope: update_catalog
Request
A JSON object with the following fields:
| Field | Type | Description |
|---|---|---|
| name | string | Product type name. Isn't available to change for 'General' product type |
| attributes | Array<Attribute> | Product type attributes |
Attribute
| Field | Type | Description |
|---|---|---|
| id | number | Attribute internal unique ID (leave empty when adding a new attribute) |
| name | string | Attribute title |
| nameTranslated | <Translations> | Available translations for product attribute name |
| type | string | Attribute type. There are user-defined attributes, general attributes and special 'price per unit' attributes. The 'type' field contains one of the following: CUSTOM, UPC, BRAND, GENDER, AGE_GROUP, COLOR, SIZE, PRICE_PER_UNIT, UNITS_IN_PRODUCT |
| show | string | Defines if an attribute is visible on a product page. Supported values: NOTSHOW, DESCR, PRICE. The value PRICE = DESCR. |
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 types (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, a JSON-formatted body containing error description.
HTTP codes
| HTTP Status | Response JSON | Description |
|---|---|---|
| 400 | Request parameters are malformed | |
| 409 | The type/class with the given name already exists | |
| 415 | Unsupported content-type: expected application/json or text/json | |
| 500 | The request failed because of an error on the server |
Error response body (optional)
| Field | Type | Description |
|---|---|---|
| errorMessage | string | Error message |