iikoBizApi
iikoCardApi располагается по адресу:
Внимание! С 1 июля 2022 года мы прекратим предоставлять API iiko.biz для создания новых интеграций с iiko. Все будущие интеграции с внешними системами доставки будут создаваться на базе iiko Cloud API. При этом до конца 2022 года мы будем продолжать поддержку уже реализованных интеграционных решений в рамках существующих лицензионных контрактов. |
Получить маркер доступа апи логина
Проверить возможность создания заказа
Проверить осуществимость доставки по указанному адресу
Список доставок в указанном интервале времени
История заказов клиента по идентификатору
История доставочных заказов по номеру телефона
История доставочных заказов по идентификатору клиента
Оставить отзыв клиента доставки
Отметить заказ доставленным или недоставленным.
Получить картинку (изображение продукта)
Получение списка городов и их улиц
Получение списка городов организации
Получение списка улиц города заданной организации
Получение списка протоколов заданной организции
Получение списка ролей организации
Получение списка сотрудников организации
Получение списка залов организации
Получение списка допустимых типов заказов
Получить список маркетинговых источников
Получить список курьеров организации
Получить стоп-лист по сети ресторанов
Запрос логина курьера доставки на удаленный РМС сервер
Запрос полной синхронизации мобильного приложения и сервера доставок
Получить список скидок, доступных для применения в доставке для заданного ресторана
Вернуть список доставочных ресторанов, подключённых к данному ресторану
Вернуть список ограничений работы ресторана/сети ресторанов
Вернуть вопросы для отзыва клиента о сделанной доставке
Вернуть настройки для мобильного приложения курьерской доставки для данного ресторана
Получить информацию о колонках олап-отчета
Получить виды преднастроенных олап-отчетов
Получить преднастроенный олап-отчет
Получить мета информацию журнала событий (описание возвращаемых данных)
Получить информацию о кассовых сменах
CustomersDeliveryHistoryResponse
Типы, используемые мобильным приложением курьера iikoDeliveryMan
MobileDeliveryOrderItemModifierDto
DeliveryCourierMobileSettingsResponse
Дата изменения | Краткое описание изменения | Версия iikoRMS/iikoBiz | Автор изменений |
03.02.2015 | Добавление ресторана в информацию о заказе | 4.1 / 0 | Лемберский Алексей |
21.05.2015 | Добавление поля additionalInfo в информацию о городе (City) | 4.2 / 6 | Белесев Сергей |
01.06.2015 | Добавление возможности получения преднастроенных олапов из RMS заданной организации (Получить виды преднастроенных олап-отчетов и | 4.2 / 6 | Фоменко Степан |
11.06.2015 | Добавление поля externalRevision (номер ревизии из РМС) для следующих выгружаемых сущностей: PaymentType, Courier, Role, OrderType, Employee, RestaurantSection, MarketingSource, DeliveryTerminal, City, Street, Region. | 4.2 / 7 | Лемберский Алексей |
08.08.2015 | Возможность применять скидки при создании доставки через API. Изменения: 1) Добавление метода получения информации о скидках Получить список скидок, доступных для применения в доставке для заданного ресторана. 2) Добавление полей discountCardSlip и discountCardTypeId в объект Order. | 4.3/11 | Фоменко Степан |
15.09.2015 | Добавлено поле measureUnit (единица измерения) в сущность Product. | 4.3 / 12 | Рожнов Леонид |
24.09.2015 | Добавлено поле technicalInformation в сущность DeliveryTerminal | 4.3 / 13 | Рожнов Леонид |
29.09.2015 | Добавлено поле doNotPrintInCheque в сущность Product | 4.3 / 13 | Рожнов Леонид |
06.10.2015 | Добавлены поля SeoDescription, SeoText, SeoKeywords, SeoTitle в сущности Product и Group | 5.0 / 14 | Рожнов Леонид |
21.10.2015 | Добавлены методы Получить все заказы курьера, Отметить заказ доставленным или недоставленным, Добавить проблему к заказу для интеграции с внешними курьерскими службами, и связанные с ними сущности | 4.3.2 / 15 | Рожнов Леонид |
06.11.2015 | Добавлены методы для работы с журналом событий | 5 / | Калошин Денис |
10.11.2015 | Внес информацию о полях с ценами товаров, различающихся на разных терминалах (см. Product) | 4.3 / 14 | Рожнов Леонид |
26.11.2015 | Добавил поле updateFrequency в настройки мобильного приложения | 4.4 / 16 | Рожнов Леонид |
08.12.2015 | Зафиксировал формат строки в дате выгрузки изображения номенклатуры. Внимание: это ломает совместимость для клиентов API с зафиксированным форматом даты, если он отличается от указанного. | 17 | Белесев Сергей |
04.02.2016 | Добавление в документацию информации о методах Получить список маркетинговых акций, сработавших в заказе и Получить данные гостя по номеру его телефона | 19 | Фоменко Степан |
19.02.2016 | Добавлена информация по работе с уведомлениями - Уведомления | Калошин Денис | |
01.03.2016 | Добавлен метод Получить список программ корпоративного питания для организации | 21 | Фоменко Степан |
24.03.2016 | Добавлен методы:
Изменен ответ метода: Добавлены новые поля в объекты: | 22 | Фоменко Степан |
27.04.2016 | Добавлено поле externalCartographyId в адрес доставки | 23 | Рожнов Леонид |
27.04.2016 | Добавлено поле currencyIsoName в объект OrganizationInfo | 23 | Фоменко Степан |
15.06.2016 | Добавлен метод Получить отчет по заказам программы корпоративного питания за период | 25 | Фоменко Степан |
24.06.2016 | В DeliveryOrderDto добавлено поле orderLocationInfo, содержащее информацию об координатах доставочного заказа | 25 | Фоменко Степан |
20.07.2016 | Добавлен метод Получить отчет по транзакциям гостей организации за период | 27 | Фоменко Степан |
16.09.2016 | Добавлен метод Включения гостя в программу корпоративного питания | 29 | Семенов Антон |
31.10.2016 | Добавлен метод История доставочных заказов по идентификатору клиента | 30 | Семенов Антон |
14.11.2016 | Добавлен тип программы в кошелек | 31 | Семенов Антон |
21.11.2016 | В OrganizationGuestInfo добавлено поле iikoCardOrdersSum. | 31 | Фоменко Степан |
14.12.2016 | Добавил в описание сущности адреса информацию о индексе | 32 | Рожнов Леонид |
15.12.2016 | Новый метод - Расчет программы лояльности. Добавлена возможность указать в OrderRequest применяемые купоны, ручные действия и оплатные действия. В Order добавлена возможность указать список комбо-блюд заказа. Новые модели данных: DeliveryOrderCombo, ComboItemInformation, CheckinResult, LoyaltyResult, AvailablePayment, LoyaltyProgramResult, DiscountOperation, Upsale, FreeProductsGroup, ComboSpecification, ComboPriceModificationType, ComboGroup, ComboProduct, AvailableCombo, ComboCategory, WalletInfo, ComboGroupMapping Новый метод получения ручных условий. Новая модель данных: ManualConditionInfo Новый метод проверки и расчета цены комбо. Новые модели данных: GetComboPriceRequest, CalculateComboPriceResult, ComboGroupInfo Новый метод получения спецификаций комбо и категорий | ? | Семенов Антон |
01.12.2016 | Возможность дополнительной фильтрации по гостю в отчете по транзакциям гостей организации за период | 34 | Семенов Антон |
10.05.2017 | Методы получения краткой информации по гостям, категорий, метрик, балансов | 39 | Семёнов Антон |
11.07.2017 | Методы мобильного приложения iikoCard5 | 41 | Белесев Сергей |
11.8.2017 | В OrganizationGuestInfo добавлено поле middleName. | 44 | Корепанова Анна |
29.08.2017 | В информацию о продукте номенклатуры добавлено поле useBalanceForSell | 46 | Рожнов Леонид |
06.09.2017 | Добавлен комментарий к TransactionsReportItem | 46 | Рожнов Леонид |
07.09.2017 | Добавлено поле validationWarnings к результату расчета лояльности через API | 46 | Рожнов Леонид |
14.09.2017 | Методы API iikoCard5 и RMS API разнесены по отдельным документам | 46 | Белесев Сергей |
28.03.2018 | Добавлен метод Привязка курьера к заказу | 50 | Сычев Игорь |
24.07.2018 | Добавлено поле с технической информацией в заказ | 56 | Рожнов Леонид |
23.09.2018 | Добавлено поле с отзывом клиента в методы получения информации по заказу и по истории заказов клиента | 58 | Рожнов Леонид |
11.01.2019 | Добавлена возможность указать Email для отправки информации о заказе при проблемах с созданием | 64 | Рожнов Леонид |
21.05.2020 | Добавлена информация о переносе доставки на другую точку. Добавлена информация о реквезитах получателя для доставки | 7.3 | Рожнов Леонид |
23.11.2021 | Удалена информация по работе с уведомлениями. Метод не используется. | Денис Максиомв | |
19.01.2022 | Добавил ссылку на документацию по серверному формату OLAP-отчета поле olapSettings типа OlapReportRequest | Денис Максимов |
Перед тем как работать с API , необходимо выполнить настройки в iiko BackOffice
https://ru.iiko.help/articles/#!api-documentations/kak-podkluchit-api
Content-Type запросов - application/json.
Маркер доступа выдается на фиксированный интервал времени. По умолчанию это - 15 минут.
/api/0/auth/access_token?user_id={user_id}&user_secret={user_secret}
Метод HTTP | GET |
Параметры
user_id | string | Идентификатор клиента (API логин) | * |
user_secret | string | Пароль клиента (API пароль) | * |
Ответ
string | Маркер доступа апи логина, используемый для авторизации в службах iikoBiz |
Пример
https://iiko.biz:9900/api/0/auth/access_token?user_id=client&user_secret=secret
!!! Обратите внимание, что индикатором успешного получения токена - является не хоть какой-нибудь ответ, а ответ с корректным Http-кодом 200. Любой другой ответ говорит о том, что получен не корректный токен, а сообщение об ошибке в том или ином виде. Увы, сейчас есть много примеров интеграций, страдающих из за отсутствия этой проверки.
/api/0/orders/add?access_token={accessToken}&request_timeout={requestTimeout}
При создании заказа предполагается, что идентификатор задается клиентом. Если идентификатор корректен, то заказ создается с ним. Если идентификатор не корректен, то возвращается ошибка. Если идентификатор оставить не заданным, то он будет сгенерирован автоматически.
Идентификатор пользователя позволяет выбрать уже зарегистрированного пользователя или создать нового. Если идентификатор не корректен, то возвращается ошибка.
Для того чтобы улица подставилась в iikoRMS необходимо чтобы поле Address удовлетворяло одному из требований:
При использовании оплаты iikoCard5 в сочетании с iikoRMS версии 5.0+, в поле additionalData информации об оплате, требуется прописать следующую структуру:
"{\"searchScope\": \"PHONE\", \"credential\": \"+7**********\"}"
Где помимо PHONE может быть указано CARD_NUMBER, CARD_TRACK. В этом случае, вместо актуального номера должен быть указан номер либо трек карты пользователя.
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
orderRequest | Запрос на создание заказа | * | |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. |
Ответ
orderInfo | Информация о заказе |
Пример
{
"organization": "1721531da-7ed5-4cf8-3ad1f-370031d2e6b1",
"customer": {
"id": "88529d26-efa5-48e2-af5e-96c245f62d26",
"name": "Client",
"phone": "Phone"
},
"order": {
"id": "76da34ed-7952-49e3-a2fa-4a0283d510b8",
"phone": "Phone",
“isSelfService”: false,
"address": {
"street": "Street-1",
"home": "1"
},
"date": "2011-09-20 18:30:00",
“personsCount”: ”3”,
"items": [{
"id": "040adebb-695a-4687-93bc-4ad30b370b83",
"name": "Пицца",
"amount": "1",
"modifiers": [{
"id": "8a5b6dce-c5d1-4932-9c61-073b3dd57645",
"name": "Топпинг",
"amount": "3",
"groupId": "35e3d0c0-cb19-4bf1-b760-fe8c0061f4d1",
"groupName": "Топпинги для пиццы"
}]
}]
}
}
/api/0/orders/info?access_token={accessToken}&organization={organizationId}&order={orderId}&request_timeout={requestTimeout}
Получение информации о предварительно созданном заказе.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | string | Идентификатор ресторана | * |
orderId | string | Идентификатор заказа | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. |
Ответ
orderInfo | Информация о заказе |
/api/0/orders/checkCreate?access_token={accessToken}&request_timeout={requestTimeout}
Определяет, подходит доставка к обработке или нет.
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
orderRequest | Запрос на создание заказа | * | |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. |
Ответ
orderCheckCreationResult | Результат проверки возможности создания доставки |
/api/0/orders/checkAddress?access_token={accessToken}&request_timeout={requestTimeout}&organizationId={organizationId}
Определяет, возможно ли осуществить доставку по указанному адресу.
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | string | Идентификатор организации | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. |
Пример тела запроса
{
"city": "Москва",
"street": "Планетарная",
"home": "1"
}
Ответ
addressCheckResult | Результат проверки возможности осуществления доставки по указанному адресу |
Внимание! Если указанного адреса не существует на карте, но он записан в базу RMS, то по запросу геокодер возвращает координаты центра города, для данной улицы. Если в центре города есть зона доставки с зарегистрированным терминалом, данный метод вернет true для несуществующей улицы. Будьте внимательны при заполнении базы RMS, используйте средства синхронизации улиц и городов КЛАДР.
/api/0/orders/deliveryOrders?access_token={accessToken}&organization={organizationId}&dateFrom={dateFrom}&dateTo={dateTo}&deliveryStatus={deliveryStatus}&deliveryTerminalId={deliveryTerminalId}&request_timeout={requestTimeout}
Получение информации о всех доставках в заданном временном интервале.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | string | Идентификатор ресторана | * |
dateFrom | Дата начала интервала (включительно) | * | |
dateTo | Дата окончания интервала (включительно) | * | |
deliveryStatus | string | Статус доставки (регистронезависимый). Должно принимать одно из следующих значений:
| |
deliveryTerminalId | string | Идентификатор терминала доставки | |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. |
Ответ
deliveryOrdersResponse | Информация о заказах |
/api/0/orders/deliveryHistory?access_token={accessToken}&organization={organizationId}&customer={customerId}&request_timeout={requestTimeout}&maxResult={maxResult}
Получение информации о доставочных заказах, которые клиент делал в заданном ресторане. В истории учитываются только выполненные заказы. Метод работает только для ресторанов с колл-центром (iikoCallCenter)
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | string | Идентификатор ресторана | * |
customerId | string | Идентификатор клиента | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
maxResults | int | Максимальное количество заказов в ответе. ВАЖНО: версия RMS-сервера должна быть не ниже 7.8.6 и в конфиге сервера должен быть установлен параметр enable-customer-delivery-history-max-results=true |
Ответ
orders | Прошлые выполненные заказы клиента |
/api/0/orders/deliveryHistoryByPhone?access_token={accessToken}&organization={organizationId}&phone={phoneNumber}&request_timeout={requestTimeout}&maxResult={maxResult}
Получение информации о доставочных заказах, которые сделаны с заданного телефона в заданном ресторане. Метод работает только для ресторанов с колл-центром (iikoCallCenter)
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | string | Идентификатор ресторана | * |
phone | string | Номер телефона клиента | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
maxResults | int | Максимальное количество заказов в ответе. ВАЖНО: версия RMS-сервера должна быть не ниже 7.8.6 и в конфиге сервера должен быть установлен параметр enable-customer-delivery-history-max-results=true |
Ответ
orders | История заказов по клиентам |
/api/0/orders/deliveryHistoryByCustomerId?access_token={accessToken}&organization={organizationId}&customerId={customerId}&request_timeout={requestTimeout}&maxResult={maxResult}
Получение информации о доставочных заказах, которые сделаны клиентом с заданным идентификатором в заданном ресторане. Метод работает только для ресторанов с колл-центром (iikoCallCenter)
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | string | Идентификатор ресторана | * |
customerId | string | Идентификатор клиента | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
maxResults | int | Максимальное количество заказов в ответе. ВАЖНО: версия RMS-сервера должна быть не ниже 7.8.6 и в конфиге сервера должен быть установлен параметр enable-customer-delivery-history-max-results=true |
Ответ
orders | История заказов по клиенту |
/api/0/orders/sendDeliveryOpinion?access_token={accessToken}&request_timeout={requestTimeout}
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
opinion | DeliveryOpinion | Отзыв | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. |
Ответ
deliveryOpinionResponse | Информация об оставленном отзыве |
/api/0/orders/get_courier_orders?access_token={accessToken}&organization={organizationId}&courier={courierId}&request_timeout={requestTimeout}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор ресторана | * |
courierId | Guid | Идентификатор курьера | |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. |
Ответ
deliveryOrdersResponse | Информация о заказах |
/api/0/orders/assigncourier?access_token={accessToken}&organization={organizationId}&request_timeout={requestTimeout}
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор ресторана | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
request | содержимое запроса на привязку курьера. |
/api/0/orders/set_order_delivered?access_token={accessToken}&organization={organizationId}&request_timeout={requestTimeout}
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор ресторана | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
request | содержимое запроса на изменение статуса доставки. |
/api/0/orders/add_order_problem?access_token={accessToken}&organization={organizationId}&request_timeout={requestTimeout}
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор ресторана | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
request | содержимое запроса на добавление проблемы к доставке. |
Получить картинку (изображение продукта)
/api/0/nomenclature/{organizationId}?access_token={accessToken}
Один запрос возвращает информацию как о группах, так и о продуктах.
Метод возвращает:
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
groups | Group[] | Группы |
products | Product[] | Продукты |
revision | long | Ревизия (одна на все дерево продуктов) |
productCategories | Группы продуктов | |
uploadDate | string | Дата последнего обновления меню в формате "yyyy-MM-dd HH:mm:ss" |
Пример
{
"groups": [
{
"code": null,
"description": null,
"id": "9fa0dd9a-03f3-4d27-b74a-500000000002",
"name": "Закуски",
"order": 0,
"parentGroup": "9fa0dd9a-03f3-4d27-b74a-500000000001",
"imageId": null
},
{
"code": null,
"description": null,
"id": "9fa0dd9a-03f3-4d27-b74a-500000000001",
"name": "Основное меню",
"order": 0,
"parentGroup": null
}
],
"products": [
{
"code": null,
"description": null,
"id": "9fa0dd9a-03f3-4d27-b74a-000000000003",
"name": "Рыба в кляре",
"carbohydrateAmount": null,
"energyAmount": null,
"fatAmount": null,
"fiberAmount": null,
"groupdId": null,
"groupModifiers": [
],
"modifiers": [
],
"price": 0.00000,
"type": "dish",
"weight": null,
"isIncludedInMenu": true,
"order": 1,
"parentGroup": null
},
{
"code": null,
"description": null,
"id": "9fa0dd9a-03f3-4d27-b74a-000000000001",
"name": "bread",
"carbohydrateAmount": null,
"energyAmount": null,
"fatAmount": null,
"fiberAmount": null,
"groupModifiers": [
],
"modifiers": [
{
"maxAmount": 1,
"minAmount": 0,
"modifierId": "9fa0dd9a-03f3-4d27-b74a-000000000002"
}
],
"price": 10.00000,
"type": "good",
"weight": null,
"isIncludedInMenu": true,
"order": 0,
"parentGroup": "9fa0dd9a-03f3-4d27-b74a-500000000002"
},
{
"code": null,
"description": null,
"id": "9fa0dd9a-03f3-4d27-b74a-000000000002",
"name": "butter",
"carbohydrateAmount": null,
"energyAmount": null,
"fatAmount": null,
"fiberAmount": null,
"groupModifiers": [
],
"modifiers": [
],
"price": 0.00000,
"type": "modifier",
"weight": null,
"isIncludedInMenu": false,
"order": 0,
"parentGroup": null
}
],
"revision": 13985090
}
Url картинок приходит с ответом запроса номенклатуры
HTTP Get запрос по такому Url возвращает картинку.
Ответ
Картинка.
/api/0/cities/cities?access_token={accessToken}&organization={organizationId}
Метод возвращает список всех городов и улиц каждого из городов. Эти данные могут быть использовать для задания адреса доставки.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
Города с улицами |
/api/0/cities/citiesList?access_token={accessToken}&organization={organizationId}
Метод возвращает список всех городов заданной организации. Эти данные могут быть использовать для задания адреса доставки.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
City[] | Города |
/api/0/streets/streets?access_token={accessToken}&organization={organizationId}
&city={cityId}
Метод возвращает список всех городов заданной организации. Эти данные могут быть использовать для задания адреса доставки.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
cityId | string | Идентификатор города | * |
Ответ
Street[] | Улицы |
/api/0/regions/regions?access_token={accessToken}&organization={organizationId}
Метод возвращает список всех всех регионов, которые есть в справочнике регионов организации. Эти данные могут быть использовать для задания региона в адресе доставки.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
Region[] | Список регионов |
Возвращает список поддерживаемых протоколов
/api/0/rmsSettings/supportedProtocols?access_token={accessToken}&organization={organizationId}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
OrganizationSupportedProtocols | Список протоколов, поддерживаемых организацией |
/api/0/rmsSettings/getRoles?access_token={accessToken}&organization={organizationId}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
Список всех ролей организации |
/api/0/rmsSettings/getEmployees?access_token={accessToken}&organization={organizationId}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
Список всех сотрудников организации |
/api/0/rmsSettings/getRestaurantSections?access_token=ТОКЕН&organization=ОРГАНИЗАЦИЯ
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
Список всех залов организации |
/api/0/rmsSettings/getOrderTypes?access_token={accessToken}&organization={organizationId}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
GetOrderTypes | Справочник типов заказов |
Пример ответа:
{"items":[{"id":"bbbef4dc-5a02-7ea3-81d3-826f4e8bb3e0","name":"Normal order","orderServiceType":"COMMON"},{"id":"5b1508f9-fe5b-d6af-cb8d-043af587d5c2","name":"Самовывоз","orderServiceType":"DELIVERY_PICKUP"},{"id":"76067ea3-356f-eb93-9d14-1fa00d082c4e","name":"Доставка курьером","orderServiceType":"DELIVERY_BY_COURIER"}]}
/api/0/rmsSettings/getPaymentTypes?access_token={accessToken}&organization={organizationId}
Запрос возвращает список внешних типов оплат для заданного ресторана. Внешними считаются типы, процессинг которых идет не на стороне iiko.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
paymentTypes | Внешние типы оплат | * |
/api/0/rmsSettings/getMarketingSources?access_token={accessToken}&organization={organizationId}
Запрос возвращает список всех маркетинговых источников для заданного ресторана.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
marketingSources | Маркетинговые источники | * |
/api/0/rmsSettings/getCouriers?access_token={accessToken}&organization={organizationId}
Возвращает список всех сотрудников, которые являются курьерами доставки в заданном ресторане. Курьером доставки считается пользователь, обладающий правом “D_DCO” (быть курьером доставки).
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | string | Идентификатор организации iikoBiz | * |
Ответ
Список курьеров организации | * |
Все методы этого сервиса работают по протоколу https.
/api/0/stopLists/getDeliveryStopList?access_token={accessToken}&organization={organizationId}
Запрос возвращает список продуктов, находящихся в стоп-листе.
В случае запроса на колл-центра в результате могут находяится позиции стоп-листа из других ресторанов.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации | * |
Ответ
stopList | Элементы стоп-листа | * | |
unregisteredOrganizations | string[] | Идентификаторы организаций, которые не зарегистрированы в iikoBiz. | * |
/api/0/mobile/signin?access_token={accessToken}&request_timeout={requestTimeout}&organization={organizationId}
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | String | Маркер доступа | * |
organizationId | String | Id организации | * |
requestTimeout | int | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | |
request | Сущность, описывающая запрос на логин | * |
Ответ
mobileLoginResultDto | DTO, описывающий результат логина (есть ли ошибки), сообщает также версию сервера |
/api/0/mobile/sync?access_token={accessToken}&request_timeout={requestTimeout}&organization={organizationId}
Отсылает изменения в доставках (статус, проблема) и сохраненные gps координаты курьера.
Метод HTTP | POST |
Аутентификация | необязательная |
Параметры
accessToken | string | Маркер доступа | |
requestTimeout | int | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | |
organizationId | String | Id организации | * |
syncDto | Изменения доставок на мобильном приложении; список gps координат курьера | * |
Ответ
syncResultDto | Список актуальных доставок для данного курьера |
/api/0/deliverySettings/deliveryDiscounts?access_token={accessToken}&organization={organizationId}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | Guid | Id организации | * |
Ответ
discounts | Список скидок, доступных для применения в доставочных заказах. |
/api/0/deliverySettings/getDeliveryTerminals?access_token={accessToken}&organization={organizationId}
Примечание: Каждый iikoRMS с зарегистрированным терминалом доставки в КЦ должен быть зарегистрирован как отдельная организация в iiko.biz.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | Guid | Id организации | * |
Ответ
deliveryTerminals | Список доставочных ресторанов, подключённых к данному ресторану |
/api/0/deliverySettings/getDeliveryRestrictions?access_token={accessToken}&organization={organizationId}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | Guid | Id организации | * |
Ответ
deliveryRestrictions | Ограничения работы и список зон доставки |
/api/0/deliverySettings/getSurveyItems?access_token={accessToken}&organization={organizationId}&orderId={orderId}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | Guid | Идентификатор организации | * |
orderId | Guid | Идентификатор заказа | * |
Ответ
surveyItems | Список вопросов для отзыва клиента о сделанной доставке |
/api/0/deliverySettings/getDeliveryCourierMobileSettings?access_token={accessToken}&organization={organizationId}
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organization | Guid | Id организации | * |
Ответ
deliveryCourierMobileSettingsResponse | Настройки для мобильного приложения курьерской доставки для данного ресторана |
Все методы этого сервиса работают по протоколу https.
/api/0/olaps/olapColumns?access_token={accessToken}&request_timeout={requestTimeout}&organizationId={organizationId}&reportType={reportType}
Возвращает информацию о колонках олап-отчета заданного типа для заданной организации.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации iikoBiz | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
reportType | Тип олап отчета | * |
Ответ
Информация по колонкам олапа заданного типа | * |
/api/0/olaps/olap?access_token={accessToken}&request_timeout={requestTimeout}
Получить данные олап отчета
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
olapReportRequest | запрос на получение олап-отчета(POST-параметр. передается в body) | * |
Ответ
Данные олап-отчета | * |
/api/0/olaps/olapPresets?access_token={accessToken}&request_timeout={requestTimeout}&organizationId={organizationId}
Получить виды преднастроенных олап-отчетов.
Метод HTTP | GET |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
organizationId | Guid | Идентификатор организации iikoBiz | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. |
Ответ
Информация по видам преднастроенных олап-отчетов для заданной организации. | * |
/api/0/olaps/olapByPreset?access_token={accessToken}&organizationId={organizationId}&request_timeout={requestTimeout}
Получить данные олап отчета
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
organizationId | Guid | Идентификатор организации iikoBiz | * |
presetOlapReportRequest | запрос на получение олап-отчета(POST-параметр. передается в body) | * |
Ответ
Данные преднастроенного олап-отчета | * |
Все методы этого сервиса работают по протоколу https.
/api/0/events/events?access_token={accessToken}&request_timeout={requestTimeout}
Получить данные журнала событий
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
eventsRequest | запрос на получение журнала событий (POST-параметр. передается в body) | * |
Ответ
Данные журнала событий | * |
/api/0/events/eventsMetadata?access_token={accessToken}&request_timeout={requestTimeout}
Получить мета данные журнала событий
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
eventsRequest | запрос на получение мета данных журнала событий (POST-параметр. передается в body) | * |
{
"organizationId" : "D688C80B-91B3-4829-AC26-43D7CDE8CD3D",
"eventsSettings" : "{
\"fromRevision\" : \"-1\",
\"dateFrom\" : \"2018-12-01 12:00:00\",
\"dateTo\" : \"2018-12-02 12:00:00\",
\"orderNums\" : [\"123\",\"345\"]
}"
}
Ответ
Данные журнала событий | * |
/api/0/events/sessions?access_token={accessToken}&request_timeout={requestTimeout}
Получить информацию о кассовых сменах за операционный период (день)
Метод HTTP | POST |
Аутентификация | обязательная |
Параметры
accessToken | string | Маркер доступа | * |
requestTimeout | Таймаут для выполнения запроса. Указывает на время обработки запроса на серверной стороне, не учитывая транспортные задержки. | ||
eventsRequest | запрос на получение мета данных журнала событий (POST-параметр. передается в body) | * |
Ответ
Данные журнала событий | * |
Примеры body
{
"organizationId" : "D688C80B-91B3-4829-AC26-43D7CDE8CD3D",
"eventsSettings" : "{
\"fromRevision\" : \"-1\",
\"dateFrom\" : \"2018-12-01 12:00:00\",
\"dateTo\" : \"2018-12-02 12:00:00\",
\"orderNums\" : [\"123\",\"345\"]
}"
}
{
"organizationId" : "D688C80B-91B3-4829-AC26-43D7CDE8CD3D",
"eventsSettings" : "{
\"fromRevision\" : \"-1\",
\"dateFrom\" : \"2018-12-01 12:00:00\",
\"dateTo\" : \"2018-12-02 12:00:00\",
\"metadataFields\" : [\"field1\"],
\"orderNums\" : [\"123\",\"345\"]
}"
}
organization | string | Идентификатор ресторана, список доступных ресторанов можно получить при помощи функции Получение списка организаций | * |
deliveryTerminalId | Guid | Идентификатор доставочного терминала, на который нужно отправить заказ. Используется ТОЛЬКО в том случае когда не активирована функция автораспределения заказов и когда нет (физически) операторов коллцентра, которые могут обработать заказ. | |
customer | Заказчик | ||
order | Заказ | * | |
coupon | string | Номер купона, который применяется к заказу. | |
availablePaymentMarketingCampaignIds | Guid[] | Массив идентификаторов применяемых акций, содержащих Действия оплаты. Если действия оплаты не используются, то массив должен быть пустым. | |
applicableManualConditions | Guid[] | Массив идентификаторов ручных условий, которые применяются к заказу. !!! Примечание: Для версии РМС более ранней чем 6.2, ручные условия можно применить для CalculateCheckinResult, но при создании заказа они работать не будут. Данная доработка появится в будущих версиях. | |
customData | string | Служебная информация. Только хранится, доступна через API, на UI не выводится | |
emailForFailedOrderInfo | string | Email для отправки информации о заказе при проблемах с созданием. | |
referrerId | Guid | Идентификатор рекомендателя (customer.id) из iikoCard. Получить можно из iikoCardAPI методами get_customer_by_phone или get_customer_by_card. |
Заказ
Наименование | Тип | Комментарий | Макс.длина | |
id | Guid | Идентификатор заказа | ||
externalId | string | Идентификатор заказа – должен быть уникальным в рамках данной организации | ||
date | Дата выполнения заказа, если задан null, то система подставит время как текущее + продолжительность доставки из “График работы и картография” | * | ||
items | Элементы заказа | * | ||
paymentItems | Элементы оплаты заказа | |||
phone | string | Контактный телефон. Регулярное выражение, которому должен соответствовать телефон: ^(8|\+?\d{1,3})?[ -]?\(?(\d{3})\)?[ -]?(\d{3})[ -]?(\d{2})[ -]?(\d{2})$ | 40 | * |
customerName | string | Имя клиента. Используется, если клиент не задан. | 60 | |
isSelfService | bool | Признак доставки самовывозом | ||
orderTypeId | Guid | Идентификатор типа заказа. Получается методом Получение списка допустимых типов заказов | ||
address | Адрес доставки заказа | |||
comment | string | Комментарий к заказу | 500 | |
conception | string | Концепция | ||
personsCount | int | Количество персон | ||
marketingSource | string | Маркетинговый источник (реклама). Можно указывать не более одного источника. Пример: deliveryMarket.ru | ||
marketingSourceId | Guid | Идентификатор маркетингового источника | ||
discountCardTypeId | Guid | Идентификатор скидки для заказа. Получается методом Получить список скидок, доступных для применения в доставке для заданного ресторана Обратите внимание, что к одному заказу через API можно применить только одну скидку | ||
discountCardSlip | string | Трек скидочной карты, которую надо применить к заказу. Если указан одновременно с discountCardTypeId, то будет применятся скидка по discountCardTypeId. | ||
discountOrIncreaseSum | decimal | Сумма скидки. Необходима только для скидок со свободной суммой. | ||
orderCombos | Массив комбо-блюд, включенных в заказ. |
Элемент заказа
id | Guid | Идентификатор продукта | Ограничения | |
code | string | Артикул товара | * | |
name | string | Название продукта | ||
amount | decimal | Количество | <1000 | * |
sum | decimal | Стоимость | Обязательно при расчете скидок и бонусов | |
category | string | Категория товара | Обязательно при расчете скидок и бонусов | |
modifiers | Модификаторы | |||
comment | string | Комментарий | 255 | |
guestId | Guid | Идентификатор гостя | ||
comboInformation | Информация о комбо-блюде, если позиция в заказе относится к комбо. |
Модификатор элемента заказа.
id | Guid | Идентификатор продукта | * |
name | string | Название продукта | * |
amount | decimal | Количество | * |
groupId | Guid | Идентификатор группы в случае группового модификатора. Обязателен если модификатор является групповым. | |
groupName | string | Имя группы в случае группового модификатора. Обязателен если модификатор является групповым. |
Комбо-блюда, включенные в заказ
id | Guid | Идентификатор комбо-блюда. Произвольный. Должен совпадать с order.items[].comboInformation.id | * |
name | string | Имя комбо-блюда | * |
amount | int | Количество комбо-блюд | * |
price | decimal | Стоимость 1 единицы комбо-блюда. Без учета amount. | * |
sourceId | Guid | Идентификатор действия, которое порождает данное комбо. Использовать значение из ComboItemInformation.ComboSource.Id | * |
programId | Guid | Идентификатор АКЦИИ программы, в которой объявлены комбо-блюда | * |
Информация о комбо-блюде, если позиция в заказе относится к комбо.
comboId | Guid | Идентификатор созданного комбо-блюда, к которой относится данная позиция заказа. (DeliveryOrderCombo.id) | * |
comboSourceId | Guid | Идентификатор действия, которое задает комбо. (DeliveryOrderCombo.sourceId). Можно узнать из метода получения спецификаций комбо. | * |
groupId | Guid | Идентификатор группы комбо, к которой относится данная позиция заказа. Можно узнать из метода получения спецификаций комбо. | * |
Элемент оплаты заказа
sum | decimal | Сумма к оплате | * |
paymentType | Тип оплаты (одно из полей: id, code является обязательным) | * | |
isProcessedExternally | bool | Является ли позиция оплаты проведенной | * |
isPreliminary | bool | Является ли позиция оплаты предварительной | |
isExternal | bool | Принята ли позиция оплаты извне | |
additionalData | string | Дополнительная информация | |
chequeAdditionalInfo | Дополнительная информация о чеке оплаты | ||
isFiscalizedExternally | bool | Является ли внешняя позиция оплаты заранее проведенной на внешнем ФР | |
organizationDetailsInfo | Информация о реквизитах организации |
Элемент оплаты заказа
needReceipt | bool | Печатать ли бумажный чек | * |
phone | string | Телефон для отправки смс о чеке | |
string | Почта для отправки письма о чеке | ||
settlementPlace | string | Место расчета |
Заказчик
Наименование | Тип | Комментарий | Макс.длина | |
id | Guid | Идентификатор | ||
name | string | Имя | 60 | * |
phone | string | Телефонный номер. Регулярное выражение, которому должен соответствовать телефон. | 40 | * |
cultureName | string | Языковая культура пользователя, пример: RU-ru | ||
favouriteDish | string | Любимое блюдо пользователя | ||
birthday | День рождения | |||
string | 60 | |||
nick | string | Никнэйм | 60 | |
middleName | string | Отчество | 60 | |
surName | string | Фамилия | 60 | |
shouldReceivePromoActionsInfo | bool? | Получает ли пользователь информацию о промо акциях | ||
sex | string | Пол: NotSpecified = 0, Male = 1, Female = 2. Для входящих запросов передавать 0,1 или 2. | ||
imageId | Guid | Идентификатор изображения пользователя | ||
customProperties | {“Key”:””,”Value”:””}[] | массив key-value значений дополнительных свойств | ||
comment | string | Комментарий к гостю | ||
publicCustomProperties | {“Key”:””,”Value”:””}[] | массив key-value значений публичных дополнительных свойств | ||
balance | decimal | Баланс пользователя | ||
isBlocked | bool | Заблокирован ли пользователь в организации | ||
additionalPhones | Дополнительные телефоны | |||
addresses | CustomerAddress[] | Адреса | ||
cards | Карты | |||
counteragentInfo | Информация о реквизитах организации |
Адрес
Наименование | Тип | Комментарий | Макс.длина | Обяз. |
city | string | Наименование города | 255 | * |
street | string | Наименование улицы | 255 | * |
streetId | Guid | Идентификатор улицы (если справочник улиц синхронизирован с справочником улиц в RMS) | ||
streetClassifierId | string | Идентификатор улицы в классификаторе, например, КЛАДР. | 255 | |
home | string | Дом | 10 | * |
housing | string | Корпус | 10 | |
apartment | string | Квартира | 10 | |
entrance | string | Подъезд | 10 | |
floor | string | Этаж | 10 | |
doorphone | string | Домофон | 10 | |
comment | string | Дополнительная информация | 500 | |
regionId | Guid | Идентификатор района, к которому относится адрес | ||
externalCartographyId | string | Идентификатор адреса во внешней картографической системе | 255 | |
index | string | Индекс улицы в адресе, если есть | 255 |
Телефон.
phone | string | Номер телефон | * |
Описание заказа
orderId | Guid | Идентификатор заказа | * | |||||||||||||||||||||
customerId | Guid | Идентификатор заказчика | ||||||||||||||||||||||
movedDeliveryId | Guid? | Идентификатор новой доставки, созданный для переноса текущей на новую точку. Если доставка не была перенесена на другую точку, равен null. Если перенос совершен ранее 7.3, тоже будет не задано. | ||||||||||||||||||||||
customer | Клиент доставки | |||||||||||||||||||||||
address | Адрес доставки | |||||||||||||||||||||||
organization | Guid | Идентификатор ресторана | ||||||||||||||||||||||
sum | decimal | Сумма заказа | ||||||||||||||||||||||
discount | decimal | Сумма скидки | ||||||||||||||||||||||
number | string | Понятный номер заказа. Может использоваться для передачи клиенту. Уникальность не гарантирована (может быть уникальным в рамках одного обслуживающего сервера). | ||||||||||||||||||||||
status | string | Статус заказа. Варианты значения для доставки (для русской и английской локализации iikoRMS):
| ||||||||||||||||||||||
customerName | string | Имя клиента. Используется, если клиент не задан. | ||||||||||||||||||||||
customerPhone | string | Телефон клиента доставки | ||||||||||||||||||||||
deliveryCancelCause | Причина отмены доставки | |||||||||||||||||||||||
deliveryCancelComment | string | Комментарий к отмене доставки | ||||||||||||||||||||||
courierInfo | Информация о курьере заказа | |||||||||||||||||||||||
orderLocationInfo | Координаты адреса доставочного заказа | |||||||||||||||||||||||
deliveryDate | Дата, к которой нужно доставить заказ | |||||||||||||||||||||||
actualTime | Фактическое время доставки | |||||||||||||||||||||||
billTime | Время печати накладной (время пречека) | |||||||||||||||||||||||
cancelTime | Время отмены доставки | |||||||||||||||||||||||
closeTime | Время закрытия доставки | |||||||||||||||||||||||
confirmTime | Время подтверждения доставки | |||||||||||||||||||||||
createdTime | Время создания доставки | |||||||||||||||||||||||
printTime | Время сервисной печати | |||||||||||||||||||||||
sendTime | Время отправки доставки | |||||||||||||||||||||||
comment | string | Комментарий к заказу | ||||||||||||||||||||||
problem | Проблема доставки | |||||||||||||||||||||||
operator | Оператор, принявший заказ | |||||||||||||||||||||||
conception | Концепция | |||||||||||||||||||||||
marketingSource | Маркетинговый источник | |||||||||||||||||||||||
durationInMinutes | int | Продолжительность доставки (в минутах) | ||||||||||||||||||||||
personsCount | int | Количество гостей | ||||||||||||||||||||||
splitBetweenPersons | bool | Признак того, нужно ли разбивать заказ по гостям | ||||||||||||||||||||||
iikoCard5Coupon | string | Примененный к заказу купон | ||||||||||||||||||||||
items | Позиции заказа | |||||||||||||||||||||||
guests | Гости заказа | |||||||||||||||||||||||
payments | Оплаты доставки | |||||||||||||||||||||||
orderType | Тип заказа | |||||||||||||||||||||||
deliveryTerminal | Доставочный терминал | |||||||||||||||||||||||
discounts | Скидки | |||||||||||||||||||||||
customData | string | Служебная информация. Только хранится, доступна через API, на UI не выводится | ||||||||||||||||||||||
opinion | DeliveryOpinion | Отзывы клиента о заказе |
deliveryOrders |
Информация о карте гостя.
Id | string | Идентификатор карты | * |
Track | string | Трек карты | * |
Number | string | Номер карты | |
IsActivated | bool | Признак, активирована карта или нет | * |
OrganizationId | Guid | Идентификатор организации, в которой действует карта | * |
Информация о реквизитах организации.
name | string | Наименование компании контрагента | * |
code | string | Код компании контрагента. Аналог ИНН. | |
accountingReasonCode | string | КПП компании контрагента | |
address | string | Адрес компании контрагента |
Информация о реквизитах организации.
customerId | Guid | Id клиента с этими реквизитами | |
name | string | Наименование компании контрагента | * |
code | string | Код компании контрагента. Аналог ИНН. | |
accountingReasonCode | string | КПП компании контрагента | |
address | string | Адрес компании контрагента |
Тип оплаты
id | Guid | Идентификатор типа оплаты | |
code | string | Код типа оплаты | |
name | string | Название типа оплаты | |
comment | string | Комментарий к типу оплаты | |
combinable | bool | Признак комбинируемости | |
externalRevision | long? | Номер ревизии сущности из РМС | |
deleted | bool | Признак, удален тип оплаты или нет | |
applicableMarketingCampaigns | Guid[] | Массив маркетинговых акций, связанных с типом оплаты iikoCard5, применяемых для данной организации. |
Причина отмены доставки
id | Guid | Идентификатор причины отмены доставки | * |
name | string | Строковое описание причины отмены доставки | * |
Ответ на запрос по получению списка ролей организации
roles | Список ролей |
Описание роли организации
id | Guid | Идентификатор роли | * |
name | string | Имя роли | |
code | string | Код | |
paymentPerHour | decimal | Оплата в час | |
steadySalary | decimal | Оклад | |
comment | string | Комментарий | |
externalRevision | long? | Номер ревизии сущности из РМС |
Ответ на запрос по получению списка сотрудников организации
roles | Список сотрудников |
Ответ на запрос по получению списка залов организации
sections | Список залов |
Информация о зале организации
id | Guid | Идентификатор | |
name | String | Название | |
externalRevision | long? | Номер ревизии сущности из РМС |
Справочник типов заказов организации
Items | Массив типов заказов |
Тип заказа
Id | Guid | Идентификатор типа заказа | * |
Name | String | Наименование тапа заказа | * |
OrderServiceType | String | Сервисный тип заказа | * |
externalRevision | long? | Номер ревизии сущности из РМС |
Описание протоколов организации:
string | Тип протокола обмена | * | |
version | int | Номер версии | * |
description | string | Описание версии протокола | * |
Тип обмена | Описание типа обмена |
Очередь заказов | |
Очередь настроек доставки | |
Очередь мобильного приложения курьера | |
Очередь курьеров | |
Очередь типов оплат | |
Очередь стоп-листов | |
Обмен гостями | |
Выгрузка номенклатуры из RMS | |
Выгрузка улиц, городов, регионов из RMS |
У каждого типа протокола обмена из protocolExchangeType есть свои версии. На данный момент поддерживаются следующие версии:
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола | |
MarketingSourceText | 2 | Приём рекламы в текстовом виде | 3.9 |
PersonsCount | 3 | Указание числа гостей при создании заказа | 3.9.2 |
MarketingSourceId | 4 | Приём рекламы по ID | 4.0 |
DeliveryOpinion | 5 | DeliveryOpinion | 4.1 |
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола | |
SurveyItems | 2 | Вопросы для отзыва клиента доставки | 4.1 |
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола |
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола |
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола |
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола |
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола |
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола |
Название версии протокола обмена | Номер версии протокола обмена | Описание версии протокола обмена | Версия RMS, с которой поддерживается протокол |
Basic | 1 | Базовая версия протокола |
Доставочный ресторан, подключённый к другому ресторану (доставочный терминал)
organizationId | Guid | Идентификатор организации, к которой относится доставочный терминал | * |
deliveryRestaurantName | string | Наименование доставочного терминала | * |
deliveryGroupName | string | Имя группы, используемое для определения, к какому предприятию/группе относится терминал. | |
deliveryTerminalId | Guid | Идентификатор доставочного терминала | * |
name | string | Имя ресторана | |
address | string | Адрес ресторана | |
workTime | Время работы ресторана | ||
externalRevision | long? | Номер ревизии сущности из РМС | |
technicalInformation | string | Техническая информация. |
Ограничения работы ресторана
deliveryRegionsMapUrl | string | Ссылка на карту регионов обслуживания доставки | |
defaultDeliveryDurationInMinutes | int | Общая продолжительность доставки | |
useSameDeliveryDuration | bool | Признак того, что ресторан(ы) используют общие ограничения по времени доставки | * |
useSameMinSum | bool | Признак того, что ресторан(ы) по всем зонам используют одинаковую минимальную сумму | * |
defaultMinSum | decimal | Общая минимальная сумма заказа | |
useSameWorkTimeInterval | bool | Признак того что ресторан(ы) использует общий интервал работы для всех зон. | * |
defaultFrom | int | Начало интервала по умолчанию работы ресторана, в минутах от начала дня. Используется совместно с useSameWorkTimeInterval | |
defaultTo | int | Конец интервала по умолчанию работы ресторана, в минутах от начала дня. Если defaultTo < defaultFrom, то это означает, что конец рабочего дня залезает на следующий день. Используется совместно с useSameWorkTimeInterval | |
useSameRestructionsOnAllWeek | bool | Признак того, что ограничения работы точек распространяются на все дни недели. | * |
restrictions | Привязки ресторанов к зонам доставки | ||
deliveryZones | Список доставочных зон из Яндекс.Карт |
Элемент ограничения работы ресторана. Связывает между собой ресторан и зону обслуживания.
organizationId | Guid | Ресторан, к которому применяется заданное ограничение | * |
deliveryTerminalId | Guid | Доставочный терминал, к которому применяется заданное ограничение. Null, если доставка одноресторанная | |
minSum | decimal | Минимальная сумма заказа | |
zone | string | Наименование зоны доставки | |
weekMap | int | Битовый массив, описывающий дни недели, к которым применяется заданное ограничение | * |
from | int | Начало интервала работы ресторана, в минутах от начала дня | |
to | int | Конец интервала работы ресторана, в минутах от начала дня. Если to < from, то это означает, что конец рабочего дня залезает на следующий день. | |
priority | int | Приоритет ресторана над зоной доставки | * |
deliveryDurationInMinutes | int | Время доставки ресторана в указанную зону | * |
Зона доставки задается в виде многоугольника с географическими координатами.
name | string | Наименование зоны доставки | * |
coordinates | Координаты вершин многоугольника | * |
Результат проверки возможности создания доставки
deliveryRestriction | Сработавшее ограничение (в случае, если удалось найти точку, которая может обработать заказ) | ||
problem | string | Описание ошибки (в случае, если доставка не может быть обработана рестораном) | |
resultState | int | Результат проверки: Success = 0 (Доставка была успешна распределена), RejectByMinSum = 1 (Доставка отвергнута по минимальной сумме заказа), RejectByWorkTime = 2 (Доставка отвергнута по времени работы заведения), RejectByZone = 3 (Доставка отвергнута по причине отсутсвия подходящей зоны. Возможные причины: адрес не отгеокодирован, адрес не входит не в одну из зон, адрес не был найден (в RMS)), RejectByStopList = 4 (Продукт из заказа находятся в стоп-листе), RejectByPriceList = 5. (Продукт из заказа запрещен к продаже) | |
deliveryServiceProductInfo | Дополнительная плата за доставку. | ||
deliveryDurationInMinutes | int | Продолжительность доставки в минутах |
Информация по дополнительной плате за доставку.
productId | Guid | Идентификатор продукта. | |
productSum | decimal | Дополнительная плата за доставку. | |
productName | string | Название продукта. |
Информация о курьере заказа
addressInZone | Boolean | Информация, входит ли указанный адрес в зону доставки и есть ли зарегистрированный терминал в этой зоне | * |
Информация о курьере заказа
courierId | Guid | Идентификатор курьера | * |
location | Информация о положении курьера | * |
Информация о положении курьера
latitude | decimal | Широта координаты курьера | * |
longitude | decimal | Долгота координаты курьера | * |
accuracy | int | Точность измерения | * |
date | Дата измерения местоположения курьера | * |
Координаты адреса доставочного заказа
latitude | decimal | Широта | * |
longitude | decimal | Долгота | * |
Концепция
id | Guid | Идентификатор концепции | * |
name | string | Название концепции | * |
code | string | Код концепции | * |
Проблема доставки
hasProblem | bool | Признак проблемы | * |
problem | string | Описание проблемы | * |
Маркетинговый источник
id | Guid | Идентификатор источника | * |
name | string | Наименование источника | * |
attachedSources | string[] | Список связанных источников доставки | * |
externalRevision | long? | Номер ревизии сущности из РМС |
Заказ гостя, который он делал в прошлом.
orderId | Guid | Идентификатор заказа | * |
customerId | Guid | Идентификатор заказчика | * |
organizationId | string | Идентификатор ресторана | * |
sum | decimal | Сумма заказа | * |
discount | decimal | Сумма скидки | * |
number | string | Понятный номер заказа. Может использоваться для передачи клиенту. Уникальность не гарантирована (может быть уникальным в рамках одного обслуживающего сервера). | * |
phone | string | Контактный телефон | * |
isSelfService | bool | Признак доставки самовывозом | * |
address | Адрес доставки заказа | ||
date | Дата выполнения заказа | * | |
conception | string | Концепция | * |
comment | string | Комментарий к заказу | |
items | Элементы заказа | * | |
opinion | DeliveryOpinion | Отзывы клиента о заказе |
Заказ гостя, который он делал в прошлом.
customersDeliveryHistory | Список клиентов с их историей доставочных заказов | * |
Заказ гостя, который он делал в прошлом.
customer | Клиент доставки, для которого возвращается история заказов | * | |
deliveryHistory | История заказов для клиента в поле customer |
Элемент стоп-листа
productId | Guid | Идентификатор товара, находящегося в стоп-листе | * |
balance | decimal | Оставшееся количество товаров | * |
Элемент стоп-листа
organizationId | Guid | Организация, у которой заданный товар находится в СЛ. | * |
terminalId | Guid | Идентификатор терминала, где находится заданный товар | * |
items | Список позиций стоп-листа | * |
Сотрудник организации
Id | Guid | Идентификатор сотрудника | * |
firstName | string | Имя пользователя | |
middleName | string | Отчество | |
lastName | string | Фамилия | |
displayName | string | Отображаемое имя пользователя | |
phone | string | Телефон | |
cellPhone | string | Мобильный телефон | |
string | Email сотрудника | ||
externalRevision | long? | Номер ревизии сущности из РМС |
Вопрос для отзыва клиента
id | Guid | Идентификатор вопроса | * |
type | string | Категория вопроса. Возможные значения: Common - общие вопросы; Courier - Курьер; DeliveryOperator - Оператор доставки; DeliveryFood - Кухня в доставке. | * |
question | string | Текст вопроса | * |
Оценки доставки клиентом
organization | Guid | Идентификатор организации | * |
deliveryId | Guid | Идентификатор доставочного заказа | * |
comment | string | Текстовый отзыв клиента о доставке | |
marks | DeliveryOpinionMark[] | Оценки клиента |
Оценка клиента
surveyItemId | Guid | ID вопроса | * |
mark | int | Оценка | * |
Информация об оставленной оценке клиента.
Полей нет.
DTO, описывающий результат логина (есть ли ошибки), сообщает также версию сервера
OrganizationId | Guid | Id организации, проставляется на iikoNet | |
Courier | Dto для описания пользователя (курьера в контексте доставки) | ||
ServerVersion | String | Версия РМС сервера. Возвращает информацию Version.getCurrentVersion().getLongDescription() с РМС | * |
Error | String | Информация об ошибке | |
IsCashRegisterAllowed | bool | Разрешено ли использовать мобильный ФР |
Dto для описания пользователя (курьера в контексте доставки)
id | Guid | Id пользователя | * |
Name | String | Имя пользователя | * |
DTO - запрос на логин
pinCode | string | Пин-код курьера (используется для идентификации внутри ресторана. Ресторан определяетя про iikoNet login/password | * |
DTO для синхронизации с сервером - посылает с мобильного приложения обновления доставок и сохраненные координаты
courierId | Guid | ID курьера | * |
knownDeliveries | List<Guid> | Cписок guid известных мобильной доставке - чтоб не посылать каждый раз кучу справочной информации для указанных тут доставок будет послано только статус, ревизия, проблема | * |
changedDeliveries | List<UpdateDeliveryOrderDto> | Список DTO, описывающая частичные изменения в какой-либо из доставок | |
locations | List<LocationDto> | Список DTO положения курьера для мобильного приложения |
DTO, описывающая частичные изменения в какой-либо из доставок. Полностью доставку описывает DeliveryDto
DeliveryId | Guid | Id доставки | * |
Problem | Проблема в доставке | * | |
DeliveryStatus | string | Статус доставки | * |
DeliveryDate | string | Дата доставки | |
Revision | int | Номер последней ревизии, служит для реализации "оптимистичной локировки". Изменения, сделанные курьером применяются только если ревизия не изменилась | * |
IndexInCourierRoute | int | Индекс маршрута курьера | * |
DTO положения курьера для мобильного приложения
Latitude | decimal | Широта | * |
Longitude | decimal | Долгота | * |
Accuracy | int | Точность в метрах | * |
Date | string | Дата измерения местоположения курьера | * |
DTO проблемы доставки
HasProblem | bool | Флаг, показывающий, была ли проблема в доставке | * |
Problem | String | Описание проблемы |
DTO, полностью описывающее доставку.
FullDescOrders | List<DeliveryOrderDto> | Список DTO сущности, полностью описывающей доставку для мобильного приложения, также для описания доставки служит UpdateDeliveryDto, описывающее ее частично (изменения) | * |
PartiallyDescOrders | List<UpdateDeliveryOrderDto> | Cписок DTO, описывающих частичные изменения в какой-либо из доставок. Полностью доставку описывает DeliveryDto | * |
Error | String | Описание ошибки |
DTO сущности, полностью описывающей доставку для мобильного приложения, также для описания доставки служит UpdateDeliveryDto, описывающее ее частично (изменения)
deliveryId | Guid | Id доставки | * |
problem | Проблема в доставке | * | |
deliveryStatus | string | Статус доставки | |
deliveryDate | string | Дата доставки | * |
revision | int | Номер последней ревизии, служит для реализации "оптимистичной локировки". Изменения, сделанные курьером применяются только если ревизия не изменилась | * |
indexInCourierRoute | int | Индекс маршрута курьера | * |
phoneNumber | string | Номер телефона заказа | |
comment | string | Комментарий к заказу | |
customer | Клиент заказа | ||
customerName | string | Имя клиента, используется только, если в доставке не задан клиент | |
orderSum | decimal | Сумма заказа | * |
address | Адрес заказа | * | |
deliveryNumber | string | Номер заказа | * |
deliveryTerminal | DTO доставочного терминала | ||
cancelTime | string | Дата и время отмены заказа | |
deliveryOperator | string | Оператор заказа | |
items | Список Dto для элемента меню доставочного заказа. | ||
paymentItems | List<DeliveryPaymentItem> | Список Dto для элемента оплаты доставочного заказа. | |
discountOrIncreaseSum | decimal | Скидка/надбавка | |
deliveryDiscount | DTO для описание скидки мобильной версии доставки | ||
orderLocationInfo | Координаты адреса доставочного заказа |
Элемент оплаты заказа
sum | decimal | Сумма к оплате | * |
paymentType | Тип оплаты (одно из полей: id, code является обязательным) | * | |
isProcessedExternally | bool | Является ли позиция оплаты проведенной | * |
isPreliminary | bool | Является ли позиция оплаты предварительной | |
isExternal | bool | Принята ли позиция оплаты извне | |
additionalData | string | Дополнительная информация |
Тип оплаты
id | Guid | Идентификатор типа оплаты | |
code | string | Код типа оплаты | |
name | string | Название типа оплаты | |
comment | string | Комментарий к типу оплаты | |
combinable | bool | Признак комбинируемости | |
externalRevision | long? | Номер ревизии сущности из РМС | |
applicableMarketingCampaigns | Guid[] | Массив маркетинговых акций, связанных с типом оплаты iikoCard5, применяемых для данной организации. |
Заказчик
Наименование | Тип | Комментарий | Макс.длина | |
id | Guid | Идентификатор | ||
name | string | Имя | 60 | * |
phone | string | Телефонный номер. Регулярное выражение, которому должен соответствовать телефон. | 40 | * |
cultureName | string | Языковая культура пользователя, пример: RU-ru | ||
favouriteDish | string | Любимое блюдо пользователя | ||
birthday | День рождения | |||
string | 60 | |||
nick | string | Никнэйм | 60 | |
middleName | string | Отчество | 60 | |
surName | string | Фамилия | 60 | |
shouldReceivePromoActionsInfo | bool | Получает ли пользователь информацию о промо акциях | ||
sex | string | Пол: NotSpecified, Male, Female | ||
imageId | Guid | Идентификатор изображения пользователя | ||
balance | decimal | Баланс пользователя | ||
isBlocked | bool | Заблокирован ли пользователь в организации | ||
additionalPhones | Дополнительные телефоны | |||
addresses | Адреса | |||
cards | GuestCardInfo[] | Карты |
Адрес
Наименование | Тип | Комментарий | Макс.длина | Обяз. |
city | string | Наименование города | 255 | * |
street | string | Наименование улицы | 255 | * |
streetId | Guid | Идентификатор улицы (если справочник улиц синхронизирован с справочником улиц в RMS) | ||
streetClassifierId | string | Идентификатор улицы в классификаторе, например, КЛАДР. | 255 | |
home | string | Дом | 10 | * |
housing | string | Корпус | 10 | |
apartment | string | Квартира | 10 | |
entrance | string | Подъезд | 10 | |
floor | string | Этаж | 10 | |
doorphone | string | Домофон | 10 | |
comment | string | Дополнительная информация | 500 | |
regionId | Guid | Идентификатор района, к которому относится адрес | ||
externalCartographyId | string | Идентификатор адреса во внешней картографической системе | 255 | |
index | string | Индекс улицы в адресе, если есть | 255 |
Адрес
Наименование | Тип | Комментарий | Макс.длина | Обяз. |
city | string | Наименование города | 255 | * |
street | string | Наименование улицы | 255 | * |
streetId | Guid | Идентификатор улицы (если справочник улиц синхронизирован с справочником улиц в RMS) | ||
streetClassifierId | string | Идентификатор улицы в классификаторе, например, КЛАДР. | 255 | |
home | string | Дом | 10 | * |
housing | string | Корпус | 10 | |
apartment | string | Квартира | 10 | |
entrance | string | Подъезд | 10 | |
floor | string | Этаж | 10 | |
doorphone | string | Домофон | 10 | |
comment | string | Дополнительная информация | 500 | |
regionId | Guid | Идентификатор района, к которому относится адрес | ||
externalCartographyId | string | Идентификатор адреса во внешней картографической системе | 255 | |
index | string | Индекс улицы в адресе, если есть | 255 |
Телефон.
phone | string | Номер телефон | * |
DTO доставочного терминала
Name | string | Название доставочного терминала |
DTO для описание скидки мобильной версии доставки
CardNumber | string | Номер скидочной карты | * |
DTO c координатами адреса доставочного заказа
latitude | decimal | Широта | * |
longitude | decimal | Долгота | * |
Dto для элемента меню доставочного заказа
Amount | decimal | Количество | * |
Price | decimal | Цена | * |
Product | Dto, описывающее блюдо | * | |
Status | string | Статус | * |
Modifiers | Список Dto, описывающих модификаторы блюда |
Dto, описывающее блюдо
Name | string | Название элемента блюда | * |
Dto, описывающий модификаторы блюда
Amount | decimal | Количество | * |
Price | decimal | Цена | * |
Product | Блюдо | * | |
Sum | decimal | Сумма | * |
Настройки мобильного приложения курьера доставки для данного ресторана
organizationId | Guid | ID организации | * |
isValidateCourierLocationOnCompleteDelivery | bool | Флаг, устанавливающий, необходимо ли при утверждении заказа курьером проверять, что он находится на расстоянии не больше, чем указанное в RangeAroundAddressForCompleteDelivery, от адреса доставаки. Если в true, то проверка выполняется. | * |
rangeAroundAddressForCompleteDelivery | decimal? | Максимальное расстояние от адреса доставки, на котором можно пометить заказ как доставленный | * |
updateFrequency | int? | Частота обновления мобильного приложения в секундах | |
showAlertTimerInMobile | bool | Показывать ли таймер обратного отсчета в мобильном приложении |
OlapReports
Перечисление типов олап отчетов.
Содержит следующие значения:
Sales | Тип олапа - отчет по продажам |
Transactions | Тип олапа - отчет по транзакциям |
Deliveries | Тип олапа - отчет по доставкам |
Информация о колонках олапа
columnsData | String | JSON с информацией о колонках олапа в виде строки(спецсимволы экранированы) | * |
organizationId | Guid | идентификатор организации в iikoBiz |
Запрос на построение олап-отчета
organizationId | Guid | идентификатор организации в iikoBiz, для которой будет построен олап-отчет | * |
olapSettings | String | JSON с информацией о настройках олап-отчета, на основе которых он будет построен, в виде строки строки(спецсимволы экранированы). Ссылка на описание формата поля: https://ru.iiko.help/articles/api-documentations/olap-2/a/h2_266754401 | * |
Запрос на построение олап-отчета
organizationId | Guid | идентификатор организации в iikoBiz, для которой построен олап-отчет | * |
data | String | JSON с информацией по олап-отчету в виде строки(спецсимволы экранированы) | * |
summary | String | JSON с информацией по подитогам олап-отчета в виде строки(спецсимволы экранированы) | * |
Список видов преднастроенных олапов для заданной организации
organizationId | Guid | идентификатор организации в iikoBiz, для которой запрошены виды преднастроенных олапов | * |
presets | String[] | JSON со списком видов преднастроенных олапов, доступных для заданной организации | * |
Запрос на получение преднастроенного олап-отчета
dateTo | Sting | дата “с” в формате “yyyy-MM-dd” | * |
dateFrom | String | дата “по” в формате “yyyy-MM-dd” | * |
presetId | Guid | идентификатор преднастроенного олап-отчета. см. OlapReportPresetResponse поле presets |
Запрос на добавление проблемы к доставочному заказу.
orderId | Guid | Id доставочного заказа | * |
problemText | String | Текст проблемы. | * |
Запрос для задания курьера заказу.
courierId | Guid | Id курьера. | * |
orderId | Guid | Id заказа. | * |
Запрос для изменения статуса заказа курьером, отмечающий его как доставленный или “не доставленный”.
courierId | Guid | Id курьера. | * |
orderId | Guid | Id заказа. | * |
delivered | bool | Флаг доставлен/не доставлен. true - запрос переводит заказ из On way в delivered, false - в обратную сторону. | |
actualDeliveryTime | Фактическое время доставки. |
Запрос на построение журнала событий
organizationId | Guid | идентификатор организации в iikoBiz, для которой будет построен олап-отчет | * |
eventsSettings | String | JSON с информацией о настройках журнала событий, на основе которых он будет построен, в виде строки (спецсимволы экранированы) | * |
Ответ с данными по журналу событий
organizationId | Guid | идентификатор организации в iikoBiz, для которой построен олап-отчет | * |
data | String | JSON с информацией по журналу событий в виде строки (спецсимволы экранированы) | * |
info | String | JSON с дополнительной информацией по журналу событий в виде строки (спецсимволы экранированы) |
Доставочный терминал
deliveryTerminalId | Guid | Идентификатор доставочного терминала | * |
crmId | String | CrmId ресторана, к которому относится доставочный терминал | * |
restaurantName | String | Наименование доставочного терминала | * |
externalRevision | long | Номер ревизии сущности из РМС | |
technicalInformation | String | Техническая информация | |
address | String | Адрес ресторана | |
protocolVersion | int | Версия протокола 0 для старых версий рмс, 1 и выше для версий от 7.1.2 и старше (поддержка в api с версии 7.1.5) |
Информация о скидке
departmentCrmIds | string[] | Список CrmId ресторанов, в которых применяется скидка. Если null или пустой, то применяется во всех предприятиях | * |
id | Guid | Идентификатор скидки в РМС. | * |
name | string | Наименование скидки. | * |
percent | decimal | Общий процент скидки. Игнорируется, если задано isCategorisedDiscount. | * |
isCategorisedDiscount | bool | Является или нет скидкой по категориям. если true, то применяются скидки из prodcutCategoryDiscounts. | * |
productCategoryDiscounts | Скидки по категориям. | * | |
comment | string | Комментарий. | |
canBeAppliedSelectively | bool | Допускает ли скидка выборочное применение к отдельным блюдам на усмотрение пользователя. | * |
minOrderSum | decimal | Минимальная сумма заказа, необходимая для применения скидки. Если сумма заказа меньше указанного порога, скидка не действует. | |
mode | string | Режим скидки. Возможные значения:
| * |
sum | decimal | Фиксированнаясумма скидки. Работает, если тип скидки на сумму с фиксированной преднастроенной суммой. | * |
isManual | bool | Возможно или нет применять руками. | * |
isCard | bool | Скидка по карте. | * |
canApplyByCardNumber | bool | Можно ли применять по номеру карты. Если true, то для применения скидки достаточно ввести номер скидочной карты(прокатка карты не требуется). | * |
isAutomatic | bool | Может ли скидка применяться автоматически. | * |
Гость доставки
id | Guid | Идентификатор гостя | * |
name | string | Имя гостя | * |
Информация по скидкам
discountCardTypeId | Guid | Идентификатор скидки | * |
discountCardSlip | String | Трек скидочной карты | |
discountOrIncreaseSum | decimal | Сумма скидки | * |
Часы работы организации
dayOfWeek | int | Номер для недели, для которого указывается время работы. Нумерация начинается c 0, которому соответствует понедельник | * |
from | string | Время, с которого работает заведение. Строка в формате “hh:mm”, где hh - час (от 00 до 23); mm - минута (от 00 до 59); | |
to | string | Время, до которого работает заведение. Строка в формате “hh:mm”, где hh - час (от 00 до 23); mm - минута (от 00 до 59); | |
allDay | bool | Флаг отображающий, что заведение работает 24 часа | * |
closed | bool | Флаг отображающий, что заведение не работает в этот день | * |
Регион из справочника регионов в iikoRMS
id | Guid | Уникальный идентификатор | * |
name | string | Название | * |
externalRevision | long? | Номер ревизии сущности из РМС |
Город
id | Guid | Уникальный идентификатор | * |
name | string | Название | * |
classifierId | string | Идентификатор города в классификаторе, например, КЛАДР | |
additionalInfo | string | Дополнительная информация о городе в свободном формате | |
externalRevision | long? | Номер ревизии сущности из РМС |
Группа
id | Guid | Уникальный идентификатор | * |
name | string | Название | * |
cityId | Guid | Идентификатор города | |
classifierId | string | Идентификатор улицы в классификаторе, например, КЛАДР | |
externalRevision | long? | Номер ревизии сущности из РМС |
Город с коллекцией улиц
city | Ссылка на город | * | |
streets | Коллекция улиц, принадлежащих городу | * |
Группа
id | Guid | Уникальный идентификатор | |
name | string | Название | |
code | string | Артикул | |
description | string | Описание | |
order | int | Порядок отображения | |
parentGroup | Guid | Родительская группа | |
images | URLs картинок | ||
imageId | Guid | Идентификатор картинки(устарело) | |
isIncludedInMenu | bool | Нужно ли группу отображать в дереве номенклатуры | |
additionalInfo | string | Дополнительная информация | |
tags | String[] | Тэги | |
seoDescription | string | SEO-описание для клиента | |
seoKeywords | string | SEO-ключевые слова | |
seoText | string | SEO-текст для роботов | |
seoTitle | string | SEO-заголовок |
Продукт
id | Guid | Уникальный идентификатор | |
name | string | Название |
Продукт
id | Guid | Уникальный идентификатор | |
name | string | Название | |
code | string | Артикул | |
description | string | Описание | |
order | int | Порядок отображения | |
parentGroup | Guid | Родительская группа | |
images | Описание картинок | ||
imageId | Guid | Идентификатор картинки(устарело) | |
groupId | Guid | Идентификатор группы | |
productCategoryId | Guid | Идентификатор категории продукта | |
price | decimal | Цена | |
carbohydrateAmount | decimal | Количество углеводов на 100 г блюда | |
energyAmount | decimal | Энергетическая ценность на 100 г блюда | |
fatAmount | decimal | Количество жиров на 100 г блюда | |
fiberAmount | decimal | Количество белков на 100 г блюда | |
carbohydrateFullAmount | decimal | Количество углеводов в блюде | |
energyFullAmount | decimal | Энергетическая ценность в блюде | |
fatFullAmount | decimal | Количество жиров в блюде | |
fiberFullAmount | decimal | Количество белков в блюде | |
weight | decimal | Вес одной единицы в кг | |
type | string | Тип:
| |
isIncludedInMenu | bool | Нужно ли продукт отображать в дереве номенклатуры | |
modifiers | Modifer[] | Одиночные модификаторы | |
groupModifiers | Modifer[] | Групповые модификаторы | |
additionalInfo | string | Дополнительная информация | |
tags | String[] | Тэги | |
MeasureUnit | string | Единица измерения товара ( кг, л, шт, порц.) | |
doNotPrintInCheque | bool | Блюдо не нужно печатать на чеке. Актуально только для модификаторов. | |
seoDescription | string | SEO-описание для клиента | |
seoKeywords | string | SEO-ключевые слова | |
seoText | string | SEO-текст для роботов | |
seoTitle | string | SEO-заголовок | |
prohibitedToSaleOn | Guid[] | Список ID терминалов, на которых продукт запрещен к продаже | |
differentPricesOn | Список терминалов, на которых цена продукта отличается от стандартной и цен на них. | ||
useBalanceForSell | bool | Товар продается на вес |
Модификатор
modifierId | Guid | Идентификатор модификатора. Идентификатор продукта для одиночного модификатора и идентификатор группы - для группового. | * |
maxAmount | int | Максимальное количество модификатора | |
minAmount | int | Минимальное количество модификатора | |
defaultAmount | decimal | Количество по умолчанию | |
hideIfDefaultAmount | boolean | Признак того, что не нужно отображать список модификаторов, если их количество равно количеству | |
childModifiersHaveMinMaxRestrictions | boolean | Признак того, что дочерние модификаторы имеют ограничения. Актуально только для групповых модификаторов. | |
childModifiers | ChoiceBindings[] | Дочерние модификаторы. Бывают только для групповых модификаторов. |
Описание картинки
imageId | Guid | Идентификатор картинки | * |
imageUrl | string | URL для загрузки картинки | * |
uploadDate | string | Дата выгрузки картинки в формате "yyyy-MM-dd HH:mm:ss" |
Цена на терминале, отличная от стандартной
terminalId | Guid | Идентификатор терминала, на котором цена отличается от стандартной | |
price | decimal | Цена на терминале | |
priceCategory | Guid? | Идентификатор ценовой категории терминала |
Дата и время.
Строка в формате “YYYY-MM-DD hh:mm:ss”, где
YYYY - год;
MM - месяц (начиная с 1 - январь);
DD - день;
hh - час (от 00 до 23);
mm - минута (от 00 до 59);
ss - секунда (от 00 до 59).
Дата и время в UTC.
Строка в формате “YYYY-MM-DD hh:mm:ss zzz”, где
YYYY - год;
MM - месяц (начиная с 1 - январь);
DD - день;
hh - час (от 00 до 23);
mm - минута (от 00 до 59);
ss - секунда (от 00 до 59);
zzz - информация о часовом поясе;
Пример: 2013-04-22 09:52:27 +04:00
Строка в формате “dd.MM.yyyy”
Период времени.
Строка в формате “hh:mm:ss”, где
hh - час (от 00 до 23);
mm - минута (от 00 до 59);
ss - секунда (от 00 до 59).