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

Создание одного товара

POST
/v2/product
curl --request POST \
--url 'https://api-admin.billz.ai/v2/product?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 '{ "barcode": "24409390003634", "category_ids": [], "company_id": "17a36439-d140-454d-aedb-ae1585681db1", "has_expiration_date": false, "images": [], "free_price": false, "is_auto_delivery": true, "is_auto_tax": true, "is_divisible": false, "is_variative": false, "measurement_unit_id": "c5336f71-d684-4e2e-b5bc-307138593543", "name": "from api, shorten 3", "product_type_id": "69e939aa-9b8f-46a9-b605-8b2675475b7b", "retail_price": 11000, "shipments": [ { "has_trigger": false, "measurement_value": 1, "shop_id": "6f244db4-75d6-4fac-9841-14867d45e36a", "small_left_measurement_value": 0 } ], "shop_prices": [ { "shop_id": "6f244db4-75d6-4fac-9841-14867d45e36a", "retail_price": 11000, "supply_price": 1, "wholesale_price": 0, "min_price": 0, "max_price": 0 }, { "shop_id": "70919136-9481-4c7e-8581-685d750d67a9", "retail_price": 11000, "supply_price": 1, "wholesale_price": 0, "min_price": 0, "max_price": 0 }, { "shop_id": "803b542d-51e5-41ea-9124-51f248536286", "retail_price": 11000, "supply_price": 1, "wholesale_price": 0, "min_price": 0, "max_price": 0 } ], "sku": "JSI-62299", "supplier_ids": [], "supply_price": 1, "variants": [], "is_marked": false }'

Асинхронный метод. Чтобы получить результат синхронно по 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
product_type_id
required

Тип товара

string
name
required

Название; не более 1000 символов

string
sku
required

Артикул; не более 1000 символов

string
barcode
required

Штрихкод; не более 1000 символов

string
measurement_unit_id
required
string
shipments
required

Начальный приход по магазинам

Array<object>
object
shop_id
string format: uuid
measurement_value
number
small_left_measurement_value
number
has_trigger
boolean
supply_price
number
supplier_id
string format: uuid
shop_prices
required

Цены по магазинам

Array<object>
object
shop_id
string format: uuid
retail_price
number
supply_price
number
min_supply_price
number
max_supply_price
number
wholesale_price
number
min_price
number
max_price
number
prices_list
from_supply_price
company_id
string
id

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

string
additional_barcodes

Дополнительные штрихкоды

Array<object>
object
barcode
string
description

Описание; не более 10 000 символов

string
brand_id
string
category_ids
Array<string>
supplier_id

Поставщик

string
supplier_ids
Array<string>
has_expiration_date
boolean
is_divisible
boolean
is_variative
boolean
supply_price
number format: double
retail_price
number format: double
profit_margin
number format: double
required_modificators_count
integer format: int32
max_modificators_count
integer format: int32
is_auto_tax
boolean
tax_tariff_id
string
delivery_tariff_id
string
is_auto_delivery
boolean
measurement_type

COUNTABLE|UNCOUNTABLE

string
selected_attributes
Array<string>
variants

Вариации; при превышении лимита — 400

Array<object>
object
images
Array<object>
object
image
string
sequence_number
string
is_main
string
product_custom_fields
Array<object>
object
product_characteristic_id
string
value
string
packages
Array<string>
product_modificators
Array<string>
related_product_ids
Array<string>
set_products

Состав набора; при превышении лимита — 400

Array<object>
object
stocktaking_id
string
is_marked
boolean
free_price
boolean
scale_plu
integer format: int32
is_scalable

Весовой товар

boolean
shop_free_prices
Array<object>
object
shop_id
string
sell_with_free_price
string
billz-response-channel

Значение HTTP — синхронный ответ. Работает и как заголовок, и как query-параметр ?Billz-Response-Channel=HTTP

string
Example
{
"barcode": "24409390003634",
"category_ids": [],
"company_id": "17a36439-d140-454d-aedb-ae1585681db1",
"has_expiration_date": false,
"images": [],
"free_price": false,
"is_auto_delivery": true,
"is_auto_tax": true,
"is_divisible": false,
"is_variative": false,
"measurement_unit_id": "c5336f71-d684-4e2e-b5bc-307138593543",
"name": "from api, shorten 3",
"product_type_id": "69e939aa-9b8f-46a9-b605-8b2675475b7b",
"retail_price": 11000,
"shipments": [
{
"has_trigger": false,
"measurement_value": 1,
"shop_id": "6f244db4-75d6-4fac-9841-14867d45e36a",
"small_left_measurement_value": 0
}
],
"shop_prices": [
{
"shop_id": "6f244db4-75d6-4fac-9841-14867d45e36a",
"retail_price": 11000,
"supply_price": 1,
"wholesale_price": 0,
"min_price": 0,
"max_price": 0
},
{
"shop_id": "70919136-9481-4c7e-8581-685d750d67a9",
"retail_price": 11000,
"supply_price": 1,
"wholesale_price": 0,
"min_price": 0,
"max_price": 0
},
{
"shop_id": "803b542d-51e5-41ea-9124-51f248536286",
"retail_price": 11000,
"supply_price": 1,
"wholesale_price": 0,
"min_price": 0,
"max_price": 0
}
],
"sku": "JSI-62299",
"supplier_ids": [],
"supply_price": 1,
"variants": [],
"is_marked": false
}

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