Отчет по индексации прайс-листа

Deprecated

Этот метод устарел. Не используйте его.

Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок.

Данные в отчете возвращаются в порядке убывания значений параметра generationId.

⚙️ Лимит: 1 000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/{feedId}/index-logs

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

feedId*

integer<int64>

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

Query parameters

Name

Type

Description

limit

integer<int32>

Количество товаров на одной странице.
Example: 20

published_time_from

string<date-time>

Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

Значение по умолчанию: последние восемь дней со времени отправки запроса.

published_time_to

string<date-time>

Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-31T00:42:42+03:00.

Значение по умолчанию: дата и время отправки запроса.

Примечание

Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра published_time_to. Значение параметра не должно быть датой из будущего.

status

FeedIndexLogsStatusType

Статус индексации и проверки прайс-листа на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.
  • OK — обработан без ошибок.
  • WARNING — наблюдались некритичные проблемы.

FeedIndexLogsStatusType

Статус индексации прайс-листа и проверки на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.
  • OK — обработан без ошибок.
  • WARNING — наблюдались некритичные проблемы.

Type

Description

FeedIndexLogsStatusType

Enum: ERROR, OK, WARNING

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

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

result

FeedIndexLogsResultDTO

Результат выполнения запроса отчета по индексации прайс-листа.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

FeedIndexLogsResultDTO

Результат выполнения запроса отчета по индексации прайс-листа.

Name

Type

Description

feed

FeedIndexLogsFeedDTO

Информация о прайс-листе.

indexLogRecords

FeedIndexLogsRecordDTO[]

Список отчетов по индексации прайс-листа.
Список отчетов по индексации прайс-листа.

total

integer<int64>

Количество отчетов на всех страницах выходных данных.

FeedIndexLogsFeedDTO

Информация о прайс-листе.

Name

Type

Description

id

integer<int64>

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

FeedIndexLogsRecordDTO

Список отчетов по индексации прайс-листа.

Name

Type

Description

downloadTime

string<date-time>

Дата и время загрузки прайс-листа.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

fileTime

string<date-time>

Дата и время, которые магазин указал в прайс-листе.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

generationId

integer<int64>

Идентификатор индексации.

indexType

FeedIndexLogsIndexType

Тип обновления.

Возможные значения:

  • DIFF — частичное обновление данных на Яндекс Маркете (например, обновление цен ранее опубликованных предложений и публикация новых).
  • FAST_PRICE — только обновление цен ранее опубликованных предложений.
  • FULL — полное обновление данных на Яндекс Маркете.


Enum: DIFF, FAST_PRICE, FULL

publishedTime

string<date-time>

Дата и время публикации предложений из прайс-листа на Яндекс Маркете.

Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:42:42+03:00.

status

FeedIndexLogsStatusType

Статус индексации прайс-листа и проверки на соответствие техническим требованиям.

Возможные значения:

  • ERROR — произошли ошибки.
  • OK — обработан без ошибок.
  • WARNING — наблюдались некритичные проблемы.


Enum: ERROR, OK, WARNING

error

FeedIndexLogsErrorDTO

Информация об ошибке, произошедшей во время индексации прайс-листа.

Выводится, если во время индексации произошли ошибки (index-log-record status=ERROR).

offers

FeedIndexLogsOffersDTO

Информация о предложениях прайс-листа.

FeedIndexLogsIndexType

Тип обновления.

Возможные значения:

  • DIFF — частичное обновление данных на Яндекс Маркете (например, обновление цен ранее опубликованных предложений и публикация новых).
  • FAST_PRICE — только обновление цен ранее опубликованных предложений.
  • FULL — полное обновление данных на Яндекс Маркете.

Type

Description

FeedIndexLogsIndexType

Enum: DIFF, FAST_PRICE, FULL

FeedIndexLogsErrorDTO

Информация об ошибке, произошедшей во время индексации прайс-листа.

Выводится, если во время индексации произошли ошибки (index-log-record status=ERROR).

Name

Type

Description

httpStatusCode

integer<int32>

HTTP-код ошибки индексации прайс-листа.

Выводится, если type=DOWNLOAD_HTTP_ERROR.

type

FeedIndexLogsErrorType

Тип ошибки индексации прайс-листа.

Возможные значения:

  • DOWNLOAD_ERROR — ошибка загрузки прайс-листа. Например, проблема с DNS-сервером или обрыв интернет-соединения. Проблема описана в параметре description.

  • DOWNLOAD_HTTP_ERROR — Маркет передал запрос на получение прайс-листа и получил в ответ HTTP-код, отличный от 2xx. HTTP-код выведен в параметре httpStatusCode.

  • PARSE_ERROR — ошибка при проверке прайс-листа, не связанная с форматом YML. Например, прайс-лист пустой или его не удалось разархивировать.

  • PARSE_XML_ERROR — несоответствие техническим требованиям формата YML. Например, элементы и их значения описаны некорректно.

  • TOO_MANY_REJECTED_OFFERS — более чем в половине предложений из прайс-листа найдены ошибки. Все предложения из прайс-листа не будут опубликованы на Маркете.


Enum: DOWNLOAD_ERROR, DOWNLOAD_HTTP_ERROR, PARSE_ERROR, PARSE_XML_ERROR, TOO_MANY_REJECTED_OFFERS, NOT_INDEXED

description

string

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

Выводится, если type=DOWNLOAD_ERROR.

FeedIndexLogsOffersDTO

Информация о предложениях прайс-листа.

Name

Type

Description

rejectedCount

integer<int64>

Количество предложений, который не опубликованы на Маркете из-за найденных ошибок.

totalCount

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

FeedIndexLogsErrorType

Enum: DOWNLOAD_ERROR, DOWNLOAD_HTTP_ERROR, PARSE_ERROR, PARSE_XML_ERROR, TOO_MANY_REJECTED_OFFERS, NOT_INDEXED

400 Bad Request

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

ApiErrorDTO

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

Name

Type

Description

code*

string

Код ошибки.

message

string

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

401 Unauthorized

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

403 Forbidden

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

404 Not Found

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

420 Method Failure

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

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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

500 Internal Server Error

Внутренняя ошибка сервера.

Body

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

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

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