Создать
const url = 'https://api-admin.billz.ai/v2/transfer?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: '{"arrival_shop_id":"92302dfb-fa33-4e6a-8d19-87214852b25d","departure_shop_id":"fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6","name":"Трансфер 2023.05.17 14:47"}'};
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/transfer?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 '{ "arrival_shop_id": "92302dfb-fa33-4e6a-8d19-87214852b25d", "departure_shop_id": "fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6", "name": "Трансфер 2023.05.17 14:47" }'Асинхронный метод. Чтобы получить результат синхронно по 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
Позиции можно передать сразу при создании
object
Генерируется сервером
Генерируется сервером
object
Example
{ "arrival_shop_id": "92302dfb-fa33-4e6a-8d19-87214852b25d", "departure_shop_id": "fbfb9d6c-cbb2-43ab-8c90-e97d2eeb34d6", "name": "Трансфер 2023.05.17 14:47"}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
Examplegenerated
{ "session_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "status_code": 1, "error": { "code": "example", "message": "example" }, "correlation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "topic": "example", "data": {}}