Characteristics API
Get All Characteristics
GET /api/v1/manager-core/products/{type}/characteristics
Get all characteristics for a product type.
Query Parameters:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| language | string | Yes | exists:languages,code |
| category | integer/array | No | Filter by category |
| status | integer/array | No | Filter by status |
| block_editor | boolean | No | Filter for block editor |
Parameters:
type(path) - Product type (products, materials)
Get Variant Characteristics
GET /api/v1/manager-core/products/{type}/characteristics/variant
Query Parameters:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| language | string | Yes | exists:languages,code |
Parameters:
type(path) - Product type
Get Characteristic
GET /api/v1/manager-core/products/{type}/characteristics/{id}
Parameters:
type(path) - Product typeid(path) - Characteristic ID
Add Characteristic
POST /api/v1/manager-core/products/{type}/characteristics/add
Parameters:
type(path) - Product type
Request Body:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| name | array | Yes | Object with language codes as keys |
| name.en | string | Yes | string, min:1, unique |
| type | integer | Yes | int |
| schema_type | integer | No | Schema type |
Edit Characteristic
POST /api/v1/manager-core/products/{type}/characteristics/edit
Parameters:
type(path) - Product type
Request Body:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| id | integer | Yes | exists:characteristics_types,id |
| name | array | Yes | Object with language codes as keys |
| description | array | No | Object with language codes as keys |
| type | integer | No | Characteristic type |
| schema_type | integer | No | Schema type |
| required | boolean | No | - |
| show_in_block_editor | boolean | No | - |
Move Characteristic Values
POST /api/v1/manager-core/products/{type}/characteristics/move
Parameters:
type(path) - Product type
Request Body:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| id | integer | Yes | exists:characteristics_types,id |
| items | array | Yes | Ordered array of value IDs |
Add Value
POST /api/v1/manager-core/products/{type}/characteristics/add-value
Parameters:
type(path) - Product type
Request Body:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| id | integer | Yes | exists:characteristics_types,id |
| value | array | Yes | Object with language codes as keys |
| value.en | string | Yes | string, min:1 |
Edit Value
POST /api/v1/manager-core/products/{type}/characteristics/edit-value
Parameters:
type(path) - Product type
Request Body:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| id | integer | Yes | exists:characteristics_values,id |
| value | array | No | Object with language codes as keys |
| custom_1 | string | No | Custom field 1 |
| custom_2 | string | No | Custom field 2 |
Delete Value
POST /api/v1/manager-core/products/{type}/characteristics/delete-value
Parameters:
type(path) - Product type
Request Body:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| id | integer | Yes | exists:characteristics_values,id |
Delete Characteristic
POST /api/v1/manager-core/products/{type}/characteristics/delete
Parameters:
type(path) - Product type
Request Body:
| Parameter | Type | Required | Validation |
|---|---|---|---|
| id | integer | Yes | exists:characteristics_types,id |