Справочник по API Облака

Общая информация об API Облака Эвотор
Руководство по переходу на API Облака V2
Примеры использования API Облака
- Интеграция с облачными сервисами
- Интеграция с 1С
Авторизация запросов
Магазины
- Получить список магазинов
  GET /stores
Смарт-терминалы
- Получить список смарт-терминалов
  GET /devices
Сотрудники
Документы
Товары и модификации товаров
Группы товаров и группы модификаций
Задачи для массовых операций
- Получить информацию о состоянии задач
  GET /bulks
- Получить подробную информацию о состоянии определённой задачи
  GET /bulks/{bulk-id}
Push-уведомления
Схемы и дополнительные поля товаров
Вебхуки Облака
Запросы к Платформе ОФД
Запросы к Мобильному кассиру

Получить статус чека

POST

Сервис поможет передать информацию о чеке обратно клиенту.

Для корректной работы метода должен быть поднят веб-сервис, который принимает POST-запрос с JSON. Сервис должен поддерживать https соединение и не требовать авторизации. В ответ ожидаем код 200. Получить информацию о чеке можно также при работе в режиме без фискализации, в таком случае информация о чеке будет направлена после оплаты заказа.
URL веб-сервиса, на который придет запрос, вносится через почту mk@evotor.ru. В письме укажите номер телефона от Личного кабинета Эвотор и перечень терминалов (imei терминалов). Если необходимо внести наш ip-адрес в белый список на вашей стороне, сообщите об этом.
Если мы не получаем код 200 в ответе, сервис пытается отправить callback повторно через 10 секунд, затем 10 попыток с интервалом 40 секунд. Чеки, которые не были приняты от нас сервисом, сохраняются. Для переотправки чеков после устранения проблем можно использовать метод https://developer.evotor.ru/docs/api_v1_callback_reset.html

Тело запроса

{
  "fiscalization": {
    "receipt_uuid": "c2b8f7b6-f6cc-47fe-bf63-f9c2bf795a23",
    "device_time": "2024-02-26T12:07:45.000+00:00",
    "fiscalized": true,
    "error_message": null,
    "user_id": "01-000000003879870",
    "device_id": "352398085953570",
    "fiscalization_info": {
      "sessionNumber": 15,
      "fnNumber": "9999078902014628",
      "creationDate": "1684505160000",
      "creationDateFormatted": "20230519T1706",
      "fiscalDocumentNumber": "112",
      "kktRegistrationNumber": "68",
      "fiscalDocumentAttribute": "379262307"
    }
  },
  "receipt": {
    "client_email": "test@ya.ru",
    "user_id": "01-000000003879870",
    "cashier_uuid": "20201015-8BDE-4059-800A-D8FC74F5DDA5",
    "payment_type": "COMBO_PAY",
    "receipt_uuid": "c2b8f7b6-f6cc-47fe-bf63-f9c2bf795a23",
    "operation_type": "SELL",
    "payment_place": "Бирюлёвская ул., 19, Москва, Россия, 115404",
    "payment_address": "Бирюлёвская ул., 19, Москва, Россия, 115404",
    "should_print_receipt": true,
    "total_sum": "48.6",
    "payments": [
      {
        "uuid": "a77d1f2b-9de5-4d59-ac53-314f4247c6d3",
        "amount": 30,
        "payment_type": "ADVANCE"
      },
      {
        "uuid": "a88d1f8b-8de8-4d59-ac53-314f4247c6d3",
        "amount": 30,
        "payment_type": "CASH"
      }
    ],
    "positions": [
      {
        "position_uuid": "5d4c79d6-3a27-48dc-a434-9b2343aa99a4",
        "price": "60",
        "name": "Тыква",
        "measureName": "шт",
        "precision": 100,
        "quantity": 1,
        "tax": "NO_VAT",
        "type": "NORMAL",
        "settlement_method_type": "FULL"
      }
    ],
    "tapOnPhoneRefId": "0d0c79d6-3a27-48dc-a434-9b2343aa99a0",
    "reference_number": "1"
  }
}

Параметр

Описание

fiscalization

object

Фискальный объект

receipt_uuid

string

Уникальный идентификатор чека

device_time

string

Время устройства

fiscalized

boolean

Статус фискализации

error_message

string

Причина ошибки фискализации

user_id

string

Идентификатор пользователя в базе данных Эвотор. Чтобы получить его, обратитесь с запросом на mk@evotor.ru. В письме опишите сценарий использования API.

device_id

string

Идентификатор кассы. Чтобы получить его, используйте запрос GET mobilecashier.evotor.ru/api/v2/market/user/{userId}/devices.

fiscalization_info

object

Объект с информацией о фискальных данных чека

sessionNumber

integer

Номер сессии

fnNumber

string

Номер фискального накопителя

creationDate

integer

Дата и время фискализации неформатированные (можно игнорировать)

creationDateFormatted

string

Дата и время фискализации

fiscalDocumentNumber

integer

Фискальный номер документа

kktRegistrationNumber

integer

Номер ККТ

fiscalDocumentAttribute

integer

Фискальный номер атрибута

receipt

object

Объект чека

user_id

string

reference_number

string

Уникальный идентификатор транзакции Tap on phone

client_email

string

email, куда отправлен эл. чек

client_phone

string

Номер телефона, куда отправлена СМС с электронным чеком.

cashier_uuid

string

Идентификатор сотрудника. Чтобы получить его, используйте запрос GET mobilecashier.evotor.ru/api/v2/market/user/{userId}/staff.

payment_type

enum

Способ оплаты:

CASH — Наличными;
QR_PAY — «Плати QR» от Сбера;
TAP_ON_PHONE — Сервис «Tap On Phone» от Сбера;
ELECTRON — Безналичная оплата через автономный терминал эквайринга;
COMBO_PAY— Комбинированная оплата, в том числе оплата с зачетом аванса.

operation_type

enum

Способ оплаты:

SELL — Продажа;
PAYBACK — Возврат.

payment_place

string

Место расчета

payment_address

string

Адрес расчета

should_print_receipt

boolean

Был ли напечатан чек

total_sum

number

Итоговая сумма

sell_receipt_uuid

string

В случае operation_type = PAYBACK (возврат), уникальный идентификатор чека, по которому происходит возврат средств.

mdlp

string

Идентификатор места деятельности субъекта обращения в ИС МДЛП (при продаже лекарств)

note

string

Произвольный комментарий, не печатается на чеке и отображается только в приложении.

receiptDiscount

number

Скидка на чек в рублях

receipt_uuid

string<uuid64>

Уникальный идентификатор чека.

Пример: 2822c553-472b-4fc2-9dbc-0d8300000000

payments

object

Массив с платежами пользователя. Заполняется, если значение параметра payment_type в объекте receipt равняется COMBO_PAY.

uuid

string

Идентификатор платежа

payment_type

enum

Тип оплаты:

CASH — Наличными;
TAP_ON_PHONE — Сервис «Tap On Phone» от Сбера;
ELECTRON — Безналичная оплата через автономный терминал эквайринга;
ADVANCE — Авансовый платеж при пробитии закрывающего (итогового) чека.

amount

number

Сумма платежа

tap_on_phone_ref_id

string

Идентификатор транзакции tap on phone

positions

object

Массив с объектами позиций

position_uuid

string

Идентификатор позиции

price

BigDecimal

Стоимость позиции

settlement_method_type

enum

FULL — Полный расчет;
ADVANCE_PAYMENT — Аванс.

name

string

Наименование позиции

measureName

string

Единица измерения

quantity

BigDecimal

Количество товара

tax

string

NO_VAT — Без НДС;
VAT_0 — Основная ставка НДС 0%;
VAT_10 — Основная ставка НДС 10%;
VAT_10_110 — Расчётная ставка НДС 10%;
VAT_18 — Основная ставка НДС 20%;
VAT_18_118 — Расчётная ставка НДС 20%.

type

string

Тип товара:

NORMAL — Обычный;
WATER_MARKED — Бутилированная питьевая вода;
DAIRY_MARKED — Молоко и молочная продукция;
JUICE_MARKED — Соки и безалкогольные напитки;
ALCOHOL_MARKED — Маркированный алкоголь;
BEER_MARKED_KEG — Маркированное пиво (Кеги);
BEER_MARKED — Маркированное пиво;
ALCOHOL_NOT_MARKED — Немаркированный алкоголь;
TOBACCO_MARKED — Маркированный табак;
SHOES_MARKED — Маркированная обувь;
MEDICINE_MARKED — Маркированные лекарства;
WHEELCHAIRS_MARKED — Кресла-коляски;
SEVICE — Услуга;
PERFUME_MARKED — Маркированные духи;
PHOTOS_MARKED — Маркированная фотоаппаратура;
MEDICAL_DEVICES_MARKED — Маркированные медицинские изделия;
TYRES_MARKED — Маркированные шины;
LIGHT_INDUSTRY_MARKED — Маркированная продукция легкой промышленности;
DIETARY_SUPPLEMENTS_MARKED — БАДы (биоактивные добавки);
ANTISEPTIC_MARKED — Антисептики;
TOBACCO_PRODUCTS_MARKED — Маркированный альтернативный табак (сигары, кретек, кальянный табак и т.д.). Никотиносодержащая продукция (стики, жидкости и капсулы для электронных сигарет, курительные смеси для кальяна, не содержащие табак), в том числе безникотиновая продукция, согласно ППРФ от 30.11.2022 №2178;
JEWELRY_MARKED — Маркированные ювелирные изделия.

mark

string

Код маркировки

marks

array[]

Массив с кодами маркировки, количество кодов равняется количеству товара.

quantity_in_package

number

Количество товара в упаковке (при частичной продаже)

importation_data

object

Данные по импорту при продаже юр.лицу

country_origin_code

required

string

Код страны происхождения

customs_declaration_number

required

string

Номер таможенной декларации

excise

number

Номер акциза

agentInfo

object

Информация об агенте и поставщике

type

string

Тип агента

principal_inn

string

ИНН поставщика

principal_phone

string

Телефон поставщика

agent_phone

string

Телефон агента

subagent_phone

string

Телефон субагента

operation_description

string

Операция агента (текстовое поле)

transaction_operator_name

string

Наименование оператора перевода

transaction_operator_inn

string

ИНН оператора перевода

transaction_operator_phones

string

Телефон оператора перевода

transaction_operator_address

string

Адрес оператора перевода

receive_operator_phones

string

Телефон оператора по приему платежей

principal_name

string

Наименование поставщика

priceWithDiscount

number

Cтоимость единицы позиции со скидкой.

is_excisable boolean

string

Признак подакцизности товара (для сладких напитков).

allow_partial_sell

string

Разрешение на частичную продажу для определенных типов товаров (Табачная продукция, Лекарства, Парфюмерия):

NEVER — никогда;
ALWAYS — всегда;
ON_DEMAND — иногда;
null — для товара, не подходящего под частичную продажу.

prepayment_price

number

Сумма предоплаты.