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

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

POST
/v2/supplier-order
curl --request POST \
--url 'https://api-admin.billz.ai/v2/supplier-order?Billz-Response-Channel=HTTP' \
--header 'Authorization: Bearer <token>' \
--header 'Billz-Response-Channel: HTTP' \
--header 'Content-Type: application/json' \
--header 'platform-id: 7d4a4c38-dd84-4902-b744-0488b80a4c01' \
--data '{ "name": "новый заказ", "accepting_date": "2024-12-17", "is_from_file": false, "shop_id": "6f244db4-75d6-4fac-9841-14867d45e36a", "supplier_id": "28110831-9bc5-485f-830c-18472f9481b1" }'

Асинхронный метод. Чтобы получить результат синхронно по HTTP, передайте заголовок Billz-Response-Channel: HTTP — иначе ответ будет 200 {"message": "<correlation_id>"}. Максимальное ожидание — 600 секунд, далее 408 с error.code = TIMEOUT.

Коды ошибок: 400 — ошибка валидации входных данных; 404 — объект не найден; 408 — таймаут ожидания асинхронного ответа; 401, 403, 429, 500 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.

platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Идентификатор платформы. Для интеграций используется статичное значение.

Billz-Response-Channel
string
Allowed values: HTTP

HTTP — дождаться результата обработки события и вернуть его в HTTP-ответе. Без заголовка метод вернёт только correlation_id опубликованного события.

Billz-Response-Channel
string
Allowed values: HTTP

То же, что заголовок Billz-Response-Channel, — для клиентов, которые не могут передать свой заголовок. Если переданы оба, действует заголовок.

Media typeapplication/json
object
name
required

Пустое -> 400 “name is required”

string
shop_id
required
string
supplier_id
required
string
accepting_date
string
payment_date
string
settlement_type

Тип взаиморасчёта с поставщиком: commission — комиссия, consegnation — консигнация (значение пишется именно так), realization — реализация. Поле справочное: долг перед поставщиком начисляется на всю сумму заказа при его отправке, независимо от типа.

string
Allowed values: commission consegnation realization
is_from_file
boolean
invoice_number
integer format: int64
comment
string
type

supplier_order или returned

string
returned_supplier_order_id
string
id

Генерируется сервером

string
external_id

Генерируется сервером

integer format: int32
company_id
string
created_by
string
allowed_shops
string
Example
{
"name": "новый заказ",
"accepting_date": "2024-12-17",
"is_from_file": false,
"shop_id": "6f244db4-75d6-4fac-9841-14867d45e36a",
"supplier_id": "28110831-9bc5-485f-830c-18472f9481b1"
}

Успех. С заголовком Billz-Response-Channel: HTTP — конверт асинхронного ответа, без него — {"message": "<correlation_id>"}.

Media typeapplication/json
One of:

Конверт асинхронного ответа. Возвращается, когда передан заголовок Billz-Response-Channel: HTTP. Итоговый HTTP-код запроса берётся из поля status_code.

object
session_id

Идентификатор сессии клиента

string format: uuid
status_code

Статус обработки события (он же итоговый HTTP-код ответа)

integer
error
object
code

Код ошибки, пустая строка если ошибки нет

string
message

Текст ошибки, пустая строка если ошибки нет

string
correlation_id

Идентификатор запроса, совпадает с ID опубликованного события

string format: uuid
topic

Тип ответного события, например <event_type>.success

string
data

Результат операции, если метод его возвращает

object
Example
{
"data": {
"settlement_type": "commission"
}
}