Создание маршрутного листа

CASHDESK API

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

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

Нумераторы

TaxSystem - cистема налогообложения (тэг 1055). Если при регистрации устройства в ФНС было выбрано более одного режима налогообложения, то в TaxSystem необходимо указать, к какой системе налогообложения относится данный чек.
COMMON SIMPLIFIED SIMPLIFIED_WITH_EXPENSE COMMON_AGRICULTURAL PATENT	ОСН УСН доход УСН доход - расход ЕСХН ПАТЕНТ

СurrentStatusType - Статусы онлайн-заказов
NEW ACCEPTED DISTRIBUTED ISSUED REFUSED DELETED FINISHED	НОВЫЙ ПОДТВЕРЖДЕН РАСПРЕДЕЛЕН ВЫДАННЫЙ ОТКАЗ УДАЛЕН ЗАВЕРШЕН

Создание маршрутного листа

Запрос	POST
URL: https://kassa.bifit.com/cashdesk-api/v1/protected/route_sheet_document	https://kassa.bifit.com/cashdesk-api/v1/protected/route_sheet_document

 Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение acces_token> .

Request Body

type: raw (JSON)

document: amount: Сумма заказов маршрутного листа cashierName: Имя кассира courierUserId: ID курьера courierUserName: Логин (номер телефона) курьера description: Описание documentDate: Дата создания маршрутного листа в формате UNIX TIME * documentNumber: Номер маршрутного листа * firstDeliveryTime: Время первой доставки * lastDeliveryTime: Время последней доставки * ordersCount: Количество заказов * organizationId: ID организации * priority: Приоритетность маршрутного листа в системе * responsiblePerson: Ответственный сотрудник responsibleUserId: ID Ответственного сотрудника * status: Статус маршрутного листа * tradeObjectId: ID торгового объекта * items: organizationId: ID организации * tradeObjectId: ID торгового обекта * taxSystem: Система налогообложения * externalId: Номер онлайн-заказа * deliveryType: Тип доставки * deliveryAmount: Стоимость доставки deliveryTime: Время доставки в формате UNIX TIME * paid: Признак оплаты заказа * orderTime: Время заказа UNIX TIME * clientId: ID клиента * address: Адрес доставки * responsiblePersonLogin: Логин (номер телефона) ответственного сотрудника. После создания заказа логин будет равен логину создателя заказа * location: GPS координаты курьера totalAmount: Итоговая стоимость заказа * comment: Комментарий к заказу currentStatusType: Текущий статус заказа NEW - новый, только что созданный заказ * currentStatusTime: Время изменения статуса заказа в формате UNIX TIME * substatusId: ID пользовательского статуса shopId: ID интернет витрины endLockTime: Время окончания блокировки онлайн-заказа курьером size: Количество позиций в заказе actualDeliveryTime: Фактическое время доставки routeSheetDocumentPosition: Позиция заказа в маршрутном листе * cashierName: Имя кассира clientName: Имя клиента

{ "document": { "amount": 0, "cashierName": null, "courierUserId": null, "courierUserName": null, "description": null, "documentDate": 1646143440371 , "documentNumber": "114477", "firstDeliveryTime": 1646143440371, "lastDeliveryTime": 1646143440371, "ordersCount": 1, "organizationId": "<organization_id>", "priority": "LOW", "responsiblePerson": null, "responsibleUserId": 93727, "status": "NEW", "tradeObjectId": "<trade_object_id>" }, "items": [ { "organizationId": "<organization_id>", "tradeObjectId": "<trade_object_id>", "taxSystem": "COMMON", "externalId": "11223344", "deliveryType": "COURIER", "deliveryAmount": null, "deliveryTime": 1646143684830, "paid": false, "orderTime": 1646137566448, "clientId": 195363, "address": "Адрес", "responsiblePersonLogin": "7хххххххххх", "location": null, "totalAmount": 57.00, "comment": null, "currentStatusType": "NEW", "currentStatusTime": 1646135475820, "substatusId": null, "shopId": null, "endLockTime": null, "size": 1, "actualDeliveryTime": null, "routeSheetDocumentPosition": 1 "cashierName": null, "clientName": null, } ] }

 Важно

• Поля обязательные для заполнения помечены *.
• При создании маршрутного листа, статус онлайн заказа должен быть: "NEW", "ACCEPTED" или "DISTRIBUTED".

Response
ID созданного маршрутного листа	208

 Примечание
После получения ID созданного маршрутного, укажите его в поисковом запросе https://kassa.bifit.com/cashdesk/#/app_cashdesk/online_orders/route_sheet_document/ после знака /.