Получение информации об онлайн-заказе

CASHDESK API

API (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.

Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2. С инструкцией авторизации по API можно ознакомиться здесь.

Получение онлайн заказа

Подготовьте GET запрос следующего вида:

base URL: https://kassa.bifit.com/cashdesk-api/v1/protected/online_orders/id?

В HEADERS укажите значение access_token согласно:

authorization: Bearer <значение acces_token>

В PARAMS запроса укажите данные, согласно структуре описанной в SWAGGER.

Пример ответа на запрос.

 {
    "id": 320528,                                            ''//id онлайн заказа'' 
    "visible": true,                                         ''//Признак видимости заказа'' 
    "created": 1645690408369,                                ''//Время создания в формате UNIX TIME''
    "changed": 1645691489120,                                ''//Время создания в формате UNIX TIME''
    "organizationId": "<''organization_id''>",              ''//ID организации''
    "tradeObjectId": "<''trade_object_id''>",               ''//ID торгового объекта''
    "taxSystem": "COMMON",                                  ''//Система налогообложения '''COMMON''' - ОСН (см. [[#Систем налогообложения|Таблица систем налогообложения]])''
    "externalId": "112345",                                 ''//Номер заказа в информационной системе интегратора''
    "deliveryType": "COURIER",                              ''//Тип доставки '''COURIER''' - Курьером (либо '''SELF''' - Самовывоз)''
    "deliveryAmount": null,                                 ''//''
    "deliveryTime": 1645690416000,                          ''//Время доставки в формате UNIX TIME''
    "paid": false,                                          ''//Признак оплаты заказа''
    "orderTime": 1645690388467,
    "clientId": 195363,                                     ''//ID клиента''
    "address": "Адрес",                                     ''//Адрес доставки''
    "responsiblePersonLogin": "79775553322",                ''//Логин (номер телефона) ответственного сотрудника. После создания заказа логин будет равен логину создателя заказа''
    "discount": 0.00,                                       ''//Величина скидки на заказ ('''не используется''')''
    "discountType": 0,                                      ''//Тип скидки на заказ ('''не используется''')''
    "location": null,                                       ''//GPS координаты курьера''
    "totalAmount": 3000.00,                                 ''//Итоговая стоимость заказа''
    "comment": null,                                        ''//Комментарий к заказу''
    "currentStatusType": "DISTRIBUTED",                     ''//Текущий статус заказа NEW - новый, только что созданный заказ (см. [[#Статусы заказов|Таблица статусов заказов]])''
    "currentStatusTime": 1645691012245,                     ''//Время изменения статуса заказа в формате UNIX TIME''
    "substatusId": null,                                    ''//ID пользовательского статуса''
    "shopId": null,                                         ''//ID интернет витрины''
    "endLockTime": 1645691458615,
    "routeSheetDocumentId": null,                           ''//ID Маршрутного листа''
    "routeSheetDocumentPosition": null,                     ''//Номер позиции заказа в маршрутном листе''
    "routeSheetDocumentNumber": null,
    "size": null,
    "actualDeliveryTime": 1645691458616,
    "cashierName": null,                                    ''//Имя кассира''
    "clientName": null                                      ''//Имя клиента''
 }

Системы налогообложения

Таблица систем налогообложения

Значение нумератора	Описание
COMMON	(ОСН - Общая система налогообложения)
SIMPLIFIED	(УСН 6% с дохода)
SIMPLIFIED_WITH_EXPENSE	(УСН 15% доход - расход)
ENVD	(ЕНВД не используется с 01.01.2020)
COMMON_AGRICULTURAL	(ЕСН или ЕСХН)
PATENT	(ПАТЕНТНАЯ система налогообложения)

Статусы заказов

Таблица статусов заказов

Значение нумератора	Описание
NEW	НОВЫЙ
ACCEPTED	ПОДТВЕРЖДЕН
DISTRIBUTED	РАСПРЕДЕЛЕН
ISSUED	ВЫДАННЫЙ
REFUSED	ОТКАЗ
DELETED	УДАЛЕН
FINISHED	ЗАВЕРШЕН

 Примечание

• При создании заказа, есть несколько видов доставки. Ознакомьтесь с типами доставки:
  • "COURIER" - в случае, если используется курьерская доставка
  • "SELF" - самовывоз, в этом случае адрес доставки не требуется, место расчетов в чеке берется из ККТ/ТО
  • "SERVICE" - не используется
• Каждому созданному заказу присваивается определенный статус. Ознакомьтесь со статусами заказов:
  • "ACCEPTED" - статус “Подтвержден”, заказы в данном статусе доступны для отображения всем сотрудникам на МКТ. Используем при создании заказа.
  • "DISTRIBUTED" - статус “Распределен”, заказы в данном статусе доступны для отображения на МКТ только тем сотрудникам, на которых эти заказы назначены.
  • "REFUSED" - статус “Отменен”, заказ с таким статусом невозможно создать, можно добавить статус с помощью PUT запроса, либо перевести заказ в данный статус из клиентского ПО, отменить заказ можно только в статусах "DISTRIBUTED","ACCEPTED". Статус REFUSED необходимо использовать при отмене заказа в статусах DISTRIBUTED и ACCEPTED.
  • "DELETED" - статус “Удален”, заказ с таким статусом невозможно создать, можно добавить статус с помощью PUT запроса, заказ, в статусе “Удален” не будет доступен для работы, удалить можно только заказ в статусе "currentStatusType": "NEW". Статус DELETED необходимо использовать при отмене заказа только в статусе NEW.