Получение информации об онлайн-заказе: различия между версиями
Перейти к навигации
Перейти к поиску
Merkulov (обсуждение | вклад) |
Merkulov (обсуждение | вклад) |
||
| Строка 19: | Строка 19: | ||
{ | { | ||
"id": 320528, | "id": 320528, ''//id онлайн заказа'' | ||
"visible": true, | "visible": true, ''//Признак видимости заказа'' | ||
"created": 1645690408369, | "created": 1645690408369, ''//Время создания в формате UNIX TIME'' | ||
"changed": 1645691489120, | "changed": 1645691489120, ''//Время создания в формате UNIX TIME'' | ||
"organizationId": " | "organizationId": "<''organization_id''>", ''//ID организации'' | ||
"tradeObjectId": " | "tradeObjectId": "<''trade_object_id''>", ''//ID торгового объекта'' | ||
"taxSystem": "COMMON", | "taxSystem": "COMMON", ''//Система налогообложения '''COMMON''' - ОСН (см. [[#Систем налогообложения|Таблица систем налогообложения]])'' | ||
"externalId": "112345", | "externalId": "112345", ''//Номер заказа в информационной системе интегратора'' | ||
"deliveryType": "COURIER", | "deliveryType": "COURIER", ''//Тип доставки '''COURIER''' - Курьером (либо '''SELF''' - Самовывоз)'' | ||
"deliveryAmount": null, | "deliveryAmount": null, ''//'' | ||
"deliveryTime": 1645690416000, | "deliveryTime": 1645690416000, ''//Время доставки в формате UNIX TIME'' | ||
"paid": false, | "paid": false, ''//Признак оплаты заказа'' | ||
"orderTime": 1645690388467, | "orderTime": 1645690388467, | ||
"clientId": 195363, | "clientId": 195363, ''//ID клиента'' | ||
"address": " | "address": "Адрес", ''//Адрес доставки'' | ||
"responsiblePersonLogin": "79775553322", | "responsiblePersonLogin": "79775553322", ''//Логин (номер телефона) ответственного сотрудника. После создания заказа логин будет равен логину создателя заказа'' | ||
"discount": 0.00, | "discount": 0.00, ''//Величина скидки на заказ ('''не используется''')'' | ||
"discountType": 0, | "discountType": 0, ''//Тип скидки на заказ ('''не используется''')'' | ||
"location": null, | "location": null, ''//GPS координаты курьера'' | ||
"totalAmount": 3000.00, | "totalAmount": 3000.00, ''//Итоговая стоимость заказа'' | ||
"comment": null, | "comment": null, ''//Комментарий к заказу'' | ||
"currentStatusType": "DISTRIBUTED", | "currentStatusType": "DISTRIBUTED", ''//Текущий статус заказа NEW - новый, только что созданный заказ (см. [[#Статусы заказов|Таблица статусов заказов]])'' | ||
"currentStatusTime": 1645691012245, | "currentStatusTime": 1645691012245, ''//Время изменения статуса заказа в формате UNIX TIME'' | ||
"substatusId": null, | "substatusId": null, ''//ID пользовательского статуса'' | ||
"shopId": null, | "shopId": null, ''//ID интернет витрины'' | ||
"endLockTime": 1645691458615, | "endLockTime": 1645691458615, | ||
"routeSheetDocumentId": null, | "routeSheetDocumentId": null, ''//ID Маршрутного листа'' | ||
"routeSheetDocumentPosition": null, | "routeSheetDocumentPosition": null, ''//Номер позиции заказа в маршрутном листе'' | ||
"routeSheetDocumentNumber": null, | "routeSheetDocumentNumber": null, | ||
"size": null, | "size": null, | ||
"actualDeliveryTime": 1645691458616, | "actualDeliveryTime": 1645691458616, | ||
"cashierName": null, | "cashierName": null, ''//Имя кассира'' | ||
"clientName": null | "clientName": null ''//Имя клиента'' | ||
} | } | ||
Версия 15:20, 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, //id онлайн заказа
"visible": true, //Признак видимости заказа
"created": 1645690408369, //Время создания в формате UNIX TIME
"changed": 1645691489120, //Время создания в формате UNIX TIME
"organizationId": "<organization_id>", //ID организации
"tradeObjectId": "<trade_object_id>", //ID торгового объекта
"taxSystem": "COMMON", //Система налогообложения COMMON - ОСН (см. Таблица систем налогообложения)
"externalId": "112345", //Номер заказа в информационной системе интегратора
"deliveryType": "COURIER", //Тип доставки COURIER - Курьером (либо SELF - Самовывоз)
"deliveryAmount": null, //
"deliveryTime": 1645690416000, //Время доставки в формате UNIX TIME
"paid": false, //Признак оплаты заказа
"orderTime": 1645690388467,
"clientId": 195363, //ID клиента
"address": "Адрес", //Адрес доставки
"responsiblePersonLogin": "79775553322", //Логин (номер телефона) ответственного сотрудника. После создания заказа логин будет равен логину создателя заказа
"discount": 0.00, //Величина скидки на заказ (не используется)
"discountType": 0, //Тип скидки на заказ (не используется)
"location": null, //GPS координаты курьера
"totalAmount": 3000.00, //Итоговая стоимость заказа
"comment": null, //Комментарий к заказу
"currentStatusType": "DISTRIBUTED", //Текущий статус заказа NEW - новый, только что созданный заказ (см. Таблица статусов заказов)
"currentStatusTime": 1645691012245, //Время изменения статуса заказа в формате UNIX TIME
"substatusId": null, //ID пользовательского статуса
"shopId": null, //ID интернет витрины
"endLockTime": 1645691458615,
"routeSheetDocumentId": null, //ID Маршрутного листа
"routeSheetDocumentPosition": null, //Номер позиции заказа в маршрутном листе
"routeSheetDocumentNumber": null,
"size": null,
"actualDeliveryTime": 1645691458616,
"cashierName": null, //Имя кассира
"clientName": null //Имя клиента
}