Создание нового заказа
const url = 'https://api-admin.billz.ai/v2/supplier-order?Billz-Response-Channel=HTTP';const options = { method: 'POST', headers: { 'platform-id': '7d4a4c38-dd84-4902-b744-0488b80a4c01', 'Billz-Response-Channel': 'HTTP', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"name":"новый заказ","accepting_date":"2024-12-17","is_from_file":false,"shop_id":"6f244db4-75d6-4fac-9841-14867d45e36a","supplier_id":"28110831-9bc5-485f-830c-18472f9481b1"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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 — общие для всех методов. Форматы тела и семантика — Коды ответов и ошибки.
Authorizations
Заголовок раздела «Authorizations»Parameters
Заголовок раздела «Parameters»Header Parameters
Заголовок раздела «Header Parameters»Идентификатор платформы. Для интеграций используется статичное значение.
HTTP — дождаться результата обработки события и вернуть его в HTTP-ответе. Без заголовка метод вернёт только correlation_id опубликованного события.
Query Parameters
Заголовок раздела «Query Parameters»То же, что заголовок Billz-Response-Channel, — для клиентов, которые не могут передать свой заголовок. Если переданы оба, действует заголовок.
Request Bodyrequired
Заголовок раздела «Request Bodyrequired»object
Пустое -> 400 “name is required”
Тип взаиморасчёта с поставщиком: commission — комиссия, consegnation — консигнация (значение пишется именно так), realization — реализация. Поле справочное: долг перед поставщиком начисляется на всю сумму заказа при его отправке, независимо от типа.
supplier_order или returned
Генерируется сервером
Генерируется сервером
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"}Responses
Заголовок раздела «Responses»Успех. С заголовком Billz-Response-Channel: HTTP — конверт асинхронного ответа, без него — {"message": "<correlation_id>"}.
Конверт асинхронного ответа. Возвращается, когда передан заголовок Billz-Response-Channel: HTTP. Итоговый HTTP-код запроса берётся из поля status_code.
object
Идентификатор сессии клиента
Статус обработки события (он же итоговый HTTP-код ответа)
object
Код ошибки, пустая строка если ошибки нет
Текст ошибки, пустая строка если ошибки нет
Идентификатор запроса, совпадает с ID опубликованного события
Тип ответного события, например <event_type>.success
Результат операции, если метод его возвращает
object
Ответ асинхронного метода без заголовка Billz-Response-Channel — событие опубликовано.
object
Correlation_id опубликованного события
object
Correlation_id, если не задан Billz-Response-Channel: HTTP
Id созданного заказа
object
object
object
object
object
Тип взаиморасчёта с поставщиком: commission — комиссия, consegnation — консигнация, realization — реализация; пустая строка — тип не указан. На сумму долга перед поставщиком не влияет.
object
object
Example
{ "data": { "settlement_type": "commission" }}