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

CASHDESK API

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

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

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

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

base URL: https://kassa.bifit.com/cashdesk-api/v1/protected/route_sheet_document

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

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

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

{
 "document": {
   "amount": 0,
   "cashierName": "string",
   "courierUserId": 0,
   "courierUserName": "string",
   "description": "string",
   "documentDate": 0,                                        //Дата создания маршрутного листа
   "documentNumber": "string",                               //Номер маршрутного листа
   "firstDeliveryTime": 0,                                   //Время доставки первого заказа
   "lastDeliveryTime": 0,                                    //Время доставки последнего заказа
   "ordersCount": 0,
   "organizationId": "string",                               //ID организации
   "priority": "LOW",                                        //Приоритет маршрутного листа
   "responsiblePerson": "string",
   "responsibleUserId": 0,
   "status": "NEW",                                          //Статус маршрутного листа
   "tradeObjectId": "string"                                 //ID торгового объекта
 },
 "items": [
   {
     "organizationId": "1579776541385873338810",             //ID организации
     "tradeObjectId": "1579776541389-605245476",             //ID торгового объекта
     "taxSystem": "COMMON",                                  //Система налогообложения COMMON - ОСН (см. Таблица систем налогообложения)
     "externalId": "null",                                   //Номер заказа в информационной системе интегратора
     "deliveryType": "COURIER",                              //Тип доставки COURIER - Курьером (либо SELF - Самовывоз)
     "deliveryAmount": 0,                                    //Стоимость доставки
     "deliveryTime": 1646036584293,                          //Время доставки в формате UNIX TIME
     "paid": false,                                          //Признак оплаты заказа
     "orderTime": 0,
     "clientId": 195363,                                     //ID клиента
     "address": "Адрес",                                     //Адрес доставки
     "responsiblePersonLogin": "79775553322",                //Логин (номер телефона) ответственного сотрудника. После создания заказа логин будет равен логину создателя заказа
     "location": "null",                                     //GPS координаты курьера
     "totalAmount": 100.00,                                  //Итоговая стоимость заказа
     "comment": "null",                                      //Комментарий к заказу
     "currentStatusType": "NEW",                             //Текущий статус заказа NEW - новый, только что созданный заказ (см. Таблица статусов заказов)
     "currentStatusTime": 1645803349064,                     //Время изменения статуса заказа в формате UNIX TIME
     "substatusId": 0,                                       //ID пользовательского статуса
     "shopId": 0,                                            //ID интернет витрины
     "endLockTime": 0,
     "size": 0,                                               
     "actualDeliveryTime": 0,
     "cashierName": "null",                                  //Имя кассира
     "clientName": "null"                                    //Имя клиента
    }
  ]
}