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

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 17: Строка 17:


В '''BODY''' запроса укажите данные, согласно структуре описанной в [https://kassa.bifit.com/cashdesk-api/v1/swagger-ui.html#/online_orders/createOnlineOrderUsingPOST SWAGGER].
В '''BODY''' запроса укажите данные, согласно структуре описанной в [https://kassa.bifit.com/cashdesk-api/v1/swagger-ui.html#/online_orders/createOnlineOrderUsingPOST SWAGGER].
{
  "document": {
    "amount": 0,
    "cashierName": "string",
    "courierUserId": 0,
    "courierUserName": "string",
    "description": "string",
    "documentDate": 0,
    "documentNumber": "string",
    "firstDeliveryTime": 0,
    "lastDeliveryTime": 0,
    "ordersCount": 0,
    "organizationId": "string",
    "priority": "LOW",
    "responsiblePerson": "string",
    "responsibleUserId": 0,
    "status": "NEW",
    "tradeObjectId": "string"
  },
  "items": [
    {
      "organizationId": "string",
      "tradeObjectId": "string",
      "taxSystem": "COMMON",
      "externalId": "string",
      "deliveryType": "SELF",
      "deliveryAmount": 0,
      "deliveryTime": 0,
      "paid": true,
      "orderTime": 0,
      "clientId": 0,
      "address": "string",
      "responsiblePersonLogin": "string",
      "location": "string",
      "totalAmount": 0,
      "comment": "string",
      "currentStatusType": "NEW",
      "currentStatusTime": 0,
      "substatusId": 0,
      "shopId": 0,
      "endLockTime": 0,
      "size": 0,
      "actualDeliveryTime": 0,
      "cashierName": "string",
      "clientName": "string"
    }
  ]
}

Версия 10:59, 28 февраля 2022

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",
   "priority": "LOW",
   "responsiblePerson": "string",
   "responsibleUserId": 0,
   "status": "NEW",
   "tradeObjectId": "string"
 },
 "items": [
   {
     "organizationId": "string",
     "tradeObjectId": "string",
     "taxSystem": "COMMON",
     "externalId": "string",
     "deliveryType": "SELF",
     "deliveryAmount": 0,
     "deliveryTime": 0,
     "paid": true,
     "orderTime": 0,
     "clientId": 0,
     "address": "string",
     "responsiblePersonLogin": "string",
     "location": "string",
     "totalAmount": 0,
     "comment": "string",
     "currentStatusType": "NEW",
     "currentStatusTime": 0,
     "substatusId": 0,
     "shopId": 0,
     "endLockTime": 0,
     "size": 0,
     "actualDeliveryTime": 0,
     "cashierName": "string",
     "clientName": "string"
    }
  ]
}