Протокол обмена представляет собой REST API. Данный подход позволяет интегрировать решение практически в любую систему, где есть возможность обмена данными по HTTP.

После включения устройства в вашу локальную сеть, рекомендуется выдать ему статический IP адрес и выдать локальное DNS имя (если это возможно).

Система является асинхронной, нет гарантии, что чек будет отпечатан немедленно, так как в один момент времени кассовый аппарат можем работать только с одним чеком. Все чеки попадают в очередь на печать и будут отпечатаны по принципу FIFO (first in first out). Также система отдает более высокий приоритет чекам от кассира, чтобы не задерживать покупателя. Онлайн чеки идут с меньшим приоритетом. Весь процесс отслеживания описан в соответствующем разделе.

Печать чека продажи

POST

/_api/receipts

В тело запроса надо передать json объект следующего вида:

{
	"items": [{
		"name": "Чипсы Lays",
		"price": 100,
		"quantity": 1
	}, {
		"name": "Сухарики",
		"price": 50,
		"quantity": 2
	}],
	"payments": [{
		"type": 0,
		"amount": 200
	}]
}

В случае успешного приема чека, будет выдан HTTP код ответа 200, а в теле документа будет json объект чека:

{
    "receipt": {
        "uuid": <UUID>,
        "status": "PENDING",
        ...
    }
}

uuid является уникальным идентификатором чека и этот идентификатор можно использовать для отслеживания статуса печати чека.

Список всех доступных параметров с их описанием:

{
	"type": "sell",
	"items": [
		{
			"type": "service"
			"name": "Доставка",
			"price": 100,
			"quantity": 1,
			"pay_type": "advance"
		},
		{
			"name": "Чипсы Lays",
			"price": 100,
			"quantity": 1
		},
		{
			"name": "Сухарики",
			"price": 50,
			"quantity": 2,
			"supplier_inn": "123456789",
            "supplier": {
                "name": "ООО Поставщик",
                "phone": "+123456789"
            },
            "agent": {
                "name": "ООО Агент",
                "INN": "3644065397",
                "address": "Тестовый адреса 16, офис 3",
                "phones": [ "+123456789" ]
            }
		}
	],
	"payments": [{
		"type": 0,
		"amount": 200
	}],
    "email": "client@mail.ru",
	"print": true,
    "caption": "Заказ #123456",
    "barcode": "V123456",
    "autoDelete": false,
	"agent_types": [ "payingAgent", "bankPayingAgent" ],
    "tax_system": "patent"
}

Описание:

Описание полей items

Примеры чеков

Чек предоплаты

Предоплата по заказу с оплатой наличными

{
    "type": "sell",
    "print": true,
    "items": [
        {
            "name": "Предоплата по заказу №123",
            "price": 100,
            "quantity": 1,
            "type": "service",
            "pay_type": "advance"
        }
    ],
    "payments": [
        {
            "type": 0,
            "amount": 100
        }
    ]
}

Статус чека

Возвращает информацию о чеке по его UUID

GET

/_api/receipts/{uuid}

{
    "receipt": {
        "uuid": <UUID>,
        "status": "PENDING"
    }
}

Удаление чека

Рекомендуется удалить чек после того, как мы отследили его статус, чтобы он удалился из системы немедленно. Для этого можно послать следующий DELETE запрос:

DELETE

/_api/receipts/{uuid}

В случае успешного удаления чека код ответа будет HTTP 204

Отслеживание статуса чека

Как говорилось выше, вся система является асинхронной и требуется дополнительная обработка, чтобы узнать наверняка, был ли распечатан чек или нет.

Весь процесс выглядит следующим образом:

1. Отправляем чек на печать, получаем его UUID
2. Используя этот UUID запрашиваем статус чека до тех пор, пока поле status не примет значение SUCCESS или ERROR.
3. Если status чека равен ERROR, то в поле errorMessage можно посмотреть текст ошибки
4. Удаляем чек