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

Добавить продукт / Продажа по свободной цене

POST
/v2/order-product/{order_id}
curl --request POST \
--url 'https://api-admin.billz.ai/v2/order-product/example?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 '{ "sold_measurement_value": 1, "product_id": "2ce40c63-4527-4898-a975-7c30c255fd50", "used_wholesale_price": false, "is_manual": false, "seller_ids": [ "90219ac7-88b7-43f6-bed9-5c6761aefa71" ] }'

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

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

order_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 format: uuid
sold_measurement_value
required

Продаваемое количество; не более 99 999 999

number format: double
returned_measurement_value

Возвращаемое количество; не более 99 999 999

number format: double
0
used_wholesale_price

Считать по оптовой цене

boolean
use_free_price

Продажа по свободной цене

boolean
free_price

Значение свободной цены

number format: double
0
barcode

Штрихкод

string
seller_ids

Продавцы позиции

Array<string>
is_manual

Ручное изменение позиции

boolean
scanned_product_marking_codes

Отсканированные коды маркировки

Array<string>
removed_product_marking_codes

Снятые коды маркировки

Array<string>
response_type

То же, что заголовок Billz-Response-Channel: HTTP: дождаться результата и вернуть его в ответе

string
Allowed values: HTTP
company_id
string
session_id
string
user_id
string
Examples
{
"sold_measurement_value": 1,
"product_id": "2ce40c63-4527-4898-a975-7c30c255fd50",
"used_wholesale_price": false,
"is_manual": false,
"seller_ids": [
"90219ac7-88b7-43f6-bed9-5c6761aefa71"
]
}

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