Создание онлайн заказа по API
CASHDESK API
API (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.
Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2. С инструкцией авторизации по API можно ознакомиться здесь.
Создание заказа
| Запрос | POST |
| base URL: https://kassa.bifit.com/cashdesk-api/v1/protected/online_orders |
https://kassa.bifit.com/cashdesk-api/v1/protected/online_orders
|
Примечание
В HEADERS укажите значение access_token согласно:authorization: Bearer <значение acces_token> .
| Request Body | type: raw (JSON) |
|
onlineOrder:
onlineOrderItems:
properties: Свойства
client:
|
{
"onlineOrder": {
"visible": true,
"created": 1644828163053,
"changed": 1644828163053,
"organizationId": "<''organization_id''>",
"tradeObjectId": "<''trade_object_id''>",
"taxSystem": "COMMON",
"externalId": "BFt-002",
"deliveryType": "COURIER",
"deliveryAmount": null,
"deliveryTime": null,
"paid": false,
"orderTime": 1644828134297,
"clientId": 124329,
"address": "Адрес",
"responsiblePersonLogin": "7xxxxxxxxxx",
"discount": 0.00,
"discountType": 0,
"location": null,
"totalAmount": 14500.00,
"comment": null,
"currentStatusType": "NEW",
"currentStatusTime": 1644828159791,
"substatusId": null,
"shopId": null,
"endLockTime": null,
"routeSheetDocumentId": null,
"routeSheetDocumentPosition": null,
"routeSheetDocumentNumber": null,
"size": null,
"actualDeliveryTime": null,
"cashierName": null,
"clientName": null
},
"onlineOrderItems": [
{
"nomenclatureId": 22090265,
"description": "Букет белых роз",
"price": 3000,
"vatValue": 20,
"quantity": 1,
"discount": 0,
"calculationMethod": null,
"paymentSubject": "PRODUCT",
"contractorAddress": null,
"contractorInn": null,
"contractorName": null,
"contractorPhone": null,
"organizationPhone": null,
"contractorActivityType": null,
"markType": "UNKNOWN",
"codeForOfd": null,
"barcode": null,
"vendorCode": null,
"unitCode": 796,
"editable": true,
"total": null
},
{
"nomenclatureId": 22090204,
"description": "Букет роз, 40 шт",
"price": 7000,
"vatValue": 20,
"quantity": 1,
"discount": 0,
"calculationMethod": null,
"paymentSubject": "PRODUCT",
"contractorAddress": null,
"contractorInn": null,
"contractorName": null,
"contractorPhone": null,
"organizationPhone": null,
"contractorActivityType": null,
"markType": "UNKNOWN",
"codeForOfd": null,
"barcode": null,
"vendorCode": null,
"unitCode": 796,
"editable": true,
"total": null
},
{
"nomenclatureId": 22090243,
"description": "Букет розовых и белых роз, 15 штук",
"price": 4500,
"vatValue": 20,
"quantity": 1,
"discount": 0,
"calculationMethod": null,
"paymentSubject": "PRODUCT",
"contractorAddress": null,
"contractorInn": null,
"contractorName": null,
"contractorPhone": null,
"organizationPhone": null,
"contractorActivityType": null,
"markType": "UNKNOWN",
"codeForOfd": null,
"barcode": null,
"vendorCode": null,
"unitCode": 796,
"editable": true,
"total": null
}
],
"properties": {
"fullSettlement": true,
"prepayment": false,
"credit": false
},
"client": {
"organizationId": "<''organization_id''>",
"address": "Адрес",
"phone": "79999999999",
"lastName": "Иванов",
"firstName": "Иван",
"patronymic": "Иванович",
"email": "",
"comment": null,
},
"organizationId": null,
"cashierInfos": null
}
|
| Response | |
| ID созданного онлайн заказа |
406707
|
Примечание
После получения ID созданного онлайн заказа, укажите его в поисковом запросе https://kassa.bifit.com/cashdesk/#/app_cashdesk/online_orders/list/ после знака /.
Вспомогательные материалы
Систем налогообложения
| Значение нумератора | Описание |
|---|---|
| COMMON | (ОСН - Общая система налогообложения) |
| SIMPLIFIED | (УСН 6% с дохода) |
| SIMPLIFIED_WITH_EXPENSE | (УСН 15% доход - расход) |
| ENVD | (ЕНВД не используется с 01.01.2020) |
| COMMON_AGRICULTURAL | (ЕСН или ЕСХН) |
| PATENT | (ПАТЕНТНАЯ система налогообложения) |
Статусы заказов
| Значение нумератора | Описание |
|---|---|
| NEW | НОВЫЙ |
| ACCEPTED | ПОДТВЕРЖДЕН |
| DISTRIBUTED | РАСПРЕДЕЛЕН |
| ISSUED | ВЫДАННЫЙ |
| REFUSED | ОТКАЗ |
| DELETED | УДАЛЕН |
| FINISHED | ЗАВЕРШЕН |
Ставки НДС
| Значение нумератора | Описание |
|---|---|
| null | БЕЗ НДС |
| 0 | НДС 0% |
| 10 | НДС 10% |
| 20 | НДС 20% |
| 110 | НДС 10/110% |
| 120 | НДС 20/120% |
Признаки способа расчётов
| Значение нумератора | Описание |
|---|---|
| null | ПОЛНАЯ ОПЛАТА |
| FULL_PAY | ПОЛНАЯ ОПЛАТА |
| PREPAY_FULL | 100% ПРЕДОПЛАТА |
| PREPAY | ЧАСТИЧНАЯ ПРЕДОПЛАТА |
Признаки предмета расчётов
| Значение нумератора | Описание |
|---|---|
| PRODUCT | ТОВАР |
| SERVICE | УСЛУГА |
| EXCISABLE_PRODUCT | ПОДАКЦИЗНЫЙ ТОВАР |
| JOB | РАБОТА |
| GAMBLING_RATE | ИГРОВАЯ СТАВКА |
Типы маркировок
| Значение нумератора | Описание |
|---|---|
| UNKNOWN | БЕЗ МАРКИРОВКИ |
| OTHER | МАРКИРОВКА (обувь, шины, духи, лег.пром, молоко) |
Примечание
- При создании заказа, есть несколько видов доставки. Ознакомьтесь с типами доставки:
- "COURIER" - в случае, если используется курьерская доставка
- "SELF" - самовывоз, в этом случае адрес доставки не требуется, место расчетов в чеке берется из ККТ/ТО
- "SERVICE" - не используется
- Каждому созданному заказу присваивается определенный статус. Ознакомьтесь со статусами заказов:
- "ACCEPTED" - статус “Подтвержден”, заказы в данном статусе доступны для отображения всем сотрудникам на МКТ. Используем при создании заказа.
- "DISTRIBUTED" - статус “Распределен”, заказы в данном статусе доступны для отображения на МКТ только тем сотрудникам, на которых эти заказы назначены.
- "REFUSED" - статус “Отменен”, заказ с таким статусом невозможно создать, можно добавить статус с помощью PUT запроса, либо перевести заказ в данный статус из клиентского ПО, отменить заказ можно только в статусах "DISTRIBUTED","ACCEPTED". Статус REFUSED необходимо использовать при отмене заказа в статусах DISTRIBUTED и ACCEPTED.
- "DELETED" - статус “Удален”, заказ с таким статусом невозможно создать, можно добавить статус с помощью PUT запроса, заказ, в статусе “Удален” не будет доступен для работы, удалить можно только заказ в статусе "currentStatusType": "NEW". Статус DELETED необходимо использовать при отмене заказа только в статусе NEW.