Запрос возвращает информацию о блюдах по действующему меню.
Структура запроса
Метод запроса: GET
Адрес запроса: https://api.sbis.ru/retail/nomenclature/list?
Параметр | Тип | Описание |
| pointId * | integer | Идентификатор точки продаж, который вернулся в результате запроса «Получить точку продаж» |
| priceListId * | integer | Идентификатор прайс-листа, который вернулся в результате запроса «Получить прайс-лист» |
| noStopList | boolean | Признак исключения позиций, которые есть в стоп-листе |
| onlyPublished | boolean | Признак возврата в ответе только опубликованных позиций. Если параметр не передавать, возвращаются все позиции |
| withBalance | boolean | Признак передачи остатков. Если «true», то остатки передаются в ответе |
| withBarcode | boolean | Признак передачи штрихкодов товара. Если «true», то штрихкоды передаются в ответе |
| search | string | Поиск по названию или части названия товара |
| page | integer | Номер страницы |
| pageSize | integer | Количество записей на странице |
Структура ответа
Параметр | Тип | Описание | |
| attributes | array{...} | Массив списков с характеристиками товара | |
| balance | string | Остаток товара с учетом открытых смен. Остаток передается по складу точки продаж | |
| barcodes | array{...} | Массив штрихкодов | |
| code | string | Штрихкод |
| codeType | string | Тип штрихкода (EAN-13, EAN-8) | |
| description | string | Поле «Описание» из карточки товара | |
| externalId | string | Хешированное название товарной позиции для запроса подробной информации | |
| hierarchicalId | integer | Идентификатор раздела | |
| hierarchicalParent | integer | Идентификатор родительского раздела | |
| id | integer | Идентификатор товара | |
| images | array[string] | Массив ссылок на изображение товара | |
| indexNumber | integer | Порядковый номер в каталоге | |
| modifiers | array[{...}] | Массив списков модификаторов | |
| id | integer | Идентификатор товарной позиции |
| name | string | Название модификатора или группы модификаторов | |
| cost | number | Цена модификатора | |
| baseCount | integer | Количество порций модификатора в базовой единице измерения, которое добавлено в блюдо | |
| сount | number | Количество модификатора | |
| maxCount | number | Максимальное количество модификатора, которое можно выбрать. Распространяется на все позиции, связанные с родителем, у которого оно заполнено | |
| minCount | number | Минимальное количество модификатора, которое нужно выбрать. Распространяется на все позиции, связанные с родителем, у которого оно заполнено | |
| parentType | integer | Тип родителя/папки. Возможные значения: «ModifierService» — служебные модификаторы, «Modifier» — простые модификаторы, «ModifierRequired» — обязательные модификаторы | |
| hierarchicalParent | integer | Идентификатор родителя в иерархии | |
| hierarchicalId | integer | Идентификатор в иерархии | |
| isParent | boolean | Признак, является ли идентификатор родителем в иерархии | |
| images | array{} | Cсылка для получения изображения через запрос «https://api.sbis.ru/retail/img» | |
| description | string | Описание товара | |
| nomNumber | string | Код номенклатуры в каталоге СБИС | |
| type | string | Тип модификатора. Возможные значения: «Single» — одиночный модификатор, «Set» — набор модификаторов, «Note» — заметка | |
| name | string | Название товара | |
| nomNumber | string | Код товара, указанный в карточке этого товара | |
| published | boolean | Признак публикации товарной позиции | |
| unit | string | Единица измерения | |
| outcome | boolean | Признак наличия записей на следующих страницах | |
С помощью API-запросов вы можете получить дополнительную информацию.
- Получить изображение товара:
- метод: GET
- запрос: https://api.sbis.ru/retail/{img?param=...}, где {img?param=...} — значение параметра «images» из вернувшихся данных товара.
- Получить список «С этим товаром покупают»:
- метод: GET
- запрос: https://api.sbis.ru/retail/nomenclature/{IdNom}, где {IdNom} — идентификатор товара.
- Получить список позиций, находящихся в стоп-листе:
- метод: GET
- запрос: https://api.sbis.ru/retail/nomenclature/stop-list.
Структура запроса
Параметр
Тип
Описание
pointId integer
Идентификатор точки продаж page integer
Номер страницы pageSize integer
Количество записей на странице Структура ответа
Параметр
Тип
Описание
balance integer
Оставшееся количество товара, доступного для продажи count integer
Начальное количество externalId string
Хешированное название товарной позиции для запроса подробной информации id integer
Идентификатор товара images array[string]
Массив ссылок на изображение товара name string
Название блюда nomNumber string
Код товара, указанный в карточке товара period integer
Количество часов, которое блюдо будет находиться в стоп-листе reason string
Причина нахождения в стоп-листе stopListId integer
Идентификатор стоп-листа outcome boolean
Признак наличия записей на следующих страницах
Примеры
Запрос списка блюд
В формате *.php
В формате *.php
В формате *.py
В формате *.py
В качестве примера используется функция «cURL».
В качестве примера используется библиотека «Requests».
Ответ на запрос списка блюд
Запрос списка позиций, находящихся в стоп-листе
Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.