Создание маршрутного листа
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 |
Важно!
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение acces_token> .
| Request Body | type: raw (JSON) |
|
document:
items:
|
{
"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,
}
]
}
|
Важно
- Поля обязательные для заполнения помечены *.
- При создании маршрутного листа, статус онлайн заказа должен быть: "NEW", "ACCEPTED" или "DISTRIBUTED".
Дополнительные материалы
Систем налогообложения
| Значение нумератора | Описание |
|---|---|
| COMMON | (ОСН - Общая система налогообложения) |
| SIMPLIFIED | (УСН 6% с дохода) |
| SIMPLIFIED_WITH_EXPENSE | (УСН 15% доход - расход) |
| ENVD | (ЕНВД не используется с 01.01.2020) |
| COMMON_AGRICULTURAL | (ЕСН или ЕСХН) |
| PATENT | (ПАТЕНТНАЯ система налогообложения) |
Статусы заказов
| Значение нумератора | Описание |
|---|---|
| NEW | НОВЫЙ |
| ACCEPTED | ПОДТВЕРЖДЕН |
| DISTRIBUTED | РАСПРЕДЕЛЕН |
| ISSUED | ВЫДАННЫЙ |
| REFUSED | ОТКАЗ |
| DELETED | УДАЛЕН |
| FINISHED | ЗАВЕРШЕН |
Примечание
- При создании заказа, есть несколько видов доставки. Ознакомьтесь с типами доставки:
- "COURIER" - в случае, если используется курьерская доставка
- "SELF" - самовывоз, в этом случае адрес доставки не требуется, место расчетов в чеке берется из ККТ/ТО
- "SERVICE" - не используется
- Каждому созданному заказу присваивается определенный статус. Ознакомьтесь со статусами заказов:
- "ACCEPTED" - статус “Подтвержден”, заказы в данном статусе доступны для отображения всем сотрудникам на МКТ. Используем при создании заказа.
- "DISTRIBUTED" - статус “Распределен”, заказы в данном статусе доступны для отображения на МКТ только тем сотрудникам, на которых эти заказы назначены.
- "REFUSED" - статус “Отменен”, заказ с таким статусом невозможно создать, можно добавить статус с помощью PUT запроса, либо перевести заказ в данный статус из клиентского ПО, отменить заказ можно только в статусах "DISTRIBUTED","ACCEPTED". Статус REFUSED необходимо использовать при отмене заказа в статусах DISTRIBUTED и ACCEPTED.
- "DELETED" - статус “Удален”, заказ с таким статусом невозможно создать, можно добавить статус с помощью PUT запроса, заказ, в статусе “Удален” не будет доступен для работы, удалить можно только заказ в статусе "currentStatusType": "NEW". Статус DELETED необходимо использовать при отмене заказа только в статусе NEW.