...
Совместимость версий API гарантируется в пределах мажорной версии. Т.е. версии 1.0, 1.1, 1.2 и т.д. совместимы, но версии 1.1 и 2.3, например, нет.
Импорт торговых данных
Архитектурные требования
Серверная архитектура кассовой системы диктует определенные требования к правилам загрузки информации из товаро-учетной системы: если во внешней товаро-учетной сстеме изменяется объект (или создается новый / удаляется ранее существовавший), то информация об этом должна быть передана кассовому серверу (API) только один раз. Далее кассовой сервер организует доставку этой информации до касс, к которым относится объект.
...
Если при загрузке объекта возникает ошибка, то не принимается весь пакет, а не только ошибочный объект.
Технические особенности
- Сервер УКМ 5 всегда выступает в роли сервера. Клиентом является товаро-учетная система.
- Авторизация не требуется. IT-службы клиента должны обеспечивать безопасность.
- Загрузка данных всегда производится партиями. Размер партии ограничен выделенным ресурсами. Рекомендуемый размер партии – 1000 записей.
- Рекомендуется загружать данные в один поток. Следующий запрос можно посылать только после получения ответа на предыдущий.
- При импорте проверяется соответствие данных схеме, а также наличие дубликатов.
- Загрузка данных всегда происходит в инкрементальном режиме. Т.е. новые данные дополняют уже имеющиеся.
- Для удаления данных используется поле deleted, которое присутствует во всех сущностях.
- Успешный импорт означает, что запрос сконвертирован во внутренний формат УКМ 5 и передан на дальнейшую обработку. Однако, из этого не следует, что он загружен в базу данных и передан на кассы.
Якорь | ||||
---|---|---|---|---|
|
В УКМ 5 поставщик может иметь признак, что он не является плательщиком НДС. В этом случае, касса использует специальную налоговую ставку. В противном случае, ставка НДС берется из товарного справочника. Такое упрощение было сделано сознательно, т.к. проблема может возникнуть только, если один и тот же поставщик реализует товары как по льготной ставке, так и по полной, что является редким случаем.
...
Блок кода | ||||
---|---|---|---|---|
| ||||
taxes: { tax0 = 2 tax1 = 1 tax2 = 3 tax3 = 4 tax4 = 6 tax5 = 5 } |
Реализация в недалеком будущем
По мере развития продукта СуперМаг УКМ5, планируется реализация следующих параметров, формальное наличие которых в API-документации на текущий момент не означает, что они функционально реализованы:
...
fpCode – код налоговой группы в фискальном устройстве.
Якорь | ||||
---|---|---|---|---|
|
Особенности
Экспорт продаж может происходить двумя способами:
...
В обоих вариантах взаимодействия авторизация не требуется. Безопасность обеспечивается IT-службами клиента.
Якорь | ||||
---|---|---|---|---|
|
Для метода /api/v1/export/receiptPackage существует ряд запросов:
№ | Название запроса | Тип запроса | Параметры запроса | Код ответа | Тело ответа |
---|---|---|---|---|---|
1 | Выгрузка чеков с подтверждением | GET | 200 | Чеки со статусом выгрузки Невыгруженные чеки. Количество чеков в пачке ограничено параметром Размер пачки. | |
700 | Имеется блокировка на выгрузку. | ||||
500 | Ошибка, описание ошибки. | ||||
2 | Подтверждение получения и обработки пачки чеков | PUT | 200 | Ok. | |
500 | Ошибка, описание ошибки. | ||||
3 | Удаление блокировки | DELETE | 200 | Ok. | |
500 | Ошибка, описание ошибки. |
Якорь | ||||
---|---|---|---|---|
|
Якорь | ||||
---|---|---|---|---|
|
...