Создание маршрутного листа: различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 27: Строка 27:
|title-right= type: '''raw''' (JSON)
|title-right= type: '''raw''' (JSON)
|content-left= 
|content-left= 
* '''organizationId''': ID организации
''document'':
* '''barcode''': Штрих код позиции (EAN-8, EAN-13)
* '''amount''':
* '''vendorCode''': Артикул производителя
* '''cashierName''':  
* '''name''': Наименование номенклатуры
* '''courierUserId''': ID курьера
* '''vatId''': НДС ID
* '''courierUserName''': Логин (номер телефона) курьера
* '''vatValue''': НДС
* '''description''':  
* '''unitCode''': Код единицы измерения по '''ОКЕИ'''
* '''documentDate''': Дата создания маршрутного листа '''*'''
* '''volume''': Значение объема
* '''documentNumber''': Номер маршрутного листа '''*'''
* '''purchasePrice''': Цена закупки
* '''firstDeliveryTime''': Время первой доставки '''*'''
* '''sellingPrice''': Цена продажи
* '''lastDeliveryTime''': Время последней доставки '''*'''
* '''weighted''':   Весовой товар (true/false)
* '''ordersCount''': Количество заказов '''*'''
* '''grouped''': Группа (true/false)
* '''organizationId''': ID организации '''*'''
* '''focused''': Фокусный товар (true/false)
* '''priority''': Приоритетность маршрутного листа в системе '''*'''
* '''container''': товар типа Комплект (true/false)
* '''responsiblePerson''':  
* '''paymentSubject''': Признак предмета расчёта (Товар, Платеж, Залог, Выигрыш лотереи и др.)
* '''responsibleUserId''': ID Ответственного сотрудника '''*'''
* '''adultsOnly''': Возрастное ограничение товара
* '''status''': Статус маршрутного листа '''*'''
* '''code''': Код
* '''tradeObjectId''': ID торгового объекта '''*'''
* '''markType''': Тип маркировки номенклатуры (Алкоголь, Табак, Обувь, Парфюмерия, СИЗ, Другая)
''items'':  
* '''gtin''': Код GTIN
* '''organizationId''': ID организации '''*'''
* '''pluCode''': PLU код
* '''tradeObjectId''': ID торгового обекта '''*'''
* '''template''': Шаблон
* '''taxSystem''': Система налогообложения '''*'''
* '''visible''': Видимость (true/false)
* '''externalId''': Номер онлайн-заказа '''*'''
* '''contractorActivityType''': Признак агента (Агент, Комиссионер, Платежный агент, Платежный субагент и др.)
* '''deliveryType''': Тип доставки '''*'''
* '''contractorId''': ID агента
* '''deliveryAmount''': Стоимость доставки
* '''custom''': Наличие характеристики у номенклатуры (true/false)
* '''deliveryTime''': Время доставки в формате '''UNIX TIME''' '''*'''
* '''type''': Тип номенклатурной позиции( Товар, Рецепт, Комплект, Шаблон)
* '''paid''': Признак оплаты заказа '''*'''
* '''compositeGoods''': Тип товара (Товар, Рецепт, Комплект, Шаблон)
* '''orderTime''': Время заказа '''*'''
* '''barcodes''': Штрих код позиции (EAN-8, EAN-13)
* '''clientId''': ID клиента '''*'''
* '''countryCode''': Код страны
* '''address''': Адрес доставки '''*'''
* '''customsDeclaration''': Таможенная декларация
* '''responsiblePersonLogin''': Логин (номер телефона) ответственного сотрудника. После создания заказа логин будет равен логину создателя заказа '''*'''
* '''description''': Описание
* '''location''': GPS координаты курьера
* '''picturesIds''': ID изображения
* '''totalAmount''': Итоговая стоимость заказа '''*'''
* '''application''': Название приложения (KASSA)
* '''comment''': Комментарий к заказу
'''nomenclatureFeatures''': Характеристика товара
* '''currentStatusType''': Текущий статус заказа NEW - новый, только что созданный заказ '''*'''
* '''id''': ID характеристики
* '''currentStatusTime''': Время изменения статуса заказа в формате '''UNIX TIME''' '''*'''
* '''nomenclatureId''': ID номенклатуры
* '''substatusId''': ID пользовательского статуса
* '''featureId''': Идентификатор номенклатуры
* '''shopId''': ID интернет витрины
* '''value''': Цена
* '''endLockTime''': Время окончания блокировки онлайн-заказа курьером
* '''organizationId''' : ID организации
* '''size''': Количество позиций в заказе
'''tradeObjectRelations''': Данные номенклатуры в торговом объекте
* '''actualDeliveryTime''': Фактическое время доставки
* '''nomenclatureId''': ID номенклатуры
* '''routeSheetDocumentPosition''': Позиция заказа в маршрутном листе '''*'''
* '''organizationId''': ID организации
* '''cashierName''': Имя кассира
* '''sellingPrice''': Цена продажи
* '''clientName''': Имя клиента
* '''tradeObjectId''': ID торгового объекта
 
* '''orgMemberPoints''': Баллы KPI
* '''blockedNomenclatureList''': Номенклатура, входящая в стоп-лист
|content-right= 
|content-right= 
<syntaxhighlight lang="JSON">
<syntaxhighlight lang="JSON">

Версия 15:03, 26 апреля 2022

CASHDESK API

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

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


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

Запрос POST

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



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


Request Body type: raw (JSON)
 

document:

  • amount:
  • cashierName:
  • courierUserId: ID курьера
  • courierUserName: Логин (номер телефона) курьера
  • description:
  • documentDate: Дата создания маршрутного листа *
  • 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: Время заказа *
  • 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, 
     }
   ]
 }





{
 "document": {
   "amount": 0,
   "cashierName": null,
   "courierUserId": null,                                    //ID курьера
   "courierUserName": null,                                  //Логин (номер телефона) курьера
   "description": null,
   "documentDate": 1646143440371 ,                           //Дата создания маршрутного листа *
   "documentNumber": "114477",                               //Номер маршрутного листа *
   "firstDeliveryTime": 1646143440371,                       //Время первой доставки *
   "lastDeliveryTime": 1646143440371,                        //Время последней доставки *
   "ordersCount": 1,                                         //Количество заказов *
   "organizationId": "<organization_id>",                    //ID организации *
   "priority": "LOW",                                        //Приоритетность маршрутного листа в системе *
   "responsiblePerson": null,
   "responsibleUserId": 93727,                               //ID Ответственного сотрудника *
   "status": "NEW",                                          //Статус маршрутного листа *
   "tradeObjectId": "<trade_object_id>"                      //ID торгового объекта *
 },
 "items": [
   {
     "organizationId": "<organization_id>",                  //ID организации *
     "tradeObjectId": "<trade_object_id>",                   //ID торгового обекта *
     "taxSystem": "COMMON",                                  //Система налогообложения COMMON - ОСН (см. Таблица систем налогообложения) *
     "externalId": "11223344",                               //Номер онлайн-заказа *
     "deliveryType": "COURIER",                              //Тип доставки *
     "deliveryAmount": null,                                 //Стоимость доставки
     "deliveryTime": 1646143684830,                          //Время доставки в формате UNIX TIME *
     "paid": false,                                          //Признак оплаты заказа *
     "orderTime": 1646137566448,                             //Время заказа *
     "clientId": 195363,                                     //ID клиента *
     "address": "Адрес",                                     //Адрес доставки *
     "responsiblePersonLogin": "7хххххххххх",                //Логин (номер телефона) ответственного сотрудника. После создания заказа логин будет равен логину создателя заказа *
     "location": null,                                       //GPS координаты курьера
     "totalAmount": 57.00,                                   //Итоговая стоимость заказа *
     "comment": null,                                        //Комментарий к заказу
     "currentStatusType": "NEW",                             //Текущий статус заказа NEW - новый, только что созданный заказ (см. Таблица статусов заказов) *
     "currentStatusTime": 1646135475820,                     //Время изменения статуса заказа в формате UNIX TIME *
     "substatusId": null,                                    //ID пользовательского статуса
     "shopId": null,                                         //ID интернет витрины
     "endLockTime": null,                                    //Время окончания блокировки онлайн-заказа курьером
     "size": 1,                                              //Количество позиций в заказе
     "actualDeliveryTime": null,                             //Фактическое время доставки
     "routeSheetDocumentPosition": 1                         //Позиция заказа в маршрутном листе *
     "cashierName": null,                                    //Имя кассира
     "clientName": null,                                     //Имя клиента
    }
  ]
}

Note.svg Важно

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

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

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

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

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

Note.svg Примечание

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

Источник — http://kassa.bifit.com/wiki/index.php?title=Создание_маршрутного_листа&oldid=17051