Получение информации об онлайн-заказе: различия между версиями

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


В PARAMS запроса укажите данные согласно структуре описанной в [https://kassa.bifit.com/cashdesk-api/v1/swagger-ui.html#/online_orders/createOnlineOrderUsingPOST SWAGGER].
В PARAMS запроса укажите данные согласно структуре описанной в [https://kassa.bifit.com/cashdesk-api/v1/swagger-ui.html#/online_orders/createOnlineOrderUsingPOST SWAGGER].
''Пример ответа на запрос.''
{
    "id": 320528,
    "visible": true,
    "created": 1645690408369,
    "changed": 1645691489120,
    "organizationId": "1579776541385873338810",
    "tradeObjectId": "1579776541389-605245476",
    "taxSystem": "COMMON",
    "externalId": "112345",
    "deliveryType": "COURIER",
    "deliveryAmount": null,
    "deliveryTime": 1645690416000,
    "paid": false,
    "orderTime": 1645690388467,
    "clientId": 195363,
    "address": "г Москва",
    "responsiblePersonLogin": "79773305516",
    "discount": 0.00,
    "discountType": 0,
    "location": null,
    "totalAmount": 3000.00,
    "comment": null,
    "currentStatusType": "DISTRIBUTED",
    "currentStatusTime": 1645691012245,
    "substatusId": null,
    "shopId": null,
    "endLockTime": 1645691458615,
    "routeSheetDocumentId": null,
    "routeSheetDocumentPosition": null,
    "routeSheetDocumentNumber": null,
    "size": null,
    "actualDeliveryTime": 1645691458616,
    "cashierName": null,
    "clientName": null
}

Версия 15:05, 25 февраля 2022

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,
   "visible": true,
   "created": 1645690408369,
   "changed": 1645691489120,
   "organizationId": "1579776541385873338810",
   "tradeObjectId": "1579776541389-605245476",
   "taxSystem": "COMMON",
   "externalId": "112345",
   "deliveryType": "COURIER",
   "deliveryAmount": null,
   "deliveryTime": 1645690416000,
   "paid": false,
   "orderTime": 1645690388467,
   "clientId": 195363,
   "address": "г Москва",
   "responsiblePersonLogin": "79773305516",
   "discount": 0.00,
   "discountType": 0,
   "location": null,
   "totalAmount": 3000.00,
   "comment": null,
   "currentStatusType": "DISTRIBUTED",
   "currentStatusTime": 1645691012245,
   "substatusId": null,
   "shopId": null,
   "endLockTime": 1645691458615,
   "routeSheetDocumentId": null,
   "routeSheetDocumentPosition": null,
   "routeSheetDocumentNumber": null,
   "size": null,
   "actualDeliveryTime": 1645691458616,
   "cashierName": null,
   "clientName": null

}