Получение заданного отчета или документа

Info

Console

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
pricing — Управление ценами
pricing:read-only — Просмотр цен
offers-and-cards-management — Управление товарами и карточками
offers-and-cards-management:read-only — Просмотр товаров и карточек
promotion — Продвижение товаров
promotion:read-only — Просмотр информации о продвижении товаров
finance-and-accounting — Просмотр финансовой информации и отчётности
communication — Общение с покупателями
settings-management — Настройка магазинов
supplies-management:read-only — Получение информации по FBY-заявкам
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает статус генерации заданного отчета или документа и, если он готов, ссылку для скачивания.

Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета или документа. Инструкция

⚙️ Лимит: 100 запросов в минуту

Request

GET

https://api.partner.market.yandex.ru/reports/info/{reportId}

Path parameters

Name

Description

reportId*

Type: string

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

Min length: 1

Max length: 255

Responses

200 OK

Статус генерации отчета или документа и ссылка, если она уже есть.

Статус генерации FAILED или NO_DATA

Проверьте корректность запроса на генерацию. Например, верно ли указан идентификатор кампании, период или номер платежного поручения.

Body

application/json

{
    "status": "OK",
    "result": {
        "status": "PENDING",
        "subStatus": "NO_DATA",
        "generationRequestedAt": "2022-12-29T18:02:01Z",
        "generationFinishedAt": "2022-12-29T18:02:01Z",
        "file": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

result

Type: ReportInfoDTO

Статус генерации и ссылка на готовый отчет или документ.

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ReportInfoDTO

Статус генерации и ссылка на готовый отчет или документ.

Name	Description
generationRequestedAt*	Type: string<date-time> Дата и время запроса на генерацию.
status*	Type: ReportStatusType Статус генерации: `PENDING` — ожидает генерации. `PROCESSING` — генерируется. `FAILED` — во время генерации произошла ошибка. `DONE` — отчет или документ готов. Enum: `PENDING`, `PROCESSING`, `FAILED`, `DONE`
estimatedGenerationTime	Type: integer<int64> Ожидаемая продолжительность генерации в миллисекундах.
file	Type: string Ссылка на готовый отчет или документ.
generationFinishedAt	Type: string<date-time> Дата и время завершения генерации.
subStatus	Type: ReportSubStatusType Подстатус генерации: `NO_DATA` — для такого отчета или документа нет данных. `TOO_LARGE` — отчет или документ превысил допустимый размер — укажите меньший период времени или уточните условия запроса. `RESOURCE_NOT_FOUND` — для такого отчета или документа не удалось найти часть сущностей. Enum: `NO_DATA`, `TOO_LARGE`, `RESOURCE_NOT_FOUND`

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ReportStatusType

Статус генерации:

PENDING — ожидает генерации.
PROCESSING — генерируется.
FAILED — во время генерации произошла ошибка.
DONE — отчет или документ готов.

Type	Description
ReportStatusType	Enum: `PENDING`, `PROCESSING`, `FAILED`, `DONE`

ReportSubStatusType

Подстатус генерации:

NO_DATA — для такого отчета или документа нет данных.
TOO_LARGE — отчет или документ превысил допустимый размер — укажите меньший период времени или уточните условия запроса.
RESOURCE_NOT_FOUND — для такого отчета или документа не удалось найти часть сущностей.

Type	Description
ReportSubStatusType	Enum: `NO_DATA`, `TOO_LARGE`, `RESOURCE_NOT_FOUND`

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Была ли статья полезна?

Отчет «Цены на рынке»

Все отзывы