CASHDESK API:Создание онлайн заказа: различия между версиями

Материал из Касса
Перейти к навигации Перейти к поиску
Строка 20: Строка 20:
В массив onlineOrder передаются следующие обязательные значения:
В массив onlineOrder передаются следующие обязательные значения:


  "visible": true,  \\Видимость онлайн-заказа
  "visible": true,  \\ Видимость онлайн-заказа
  !"organizationId": "16286094820321052850480", \\В какую организацию создаем заказ
  !"organizationId": "16286094820321052850480", \\ В какую организацию создаем заказ
  !"tradeObjectId": "1628609482057-1613612358", \\В какой торговый объект создаем заказ
  !"tradeObjectId": "1628609482057-1613612358", \\ В какой торговый объект создаем заказ
  !"taxSystem": "COMMON", \\СНО заказа
  !"taxSystem": "COMMON", \\ СНО заказа
  "externalId": "VQ12345678", \\Номер заказа во внешней системе
  "externalId": "VQ12345678", \\ Номер заказа во внешней системе
  !"deliveryType": "COURIER", \\Тип доставки
  !"deliveryType": "COURIER", \\ Тип доставки
* "COURIER" - в случае, если используется курьерская доставка
!"paid": false, \\ Флаг оплачен ли заказ, если значение true, привязать оплату более нельзя
                            * "SELF" - самовывоз, в этом случае адрес доставки не требуется, место расчетов в чеке берется из ККТ/ТО
"employeeAccess": "NULL", \\ Поле, указывающее какому сотруднику принадлежит заказ, поле необязательное
                        * "SERVICE" - не используется
"orderTime": 1631094730812, \\ Время заказа - указываем фактическое время создания заказа, т.к в МКТ по данному времени будут сортироваться заказы
"address": "Адрес", \\ Адрес доставки, для заказа вида "COURIER"
"responsiblePersonLogin": "79295444301", \\ Логин Сотрудника, на кого назначается заказ. Ответственный за заказ.
!"totalAmount": 95, \\ Итоговая сумма заказа со всеми скидками, заказ будет считаться завершенным, после погашения данной суммы, данная сумма должна быть равна сумме цены всех позиций с учетом их кол-ва, скидок и НДС
!"currentStatusType": "NEW", \\ Поле статуса заказа
!"currentStatusTime": 1630936599865 \\ Время изменения статуса заказа, обязательное к передачи, при создании онлайн-заказа можно передавать то-же время что и в order_time


!"paid": false,
 
"employeeAccess": "NULL",
 
"orderTime": 1631094730812,
 
"address": "Адрес",
{{ Note |'''''Примечание'''''<br>
"responsiblePersonLogin": "79295444301",
*Типы доставки:
!"totalAmount": 95,
** "COURIER" - в случае, если используется курьерская доставка
!"currentStatusType": "NEW",
** "SELF" - самовывоз, в этом случае адрес доставки не требуется, место расчетов в чеке берется из ККТ/ТО
!"currentStatusTime": 1630936599865
** "SERVICE" - не используется|800}}

Версия 17:52, 9 февраля 2022

API (Application Programming Interface или интерфейс программирования приложений) — это совокупность инструментов и функций в виде интерфейса для создания новых приложений, благодаря которому одна программа будет взаимодействовать с другой.

Для работы с API сервиса БИФИТ Касса, пользователю необходимо получить токен доступа. Генерация токена происходит по правилам авторизации OAuth2. С инструкцией авторизации по API можно ознакомиться здесь.

Создание заказа

Подготовьте POST запрос следующего вида:

base URL: https://kassa.bifit.com/cashdesk-api/v1/protected/online_orders

В рамках согласованного процесса, заказы создаются в статусе “Подтвержден” или “Новый”.

  • Для заказов, передаваемых курьерам необходимо использовать статус NEW при создании заказа
  • Для заказов самовывоза необходимо использовать статус ACCEPTED при создании заказа


Для самовывоза или доставки необходимо передавать "employeeAccess": null


В массив onlineOrder передаются следующие обязательные значения:

"visible": true,  \\ Видимость онлайн-заказа
!"organizationId": "16286094820321052850480", \\ В какую организацию создаем заказ
!"tradeObjectId": "1628609482057-1613612358", \\ В какой торговый объект создаем заказ
!"taxSystem": "COMMON", \\ СНО заказа
"externalId": "VQ12345678", \\ Номер заказа во внешней системе
!"deliveryType": "COURIER", \\ Тип доставки 				
!"paid": false, \\ Флаг оплачен ли заказ, если значение true, привязать оплату более нельзя
"employeeAccess": "NULL", \\ Поле, указывающее какому сотруднику принадлежит заказ, поле необязательное
"orderTime": 1631094730812, \\ Время заказа - указываем фактическое время создания заказа, т.к в МКТ по данному времени будут сортироваться заказы
"address": "Адрес", \\ Адрес доставки, для заказа вида "COURIER"
"responsiblePersonLogin": "79295444301", \\ Логин Сотрудника, на кого назначается заказ. Ответственный за заказ.
!"totalAmount": 95, \\ Итоговая сумма заказа со всеми скидками, заказ будет считаться завершенным, после погашения данной суммы, данная сумма должна быть равна сумме цены всех позиций с учетом их кол-ва, скидок и НДС	
!"currentStatusType": "NEW", \\ Поле статуса заказа
!"currentStatusTime": 1630936599865 \\ Время изменения статуса заказа, обязательное к передачи, при создании онлайн-заказа можно передавать то-же время что и в order_time



Note.svg Примечание

  • Типы доставки:
    • "COURIER" - в случае, если используется курьерская доставка
    • "SELF" - самовывоз, в этом случае адрес доставки не требуется, место расчетов в чеке берется из ККТ/ТО
    • "SERVICE" - не используется