Рассчитать чек
#
POST /checks/getProcessedCheckPOST /checks/getProcessedCheck
#
ОписаниеМетод getProcessedCheck предназначен для применения скидочного и бонусного процессинга к чеку, пробиваемому на кассе магазина. Данный метод необходимо вызывать перед фискализацией чека для получения информации о возможных вариантах этой фискализации и для озвучивания этих вариантов покупателю. В ответ метод возвращает на кассу чек с примененными к нему скидками по доступным акциям и программам поощрений. Также, в ответе приходит баланс бонусов, доступный для списания, и баланс бонусов, который будет начислен на счет покупателя после совершения покупки
#
ПараметрыТип | Имя | Описание | Схема |
---|---|---|---|
Query | apiKey обязательно | Апи ключ кассы | string |
Query | retailer обязательно | Код торговой сети | string |
Body | body обязательно | Кассовый чек в формате JSON | CheckJson |
#
ОтветыHTTP код | Описание | Схема |
---|---|---|
200 | successful operation | CheckJson |
801 | Неизвестный код торговой сети | Без содержимого |
810 | Дисконтная карта клиента не найдена по номеру | Без содержимого |
#
Возвращаетapplication/json
#
Определения#
CheckJsonИмя | Описание | Схема |
---|---|---|
purchases обязательно | Описание чека | Purchases |
#
PurchasesИмя | Описание | Схема |
---|---|---|
count обязательно | Количество чеков в документе | integer (int64) |
purchase обязательно | Список чеков | < PurchaseType > array |
#
PurchaseTypeИмя | Описание | Схема |
---|---|---|
amount обязательно | Сумма чека | number (double) |
begintime обязательно | Дата пробития чека | string (date-time) |
cardList необязательно | Список дисконтных карт | < CardType > array |
cash необязательно | Код Кассы. Если отсутствует, то это документ реализации | string |
discountAmount необязательно | Сумма скидки | number (double) |
number обязательно | Номер Чека | string |
operationType обязательно | Тип операции. True - документ оплаты чека/реализации. False - документ возврата чека/реализации | boolean |
paymentList обязательно | Платежи | < PaymentType > array |
shift обязательно | Номер смены | integer (int64) |
shop обязательно | Код магазина | string |
tabNumber необязательно | Табельный номер кассира | string |
userName необязательно | Имя специалиста | string |
#
CardTypeИмя | Описание | Схема |
---|---|---|
number обязательно | Номер карты | string |
type обязательно | Тип карты | enum (INTERNAL, EXTERNAL, PRESENT, BONUS, COUPON_CARD, COUPON_RECEIPT, COUPON_PROCESSING, COUPON_UNIQUE, UNKNOWN) |
#
PaymentTypeИмя | Описание | Схема |
---|---|---|
type обязательно | Тип платежа. Произвольное значение, например Cash или Card | string |