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

Добавить товар к списанию

POST
/v2/write-off/{id}/add
curl --request POST \
--url 'https://api-admin.billz.ai/v2/write-off/example/add?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 '{ "shop_id": "70919136-9481-4c7e-8581-685d750d67a9", "product_id": "aba9d9ad-5d37-4836-81a4-9a60648d087e", "writeoff_measurement_value": 1 }'

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

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

id
required
string

Берётся из пути

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
product_id
required
string
shop_id
required
string
writeoff_measurement_value
required
number format: double
id

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

string
company_id
string
Example
{
"shop_id": "70919136-9481-4c7e-8581-685d750d67a9",
"product_id": "aba9d9ad-5d37-4836-81a4-9a60648d087e",
"writeoff_measurement_value": 1
}

Успех. С заголовком 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
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": {}
}