Перейти к содержимому

Продажа из внешней системы

Базовый путь — в разделе первая продажа.

Окно терминала
curl -X POST 'https://api-admin.billz.ai/v2/order-manual-discount/ID_ПРОДАЖИ' \
-H 'Authorization: Bearer ТОКЕН' \
-H 'Content-Type: application/json' \
-H 'Billz-Response-Channel: HTTP' \
-d '{ "discount_unit": "PERCENTAGE", "discount_value": 10 }'

discount_unit принимает PERCENTAGE или CURRENCY. Необязательное поле product_id применяет скидку к одной позиции; без него скидка идёт на всю корзину.

Актуальный чек после изменения состава или скидок возвращает синхронный POST /v1/recalculate-order-bill/:order_id.

{
"payments": [
{ "company_payment_type_id": "ID_НАЛИЧНЫЕ", "paid_amount": 100000 },
{ "company_payment_type_id": "ID_КАРТА", "paid_amount": 900000 }
]
}

Для списания бонусов клиента заполняется поле with_cashback.

  1. Найти карту: GET /v1/gift-card/search — синхронный
  2. Добавить в продажу: PUT /v1/order-gift-card/:id — асинхронный
  3. Убрать: POST /v1/order-gift-card-remove/:id — асинхронный
  4. Провести оплату сертификатом: POST /v2/order-payment/:order_id

Отложенный чек — способ забронировать товары в продаже.

  • Отложить: POST /v2/order/create_postpone (асинхронный) — в теле order_id, time и необязательный comment; поле time обязательно и строгого формата (2024-07-16 06:47:30)
  • Вернуть в работу: POST /v2/order/return-postpone (асинхронный)
  • Изменить количество позиции: POST /v2/order-product/:order_id, поле sold_measurement_value; значение 0 удаляет позицию вместе с назначенной на неё ручной скидкой
Задача Метод
Продажи за период отчёты GET /v1/general-report-table и GET /v1/transaction-report-table — см. выгрузку продаж
Детали одной продажи GET /v2/order/:id
Список черновиков и отложек GET /v2/order-notes

Методы, меняющие состав чека, клиента и скидки, — асинхронные. Для них требуется Billz-Response-Channel: HTTP, иначе приходит только correlation_id. Оплата POST /v2/order-payment/:order_id и пересчёт POST /v1/recalculate-order-bill/:order_id синхронные — заголовок им не нужен.