Продукты
GET products/
Список параметров
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
fields | list<int> | список идентификаторов тех атрибутов, которые должны присутствовать в ответе | нет |
with_meta | booelan | отдавать или нет блок meta, по умолчанию true | нет |
with_attributes | boolean | отдавать или нет блок attributes, по умолчанию true | нет |
with_assets | boolean | отдавать или нет блок assets, по умолчанию true | нет |
with_categories | boolean | отдавать или нет блок categories, по умолчанию true | нет |
with_relations | boolean | отдавать или нет блок relations, по умолчанию true | нет |
use_attributes_id | boolean | использовать как идентификаторы атрибутов id вместо имен | нет |
category_ids | list<int> | список идентификаторов категорий, по который будет производиться поиск товаров | нет |
catalog_ids | list<int> | список идентификаторов каталогов, по которым будет производиться поиск товаров | нет |
relation_ids | list<int> | список идентификаторов категорий связанных товаров, по которым будет производиться поиск товаров | нет |
filters | list<string> | список фильтров | нет |
last_ts | int | получить товары, у которых значение timestamp больше чем last_ts | нет |
Структура поля filters
Список полей filters
Поле | Описание | Особые условия |
---|---|---|
type | указатель на название типа, по которому будет производиться поиск | для поиска по категориям указывать __category, для поиска по |
exp | логическое условие, которое будет выполняться | для __category приемлемым будут только условия equal , in , notequal |
val | искомое значение | не передается, если exp равно has_no_value или has_any_value |
Список значений поля exp
Значение | Описание |
---|---|
in | значение равно |
notin | значение не равно |
in_list | значение содержится в списке |
has_no_value | значения отсутствуют вообще |
has_any_value | есть любое значение |
term | значение содержит |
not_term | значение не содержит |
count | количество |
Пример запроса
Ответ:
Пример запроса
Ответ:
Пример запроса
Ответ:
POST products/
Список параметров:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
data | string | строка с данными в формате json | да |
rewrite | boolean | если задан True, то товар с этим sku будет перезаписан | нет |
use_attributes_id | boolean | использовать как идентификаторы атрибутов id вместо имен | нет |
Пример запроса
Ответ:
Пример запроса
Ответ:
PATCH products/[sku]/
Изменяет продукт
Список параметров:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
data | string | строка с данными в формате json | да |
use_attributes_id | boolean | использовать как идентификаторы атрибутов id вместо имен | нет |
Пример запроса
Ответ:
DELETE products/[sku]/
Удаляет продукт с этим sku
Пример запроса
OPTIONS products/
Отображает, какие поля необходимы для создания валидного продукта
Пример запроса
Ответ:
Наименование поля | Описание поля |
---|---|
data | Содержит в качестве ключей наименования доступных для редактирования атрибутов |
type | Содержит идентификатор типа атрибута |
required | Содержит информацию, обязателен ли данный атрибут для сохранения продукта |
read_only | Содержит информацию можно ли перезаписывать значения данного атрибута |
id | Содержит идентификатор атрибута |
label | Содержит информацию, каким должно быть значение атрибута, чтобы после создания товара к нему был доступ. Требования этого поля обязательны. |
GET products/[sku]/categories/
Пример запроса
Ответ:
POST products/[sku]/categories/
Список параметров:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
category | int | идентификатор категории к которой будет привязан продукт | да |
Пример запроса
Ответ:
DELETE products/[sku]/categories/[id]/
Пример запроса
OPTIONS products/[sku]/categories/
Ответ:
GET products/[sku]/assets/
Пример запроса
Ответ:
POST products/[sku]/assets/
Список параметров:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
attribute | int | идентификатор атрибута по которому произойдет связь | да |
dam | int | идентификатор файла с которым будет продукт | да |
Пример запроса
Ответ:
DELETE products/[sku]/assets/[id]/
Пример запроса
OPTIONS products/[sku]/assets/
Пример запроса
Ответ:
GET products/[sku]/relations/
Пример запроса
Ответ:
POST products/[sku]/relations/
Список параметров:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
title | string | Название новой группы связанных товаров | да |
filters | list<dict> | Список фильтров по которым будут определены связанные товары | да |
Параметры, передаваемые для каждого фильтра:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
id | int | Id аттрибута, по которому будет производится поиск | да |
type | string | Указатель на название типа, по которому будет производиться поиск. Для поиска по категориям указывать | да |
exp | string | Логическое условие, которое будет выполняться | да |
val | list | Искомое значение | да |
name | string | Имя атрибута, по которому будет произведен поиск | да |
Примеры val при различных exp:
exp | Тип val | Пример передачи val |
---|---|---|
in | list<string> | "val": ["value1", "value2"] |
notin | list<string> | "val": ["value1", "value2"] |
in_list | list<string> | "val": ["value1", "value2"] |
has_no_value | пустой list | "val": [] |
has_any_value | пустой list | "val": [] |
term | list<string> | "val": ["value"] |
not_term | list<string> | "val": ["value"] |
count | list<int> | "val": [value1, value2] |
Пример запроса
Ответ:
DELETE products/[sku]/relations/[id]/
Удаление связи
Пример запроса
OPTIONS products/[sku]/relations/
Пример запроса
Ответ:
GET products/[sku]/set/
Пример запроса
Ответ:
POST products/[set_sku]/set/
Список параметров:
Параметр | Тип | Описание | Обязательный |
---|---|---|---|
sku | string | идентификатор продукта который необходимо добавить в набор | да |
Пример запроса
Ответ:
DELETE products/[set_sku]/set/[sku]/
Пример запроса
OPTIONS products/[sku]/set/
Пример запроса
Ответ:
Brandquad Public API v2.x
Продукт вместо набора.