post https://app.ecwid.com/api/v3//classes
Create a new product type in an Ecwid store.
Access scopes
Requires the following access scope: create_catalog
Request body
A JSON object with the following fields:
Field | Type | Description |
---|---|---|
name | string | Product type name. Ecwid will try to find a Google taxonomy that matches the name you submit here. If it finds, the taxonomy will be assigned to the new type. |
attributes | Array<Attribute> | Product type attributes |
Attribute
Field | Type | Description |
---|---|---|
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 . |
Response
A JSON object of type 'CreateStatus' with the following fields:
CreateStatus
Field | Type | Description |
---|---|---|
id | number | The internal ID of the just created product type |
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 |