Перейти к содержимому
BILLZ для разработчиков

Результаты инвентаризации

POST
/v1/stocktaking-summary-table-excel-export
curl --request POST \
  --url 'https://api-admin.billz.ai/v1/stocktaking-summary-table-excel-export?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 '{ "stocktaking_guid": "eeeeaf2b-1360-4f03-aa74-87ad7cc2edd7", "currency": "UZS", "fields": [ "product_name", "expected_measurement_value", "scanned_measurement_value" ] }'

Асинхронный метод. Файл собирается в фоне. Заголовок Billz-Response-Channel: HTTP обязателен: только с ним в ответ придёт ссылка на готовый файл, ожидание — до 100 секунд. Без заголовка ответ будет 200 {"message": "<correlation_id>"}, и забрать файл через API уже нельзя: ссылка уйдёт уведомлением в интерфейс BILLZ.

Итоги одной инвентаризации: заявлено, проверено, что списано и доимпортировано по её результатам. Периода у отчёта нет — это снимок на момент завершения.

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

Authorizations

Заголовок раздела «Authorizations»

Parameters

Заголовок раздела «Parameters»

Header Parameters

Заголовок раздела «Header Parameters»
platform-id
string
default: 7d4a4c38-dd84-4902-b744-0488b80a4c01

Идентификатор платформы. Для интеграций используется статичное значение.

Billz-Response-Channel
string
Allowed values: HTTP

HTTP — дождаться результата обработки события и вернуть его в HTTP-ответе. Без заголовка метод вернёт только correlation_id опубликованного события.

Query Parameters

Заголовок раздела «Query Parameters»
Billz-Response-Channel
string
Allowed values: HTTP

То же, что заголовок Billz-Response-Channel, — для клиентов, которые не могут передать свой заголовок. Если переданы оба, действует заголовок.

Request Bodyrequired

Заголовок раздела «Request Bodyrequired»
Media typeapplication/json
object
stocktaking_guid
required

Инвентаризация, итоги которой нужны; UUID из GET /v2/stocktaking

string format: uuid
currency

Валюта, в которой показать суммы

string
fields

Колонки файла в порядке следования. Без fields в файле не будет колонок с данными; список значений — Экспорт отчётов в Excel. Вместо названия колонки можно передать UUID атрибута или кастомного поля товара — тогда колонка возьмёт его название и значения из карточек товаров

Array<string>
Example
{
  "stocktaking_guid": "eeeeaf2b-1360-4f03-aa74-87ad7cc2edd7",
  "currency": "UZS",
  "fields": [
    "product_name",
    "expected_measurement_value",
    "scanned_measurement_value"
  ]
}

Responses

Заголовок раздела «Responses»

200

Заголовок раздела «200»

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