Документация API для управления группами товаров (версия 2). Данный API позволяет создавать и массово обновлять группы товаров, а также управлять их настройками отображения спецификаций.
Таблица с описанием полей
Основной объект (ProductGroup)
| Поле | Тип | Обязательное? | Описание |
|---|---|---|---|
id| int |
Нет | Уникальный идентификатор группы товаров. Обязателен для обновления конкретной записи по ID. | |
code| string |
Нет | Текстовый код группы. Должен быть уникальным в рамках сайта. Используется для поиска при создании/обновлении, если не передан id. |
|
name| string |
Да | Название группы товаров. | |
group_specifications| array[object] |
Нет | Список настроек для характеристик (спецификаций), связанных с этой группой. |
Объект спецификации группы (внутри group_specifications)
| Поле | Тип | Обязательное? | Описание |
|---|---|---|---|
specification_id| int |
Да | ID характеристики, которую нужно привязать или настроить. | |
order| int |
Нет | Порядок отображения характеристики (сортировка). По умолчанию: 0. | |
display_type| string |
Нет | Тип отображения характеристики. Возможные значения: |
- selects (выпадающий список)
- media_params (медиа параметры)
- blocks (блоки)
- multi_select (множественный выбор)
additional_info| array[string]| Нет| Дополнительные параметры для отобрадения на странице товара
Возможные значения:
- price (В вариантах отображения будет цена)
- quantity (В вариантах отображения будет кол-во)
- description (В вариантах отображения будет описание товара)- image (В вариантах отображения будет картинки товара)
show_in| array[string]| Нет| Места отображения характеристики -
- small_cart (Маленькая карточка товара)
- page_block (Блоком на странцие товара)
- page_button (Попап на странице товара)
Эндпоинты
1. Получение всех групп товаров
Описание: Возвращает список всех групп товаров для текущего сайта.
Эндпоинт:
[GET] /external/v2/product-group/
Ответ: Массив объектов групп товаров.
2. Массовое создание и обновление
Описание: Создает новые группы или обновляет существующие.
- Если передан
id, происходит поиск и обновление по ID. - Если
idнет, но переданcode, происходит поиск и обновление по коду. - Если совпадений нет — создается новая группа.
- Вложенные данные
group_specificationsтакже обновляются (добавляются отсутствующие связи, обновляются существующие, удаляются лишние, если их нет в запросе). Эндпоинт:
[POST] /external/v2/product-group/bulk-create/
Пример тела запроса (JSON):
[ { "code": "phones", "name": "Смартфоны", "groupspecifications": [ { "specificationid": 105, "order": 1, "displaytype": "selects", "showin": ["smallcart", "pageblock"] }, { "specificationid": 106, "order": 2, "displaytype": "blocks" } ] }, { "id": 450, "name": "Ноутбуки (Updated)", "group_specifications": [] } ]
Ответ: Возвращает массив созданных или обновленных объектов.
- Статус:
201 Created
- Статус:
Была ли статья полезна?
Да, спасибо! К сожалению, нет