Отчет по индексации прайс-листа
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- pricing — Управление ценами
- pricing:read-only — Просмотр цен
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.
Данные в отчете возвращаются в порядке убывания значений параметра generationId
.
⚙️ Лимит: 1 000 запросов в час |
---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/index-logs
Path parameters
Name |
Description |
campaignId* |
Type: integer<int64> Идентификатор кампании. Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:
⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.
Min value: |
feedId* |
Type: integer<int64> Идентификатор прайс-листа. |
Query parameters
Name |
Description |
limit |
Type: integer<int32> Количество значений на одной странице.
|
published_time_from |
Type: string<date-time> Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, Значение по умолчанию: последние восемь дней со времени отправки запроса. |
published_time_to |
Type: string<date-time> Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, Значение по умолчанию: дата и время отправки запроса. Вы не получите часть данных Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра |
status |
Type: FeedIndexLogsStatusType Статус индексации и проверки прайс-листа на соответствие техническим требованиям. Возможные значения:
|
FeedIndexLogsStatusType
Статус индексации прайс-листа и проверки на соответствие техническим требованиям.
Возможные значения:
ERROR
— произошли ошибки.OK
— обработан без ошибок.WARNING
— наблюдались некритичные проблемы.
Type |
Description |
Enum: |
Responses
200 OK
Отчет по индексации прайс-листа.
Body
application/json
{
"status": "OK",
"result": {
"feed": {
"id": 0
},
"indexLogRecords": [
{
"downloadTime": "2022-12-29T18:02:01Z",
"fileTime": "2022-12-29T18:02:01Z",
"generationId": 0,
"indexType": "DIFF",
"publishedTime": "2022-12-29T18:02:01Z",
"status": "ERROR",
"error": {
"httpStatusCode": 0,
"type": "DOWNLOAD_ERROR",
"description": "string"
},
"offers": {
"rejectedCount": 0,
"totalCount": 0
}
}
],
"total": 0
}
}
Name |
Description |
result |
Type: FeedIndexLogsResultDTO Результат выполнения запроса отчета по индексации прайс-листа. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
FeedIndexLogsResultDTO
Результат выполнения запроса отчета по индексации прайс-листа.
Name |
Description |
indexLogRecords* |
Type: FeedIndexLogsRecordDTO[] Список отчетов по индексации прайс-листа. |
feed |
Type: FeedIndexLogsFeedDTO Информация о прайс-листе. |
total |
Type: integer<int64> Количество отчетов на всех страницах выходных данных. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
FeedIndexLogsRecordDTO
Список отчетов по индексации прайс-листа.
Name |
Description |
downloadTime |
Type: string<date-time> Дата и время загрузки прайс-листа. Формат даты: ISO 8601 со смещением относительно UTC. Например, |
error |
Type: FeedIndexLogsErrorDTO Информация об ошибке, произошедшей во время индексации прайс-листа. Выводится, если во время индексации произошли ошибки ( |
fileTime |
Type: string<date-time> Дата и время, которые магазин указал в прайс-листе. Формат даты: ISO 8601 со смещением относительно UTC. Например, |
generationId |
Type: integer<int64> Идентификатор индексации. |
indexType |
Type: FeedIndexLogsIndexType Тип обновления. Возможные значения:
Enum: |
offers |
Type: FeedIndexLogsOffersDTO Информация о предложениях прайс-листа. |
publishedTime |
Type: string<date-time> Дата и время публикации предложений из прайс-листа на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, |
status |
Type: FeedIndexLogsStatusType Статус индексации прайс-листа и проверки на соответствие техническим требованиям. Возможные значения:
Enum: |
FeedIndexLogsFeedDTO
Информация о прайс-листе.
Name |
Description |
id |
Type: integer<int64> Идентификатор прайс-листа. |
FeedIndexLogsErrorDTO
Информация об ошибке, произошедшей во время индексации прайс-листа.
Выводится, если во время индексации произошли ошибки (index-log-record status=ERROR
).
Name |
Description |
description |
Type: string Описание ошибки. Выводится, если |
httpStatusCode |
Type: integer<int32> HTTP-код ошибки индексации прайс-листа. Выводится, если |
type |
Type: FeedIndexLogsErrorType Тип ошибки индексации прайс-листа. Возможные значения:
Enum: |
FeedIndexLogsIndexType
Тип обновления.
Возможные значения:
DIFF
— частичное обновление данных на Яндекс Маркете (например, обновление цен ранее опубликованных предложений и публикация новых).FAST_PRICE
— только обновление цен ранее опубликованных предложений.FULL
— полное обновление данных на Яндекс Маркете.
Type |
Description |
Enum: |
FeedIndexLogsOffersDTO
Информация о предложениях прайс-листа.
Name |
Description |
rejectedCount |
Type: integer<int64> Количество предложений, который не опубликованы на Маркете из-за найденных ошибок. |
totalCount |
Type: integer<int64> Количество предложений в прайс-листе. |
FeedIndexLogsErrorType
Тип ошибки индексации прайс-листа.
Возможные значения:
-
DOWNLOAD_ERROR
— ошибка загрузки прайс-листа. Например, проблема с DNS-сервером или обрыв интернет-соединения. Проблема описана в параметреdescription
. -
DOWNLOAD_HTTP_ERROR
— Маркет передал запрос на получение прайс-листа и получил в ответ HTTP-код, отличный от 2xx. HTTP-код выведен в параметреhttpStatusCode
. -
PARSE_ERROR
— ошибка при проверке прайс-листа, не связанная с форматом YML. Например, прайс-лист пустой или его не удалось разархивировать. -
PARSE_XML_ERROR
— несоответствие техническим требованиям формата YML. Например, элементы и их значения описаны некорректно. -
TOO_MANY_REJECTED_OFFERS
— более чем в половине предложений из прайс-листа найдены ошибки. Все предложения из прайс-листа не будут опубликованы на Маркете.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
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: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.