Портал поддержки продуктов CSI
Публичный ресурс
Структура событий
Формат.
json
Структура
type | value | required | Назначение | |||||
| version | string | 3.0. | да | Версия протокола. При отсутствии атрибута json-документ считается версии 2.0. | ||||
events | array | |||||||
event | object | да | ||||||
prefix | string[3] | dict | да | Тип устройства | ||||
shop | integer | 0..N | да | Номер магазина | ||||
| shopName | string | нет | Наименование магазина | |||||
device | integer | 0..255 | да | Номер устройства | ||||
| deviceName | string | нет | Наименование устройства | |||||
| shiftNumber | integer | 0..N | Номер смены | |||||
tabNumber | string | да | Табельный номер сотрудника | |||||
employee | string | да | ФИО сотрудника | |||||
code | integer | 1..N | да | Номер события | ||||
dateTime | string | да | Время события в формате dd.MM.yyyy HH:mm:ss.SSS или yyyy-MM-dd HH:mm:ss.SSS | |||||
session | object | Информация о пользовательской сессии | ||||||
role | string | dict | Роль | |||||
mode | string | dict | Режим работы | |||||
login | string | Логин пользователя | ||||||
document | object | Информация о документе | ||||||
type | string | dict | да | Тип документа | ||||
number | string | да | Номер | |||||
| extraType | string | dict | Тип связанного документа: МЧ, ОЧ, накладная... | |||||
| extraDevice | integer | Номер устройства, на котором оформлен связанный документ. | ||||||
| extraShiftNumber | integer | Номер смены, в которой оформлен связанный документ. | ||||||
extraNumber | string | Номер связанного документа | ||||||
| extraDateTime | string | Дата и время оформления связанного документа в формате dd.MM.yyyy HH:mm:ss.SSS или yyyy-MM-dd HH:mm:ss.SSS | ||||||
amount | number | Сумма документа | ||||||
goods | object | |||||||
pos | string | 1..N | да | Номер позиции/идентификатор строки в документе | ||||
item | string | да | Артикул | |||||
barcode | string | Штриховой код | ||||||
identifier | string | Идентификатор: акцизная или специальная марка, GS1 barcode, | ||||||
| category | string | dict | Категория (группа) товара | |||||
name | string | Наименование | ||||||
type | string | dict | Тип товара | |||||
marked | boolean | Признак маркировки | ||||||
ageRestrict | boolean | Признак ограничения по возрасту | ||||||
measure | string | dict | Мерность | |||||
addedBy | string | dict | Способ ввода товара | |||||
basePrice | number | Регулярная цена | ||||||
quantity | number | Количество | ||||||
price | number | Цена продажи | ||||||
amount | number | Стоимость позиции | ||||||
discount | number | Размер скидки на позицию | ||||||
| expirationDate | string | Срок годности. Дата в формате dd.MM.yyyy или yyyy-MM-dd | ||||||
rejection | string | dict | Причина отклонения | |||||
card | object | Информация о карте лояльности | ||||||
type | string | dict | Тип | |||||
category | string | dict | Категория | |||||
addedBy | string | dict | Способ ввода номера карты | |||||
number | string | да | Номер | |||||
| customer | string | ФИО владельца | ||||||
amount | number | Бонусный, марочный баланс | ||||||
| operation | string | dict | Операция с картой | |||||
| rejection | string | dict | Причина отклонения | |||||
coupon | object | Информация о купоне | ||||||
type | string | Тип | ||||||
category | string | Категория | ||||||
number | string | да | Номер | |||||
| rejection | string | dict | Причина отклонения | |||||
discount | object | Информация о скидке | ||||||
type | string | dict | Тип | |||||
amount | number | Сумма скидки | ||||||
payment | object | Информация об оплате | ||||||
type | string | dict | да | Тип | ||||
code | string | dict | Код | |||||
cardNumber | string | Номер карты | ||||||
| cardHash | string | Хэш номера карты | ||||||
amount | number | да | Сумма | |||||
| rejection | string | dict | Причина отклонения | |||||
processing | object | инфо по обращению в процессинговый центр (товар, скидка, оплата, документ, ...) | ||||||
type | string | dict | Имя | |||||
request | string | Запрос (операция) | ||||||
result | string | Результат | ||||||
| dialog | ||||||||
| category | string | dict | Категория | |||||
| message | string | Сообщение/вопрос кассиру | ||||||
| value | string | Значение введённое/выбранное кассиром. | ||||||
| response | string | dict | Реакция/ответ на сообщение | |||||
| error | ||||||||
| category | string | dict | Категория ошибки | |||||
| code | string | Код ошибки | ||||||
text | string | Текст ошибки | ||||||
| persons | ||||||||
| number | integer | Количество человек | ||||||
| info | object | |||||||
| sex | string | Пол {male|female} | ||||||
| age | number | Возраст | ||||||
| emotion | string | Эмоция | ||||||
| vehicle | ||||||||
| number | string | Государственный номер транспортного средства | ||||||
| offline | boolean | Признак offline-события | ||||||
Схема.
Пример.
© 1994-2023, ООО "Кристалл Сервис Интеграция".
Все права защищены.