Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
GET attributes/
| Info | ||
|---|---|---|
| ||
Получение всех атрибутов доступных для учетной записи. |
Список параметров:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| group | int | идентификатор группы типов данных | нет |
| type | int | идентификатор типа данных | нет |
| name | string | название типа данных | нет |
| is_SKU | boolean | только тип данных, который является идентификатором SKU | нет |
| is_PN | boolean | только тип данных, который является идентификатором Product Name | нет |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
curl -XGET "[endpoint]/attributes/?page_size=2" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"count": 111,
"next": "http://[your_domain].brandquad.ru/api/public_v2/attributes/?page=2&page_size=2",
"previous": null,
"results": [
{
"id": 118,
"name": "Attribute 118",
"type": 7,
"group": null,
"position_in_group": null,
"is_SKU": false,
"is_PN": false
},
{
"id": 119,
"name": "Attribute 119",
"type": 6,
"group": null,
"position_in_group": null,
"is_SKU": false,
"is_PN": false
}
]
}
|
POST attributes/
| Info | ||
|---|---|---|
| ||
Добавление нового атрибута |
Список параметров:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| type | int | идентификатор типа данных | да |
| name | string | название атрибута | да |
| group | int | идентификатор группы атрибутов | нет |
| position_in_group | int | позиция в группе | нет |
is_SKU | boolean | является ли идентификатором SKU, по умолчанию false | нет |
| is_PN | boolean | является ли идентификатором Product Name, по умолчанию false | нет |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
curl -XPOST "[endpoint]/attributes/" -d '{"name": "New attribute", "type": 107}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" -H "Content-Type: application/json" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"id": 200,
"name": "New attribute",
"type": 107,
"group": null,
"position_in_group": null,
"is_SKU": false,
"is_PN": false
}
|
GET attributes/[id]/
| Info | ||
|---|---|---|
| ||
Получение атрибута с указанным id |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
curl -XGET "[endpoint]/attributes/200201/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"id": 200201,
"name": "ref list attribute",
"type": 10,
"group": null,
"position_in_group": null,
"is_SKU": false,
"is_PN": false,
"values": [
{
"id": 1,
"value": "first value"
},
{
"id": 2,
"value": "second value"
}
]
}
|
PATCH attributes/[id]/
| Info | ||
|---|---|---|
| ||
Изменение атрибута |
Список параметров:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| group | int | идентификатор группы типов данных | нет |
| position_in_group | int | позиция в группе | нет |
| is_PN | boolean | является ли идентификатором Product Name, по умолчанию false | нет |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
curl -XPATCH "[endpoint]/attributes/200/" -d '{"type": 6, "group": 1, "position_in_group": 2}' --H "TOKEN: [your_token]" -H "APPID: [your_account_name]" -H "Content-Type: application/json" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"id": 200,
"name": "New attribute",
"type": 6,
"group": 1,
"position_in_group": 2,
"is_SKU": false,
"is_PN": false
}
|
OPTIONS attributes/
| Info | ||
|---|---|---|
| ||
Получение данных необходимых для создания валидного атрибута |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
curl -XOPTIONS "[endpoint]/attributes/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"name": "Attributes List",
"description": "Обрабатывает атрибуты",
"renders": [
"application/json",
"text/html"
],
"parses": [
"application/json",
"application/x-www-form-urlencoded",
"multipart/form-data"
],
"actions": {
"POST": {
"id": {
"type": "integer",
"required": false,
"read_only": true,
"label": "ID"
},
"name": {
"type": "string",
"required": true,
"read_only": false,
"label": "Название атрибута",
"max_length": 300
},
"type": {
"type": "choice",
"required": true,
"read_only": false,
"label": "Тип данных",
"choices": [
{
"value": 1,
"display_name": "String"
},
{
"value": 2,
"display_name": "Pickle"
},
{
"value": 3,
"display_name": "Rich Text"
},
{
"value": 4,
"display_name": "Link"
},
{
"value": 5,
"display_name": "Html"
},
{
"value": 6,
"display_name": "Digital Asset"
},
{
"value": 7,
"display_name": "YES / NO"
},
{
"value": 8,
"display_name": "Float"
},
{
"value": 9,
"display_name": "Date"
},
{
"value": 10,
"display_name": "RefList"
},
{
"value": 11,
"display_name": "Proxy"
}
]
},
"group": {
"type": "field",
"required": false,
"read_only": false,
"label": "Группа"
},
"position_in_group": {
"type": "integer",
"required": false,
"read_only": false,
"label": "Позиция в группе",
"min_value": -2147483648,
"max_value": 2147483647
},
"is_SKU": {
"type": "boolean",
"required": false,
"read_only": false,
"label": "Is SKU"
},
"is_PN": {
"type": "boolean",
"required": false,
"read_only": false,
"label": "Is PN"
}
}
}
}
|
GET attributes/types/
| Info | ||
|---|---|---|
| ||
Получение словаря типов данных |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
curl -XGET "[endpoint]/attributes/types/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
[
{
"id": 1,
"name": "String"
},
{
"id": 2,
"name": "Pickle"
},
{
"id": 3,
"name": "Rich Text"
},
{
"id": 4,
"name": "Link"
},
{
"id": 5,
"name": "Html"
},
{
"id": 6,
"name": "Digital Asset"
},
{
"id": 7,
"name": "YES / NO"
},
{
"id": 8,
"name": "Float"
},
{
"id": 9,
"name": "Date"
},
{
"id": 10,
"name": "RefList"
},
{
"id": 11,
"name": "Proxy"
}
]
|
GET attributes/groups/
| Info | ||
|---|---|---|
| ||
Получение списка групп |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
сurl -XGET "[endpoint]/attributes/groups/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 1,
"name": "group 1",
"position": 2
},
{
"id": 2,
"name": "group 2",
"position": 1
}
]
}
|
POST attributes/groups/
| Info | ||
|---|---|---|
| ||
создание группы |
Список параметров:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| name | string | имя новой группы | да |
| position | int | позиция группы, по умолчанию 1 | нет |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
сurl -XPOST "[endpoint]/attributes/groups/" -d '{"name": "New group"}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" -H "Content-Type: application/json" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"id": 3,
"name": "New group",
"position": 1
} |
GET attributes/groups/[id]/
| Info | ||
|---|---|---|
| ||
Получение группы |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
сurl -XGET "[endpoint]/attributes/groups/3/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"id": 3,
"name": "New group",
"position": 1
} |
PATCH attributes/groups/[id]/
| Info | ||
|---|---|---|
| ||
Изменение группы |
Список параметров:
| Параметр | Тип | Описание | Обязательный |
|---|---|---|---|
| name | string | новое имя группы | нет |
| position | int | позиция в группе | нет |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
сurl -XPATCH "[endpoint]/attributes/groups/3/" -d '{"name": "New name", "position": 2}' -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" -H "Content-Type: application/json" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"id": 3,
"name": "New name",
"position": 2
} |
DELETE attributes/groups/[id]/
| Info | ||
|---|---|---|
| ||
Удаление группы |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
сurl -XDELETE "[endpoint]/attributes/groups/3/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
OPTIONS attributes/groups/
| Info | ||
|---|---|---|
| ||
Получение данных необходимых для создания валидной группы |
Пример запроса
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
сurl -XOPTIONS "[endpoint]/attributes/groups/" -H "TOKEN: [your_token]" -H "APPID: [your_account_name]" |
Ответ:
| Paste code macro | ||||
|---|---|---|---|---|
| ||||
{
"name": "Groups List",
"description": "Обрабатывает группы атрибутов",
"renders": [
"application/json",
"text/html"
],
"parses": [
"application/json",
"application/x-www-form-urlencoded",
"multipart/form-data"
],
"actions": {
"POST": {
"id": {
"type": "integer",
"required": false,
"read_only": true,
"label": "ID"
},
"name": {
"type": "string",
"required": true,
"read_only": false,
"label": "Название группы",
"max_length": 200
},
"position": {
"type": "integer",
"required": false,
"read_only": false,
"label": "Позиция",
"min_value": -2147483648,
"max_value": 2147483647
}
}
}
} |
| Table of Contents | ||
|---|---|---|
|