Техническое описание экспорта данных из системы Мозг
Данная документация содержит всю необходимую информацию для разработки собственного экспорта данных из системы Мозг.
Общая информация
.Данные из системы Мозг можно получить в виде CSV файла по протоколу HTTPS.
Для работы экспорта необходима активная лицензия.
HTTP Метод | POST |
URL | https://mozg.rest/import?data |
Результат | Текст в формате CSV с разделителем ";" (точка с запятой) или сообщение об ошибке (UTF-8) |
В случае коробочной версии системы Мозг, вместо mozg.rest
указывается ip-адрес виртуальной машины.
Параметры
orgid | integer | Код организации в системе Мозг, находится в настройках системы Мозг в разделе "Импорт данных". |
dbid | integer | Код источника импорта в системе Мозг, находится в настройках системы Мозг в разделе "Импорт данных". |
impkey | string | Ключ импорта, находится в настройках системы Мозг в разделе "Импорт данных". |
type | string | Тип данных для получения |
fields | string | Необходимые поля, через запятую |
Типы данных
Rests | Рестораны
Спиосок ресторанов. Доступные значения fields:
SourceCode | integer | Код источника импорта |
Code | string | Код ресторана/концепции |
Name | string | Тип данных для получения |
ForImport | integer | Ресторан используется для импорта |
ForReport | integer | Ресторан используется для отчетов |
LastOrderDate | date | Дата последнего заказа ГГГГ-ММ-ДД |
Status | integer | Статус {0: удален, 3: активен} |
Halls | Залы
Список залов. Доступные значения fields:
SourceCode | integer | Код источника импорта |
Code | string | Код зала |
Name | string | Название зала |
RestCode | string | Код ресторана/концепции |
DepartCode | integer | Код подразделения |
Depart | string | Название подразделения |
Status | integer | Статус {0: удален, 3: активен} |
Guests | integer | Вместимость зала (кол-во гостей) |
Departs | Подразделения
Список подразделений в системе Мозг. Доступные значения fields:
Code | integer | Код подразделения |
Name | string | Название подразделения |
Active | integer | Активность {0: удален, 1: активен} |
Budgeting | integer | Участвует в планировании бюджета |
VisitType | string | Тип учета гостей {guest: гости, order: заказ} |
Dashboard | integer | Отображается на Dashboard |
PayTypes | Методы оплаты
Список методов оплаты. Доступные значения fields:
SourceCode | integer | Код источника импорта |
Code | string | Код метода оплаты |
Name | string | Название метода оплаты |
GroupCode | integer | Код группы метода оплаты |
Group | string | Группа метода оплаты |
Status | integer | Статус {0: удален, 3: активен} |
PayGroups | Группы методов оплаты
Список групп методов оплаты. Доступные значения fields:
Code | string | Код группы методов оплаты |
Name | string | Название группы методов оплаты |
Active | integer | Активность {0: удален, 1: активен} |
Type | integer | Тип метода оплаты {1: реальные деньги, 2: бонусы, 3: прочее} |
Plans | План выручки и гостей
Плановые показатели выручки и гостей. Доступные значения fields:
SourceCode | integer | Код источника импорта |
RestCode | string | Код ресторана/концепции |
DepartCode | string | Код подразделения |
Date | date | Дата планового значения ГГГГ-ММ-ДД |
ValueType | string | Тип значения {realsum: выручка, guest: гости} |
Value | float | Плановое значение |
Correct | float | Значение корректировки |
GoLists | Гоу-листы
Позиции меню добавленные в Гоу-лист. Доступные значения fields:
SourceCode | integer | Код источника импорта |
RestCode | string | Код ресторана/концепции |
ItemCode | string | Код позиции меню |
From | date | Дата начала периода ГГГГ-ММ-ДД |
To | date | Дата окончания периода ГГГГ-ММ-ДД |
Items | Меню
Список позиции меню. Доступные значения fields:
SourceCode | integer | Код источника импорта |
RestCode | string | Код ресторана/концепции |
Code | string | Код позиции |
Name | string | Название позиции |
Type | string |
Тип блюда {DISH: Блюдо, MODIFIER: Модификатор, PREPARED: Заготовка, GOODS: Товар, SERVICE: Услуга, RATE: Тариф} |
Portion | float | Порционный коэффициент |
Status | integer | Статус {0: удален, 3: активен} |
CategoryCode | integer | Код категории |
CategoryType | string | Тип категории {1: Кухня, 2: Бар, 3: Кальяны, 0: Услуги и прочее} |
Category | string | Название категории |
GroupCode | string | Код группы |
GroupPath | string | Путь группы (Группа1/Группа2/...) |
Group | string | Название группы |
TicketTime | json | Тикет-тайм приготовления, сек. {"0":20} |
Employees | Сотрудники
Позиции меню добавленные в Гоу-лист. Доступные значения fields:
SourceCode | integer | Код источника импорта |
RestCode |
string
|
Код ресторана/концепции
|
Code
|
string |
Код сотрудника
|
Name | string |
ФИО сотрудника
|
Status | integer | Статус {0: удален, 3: активен} |
Position
|
string | Должность |
Примеры
Запрос списка залов:
{
orgid: 45234,
dbid: 1,
impkey: "impkeysxrnWpRycQQaqxCwdGmukoFaiFPGzGZp",
type: "halls",
fields: "Code,Name,DepartCode"
}
Ответ:
10;Бар № 1;1
11;Зал № 1;1
12;Зал № 2;1