Отчет по заказам
Запускает генерацию отчета по заказам за заданный период. Что это за отчет
Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. Как получить детальную информацию по заказам
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
| ⚙️ Лимит: 100 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/reports/united-orders/generate
Query parameters
|
Name |
Type |
Description |
|
format |
Формат отчета. |
|
|
language |
Язык отчета. |
ReportFormatType
Формат отчета:
FILE— файл с электронной таблицей.CSV— ZIP-архив с CSV-файлами на каждый лист отчета.
|
Type |
Description |
|
Enum: |
ReportLanguageType
Язык отчета.
Принимает значение RU — русский язык.
|
Type |
Description |
|
Enum: |
Body
{
"businessId": 0,
"dateFrom": "string",
"dateTo": "string",
"campaignIds": [
0
]
}
|
Name |
Type |
Description |
|
businessId* |
integer<int64> |
Идентификатор бизнеса. |
|
dateFrom* |
string<date> |
Начало периода, включительно. |
|
dateTo* |
string<date> |
Конец периода, включительно. Максимальный период — 1 год. |
|
campaignIds |
integer<int64>[] |
Список магазинов, которые нужны в отчете. |
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
Body
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета. |
GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета.
|
Name |
Type |
Description |
|
reportId* |
string |
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета. |
|
estimatedGenerationTime* |
integer<int64> |
Ожидаемая продолжительность генерации в миллисекундах. |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |