Документация API для работы с группами товаров
Таблица с описанием полей
| Поле | Тип | Обязательное? | Описание |
|---|---|---|---|
id| int |
Нет | Уникальный идентификатор группы (обязателен при обновлении). | |
code| string |
Нет | Код группы (опционально). | |
name| string |
Да | Название группы. | |
select_specifications| array[int] |
Нет | Список ID характеристик, доступных для выбора (селект). | |
block_specifications| array[int] |
Нет | Список ID характеристик, доступных для выбора (блоки). | |
images_specifications| array[int] |
Нет | Список ID характеристик, связанных с изображениями. | |
multi_select_specifications| array[int] |
Нет | Список ID характеристик, связанных с изображениями. |
Базовый URL : /external/product-group/
Этот API предназначен для управления группами товаров. Ниже описаны доступные эндпоинты и их функционал:
Эндпоинты
1. Получение всех групп товаров
Описание : Возвращает список всех групп товаров.
Эндпоинт :
[GET] /external/product-group/
Ответ : Возвращает массив объектов групп товаров:
[ { "id": 421, "code": null, "name": "testingparameterlink", "specifications": [ { "id": 347, "order": 0, "displaytype": "selects", "spkey": "test1", "namero": "test1", "nameru": "test1", "nameen": null, "nameuk": "" }, { "id": 344, "order": 0, "displaytype": "selects", "spkey": "производитель", "namero": "ROПроизводитель", "nameru": "RUПроизводитель", "nameen": "ENПроизводитель", "nameuk": null }, { "id": 396, "order": 0, "displaytype": "selects", "spkey": "caracteristicanoua", "namero": "Caracteristica noua", "nameru": "Характеристика new", "nameen": null, "nameuk": null } ] } ]
Поля :
id(int) : Уникальный идентификатор группы.code(string | null) : Код группы (опционально).name(string) : Название группы.select_specifications(array[int]) : ID характеристик, доступных для выбора (select).
block_specifications(array[int]) : ID характеристик, доступных для выбора(blocks).images_specifications(array[int]) : ID характеристик, связанных с изображениями.multi_select_specifications(array[int]) : ID характеристик, связанных с изображениями.
2. Получение одной группы товаров
Описание : Возвращает детальную информацию об одной группе товаров.
Эндпоинт :
[GET] /external/product-group/{service_id}/
URL параметр :
service_id: ID группы товара для извлечения.
Ответ :
{ "id": 421, "code": null, "name": "testingparameterlink", "specifications": [ { "id": 347, "order": 0, "displaytype": "selects", "spkey": "test1", "namero": "test1", "nameru": "test1", "nameen": null, "nameuk": "" }, { "id": 344, "order": 0, "displaytype": "selects", "spkey": "производитель", "namero": "ROПроизводитель", "nameru": "RUПроизводитель", "nameen": "ENПроизводитель", "nameuk": null }, { "id": 396, "order": 0, "displaytype": "selects", "spkey": "caracteristicanoua", "namero": "Caracteristica noua", "nameru": "Характеристика new", "nameen": null, "nameuk": null } ] }
Примечания : Возвращает те же поля, что и Получение всех групп товаров, но для конкретной группы.
3. Массовое обновление групп товаров
Описание : Обновляет несколько групп товаров в одном запросе.
Эндпоинт :
[PUT] /external/product-group/bulk-update/
Формат запроса :
[ { "id": 134, "code": "newcode", "name": "New Test Name", "selectspecifications": [42, 43, 44], "imagesspecifications": [45, 46], "multiselectspecifications": [45, 46], }, { "id": 135, "code": "anothercode", "name": "Another Name", "selectspecifications": [], "imagesspecifications": [] } ]
Формат ответа : Возвращает массив обновленных групп товаров:
[ { "id": 134, "code": "newcode", "name": "New Test Name", "selectspecifications": [42, 43, 44], "imagesspecifications": [45, 46], "multiselectspecifications": [45, 46], }, { "id": 135, "code": "anothercode", "name": "Another Name", "selectspecifications": [], "imagesspecifications": [] } ]
Примечания :
- Все поля являются опциональными. Укажите только те данные, которые нужно обновить.
- Каждый объект в массиве запроса соответствует одному объекту для обновления.
4. Массовое создание групп товаров
Описание : Создает несколько групп товаров за один запрос.
Эндпоинт :
[POST] /external/product-group/bulk-create/
Формат запроса :
[ { "code": "groupcode1", "name": "Group 1", "selectspecifications": [42, 43], "imagesspecifications": [45, 46], "multiselectspecifications": [45, 46], }, { "code": "groupcode2", "name": "Group 2", "selectspecifications": [], "imagesspecifications": [], "multiselectspecifications": [], } ]
Формат ответа : Возвращает массив созданных групп:
[ { "id": 136, "code": "groupcode1", "name": "Group 1", "selectspecifications": [42, 43], "imagesspecifications": [45, 46] }, { "id": 137, "code": "groupcode2", "name": "Group 2", "selectspecifications": [], "imagesspecifications": [] } ]
Примечания :
- Новые группы получают уникальные ID, которые возвращаются в ответе.
- Все поля, указанные в запросе, должны быть заполнены для каждой создаваемой группы.
Была ли статья полезна?
Да, спасибо! К сожалению, нет