Заказать формирование файлового отчёта

POST /v1/report/create

POST/v1/report/create

Тело запроса

report_type
string
required

Тип отчёта.

Допустимые значения
SALESSTOCKSORDERSRETURNSFINANCIALPRODUCTS
date_from
string

Начало периода отчёта (RFC3339).

date_to
string

Окончание периода отчёта (RFC3339).

format
string

Формат файла.

Допустимые значения
CSVXLSX
filter
object

Дополнительные фильтры.

Показать свойства
market_location_ids
array

Фильтр по складам.

offer_id
array

Фильтр по артикулам.

product_id
array

Фильтр по товарам.

idempotency_key
string

Ключ идемпотентности. Повтор с тем же ключом возвращает первый успешный результат.

Успешный ответ

200A successful response.
application/json
object
report_id
string

Идентификатор заказанного отчёта.

status
string

Статус формирования.

Допустимые значения
PENDINGPROCESSINGSUCCESSFAILED
file
object

Файл отчёта.

Показать свойства
file_id
string

Идентификатор файла.

name
string

Имя файла.

url
string

Ссылка для скачивания.

expires_at
string

Время истечения ссылки (RFC3339).

Ошибки

400Некорректный запрос
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
401Ошибка авторизации
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
429Превышен лимит запросов
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
POST/v1/report/create
1curl https://api.omninet.ru/v1/report/create \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "report_type": "string",6  "date_from": "string",7  "date_to": "string",8  "format": "CSV",9  "filter": {10    "market_location_ids": [11      "string"12    ],13    "offer_id": [14      "string"15    ],16    "product_id": [17      "string"18    ]19  },20  "idempotency_key": "string"21}'
{
  "report_id": "string",
  "status": "string",
  "file": {
    "file_id": "string",
    "name": "string",
    "url": "string",
    "expires_at": "string"
  }
}

A successful response.