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

Deprecated

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

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

Этот метод устарел

Не используйте его.

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

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

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании.

Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:

  • Модули и API → блок Передача данных Маркету.
  • Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

Min value: 1

feedId*

Type: integer<int64>

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

Responses

200 OK

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

Body

application/json
{
    "feed": {
        "id": 0,
        "login": "string",
        "name": "string",
        "password": "string",
        "uploadDate": "2022-12-29T18:02:01Z",
        "url": "string",
        "content": {
            "rejectedOffersCount": 0,
            "status": "ERROR",
            "totalOffersCount": 0,
            "error": {
                "type": "PARSE_ERROR"
            }
        },
        "download": {
            "status": "ERROR",
            "error": {
                "httpStatusCode": 0,
                "type": "DOWNLOAD_ERROR",
                "description": "string"
            }
        },
        "placement": {
            "status": "ERROR",
            "totalOffersCount": 0
        },
        "publication": {
            "status": "ERROR",
            "full": {
                "fileTime": "2022-12-29T18:02:01Z",
                "publishedTime": "2022-12-29T18:02:01Z"
            },
            "priceAndStockUpdate": {
                "fileTime": "2022-12-29T18:02:01Z",
                "publishedTime": "2022-12-29T18:02:01Z"
            }
        }
    }
}

Name

Description

feed

Type: FeedDTO

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

FeedDTO

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

Name

Description

content

Type: FeedContentDTO

Информация о проверке содержимого прайс-листа, загруженного на Маркет.

download

Type: FeedDownloadDTO

Информация о последней загрузке прайс-листа.

id

Type: integer<int64>

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

login

Type: string

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

name

Type: string

Имя файла, содержащего прайс-лист. Параметр выводится при размещении прайс-листа на сервере Маркета.

password

Type: string

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

placement

Type: FeedPlacementDTO

Информация о размещении предложений из прайс-листа на Маркете на момент выполнения запроса.

publication

Type: FeedPublicationDTO

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

uploadDate

Type: string<date-time>

Дата загрузки прайс-листа на Маркет.

Формат даты: ДД-ММ-ГГГГ.

Параметр выводится при размещении прайс-листа на сервере Маркета.

url

Type: string

URL прайс-листа. Параметр выводится при размещении прайс-листа на сайте магазина.

FeedContentDTO

Информация о проверке содержимого прайс-листа, загруженного на Маркет.

Name

Description

error

Type: FeedContentErrorDTO

Информация об ошибке в содержимом прайс-листа. Выводится, если параметр content status=ERROR.

rejectedOffersCount

Type: integer<int64>

Количество предложений, в которых найдены ошибки на этапе загрузки прайс-листа. Выводится, если параметр content status=OK.

status

Type: FeedStatusType

Статус проверки содержимого прайс-листа.

Enum: ERROR, NA, OK

totalOffersCount

Type: integer<int64>

Количество предложений в прайс-листе. Выводится, если параметр content status=OK.

FeedDownloadDTO

Информация о последней загрузке прайс-листа.

Name

Description

error

Type: FeedDownloadErrorDTO

Информация об ошибке при загрузке прайс-листа. Выводится, если параметр download status=ERROR.

status

Type: FeedStatusType

Статус последней загрузки прайс-листа.

Enum: ERROR, NA, OK

FeedPlacementDTO

Информация о размещении предложений из прайс-листа на Маркете на момент выполнения запроса.

Name

Description

status

Type: FeedStatusType

Статус прайс-листа.

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

  • ERROR — найдены ошибки.
  • NA — прайс-лист не загружался более семи дней или на этапе загрузки произошла ошибка.
  • OK — ошибок не найдено.

Enum: ERROR, NA, OK

totalOffersCount

Type: integer<int32>

Количество предложений из прайс-листа, которые размещаются на Яндекс Маркете в момент выполнения запроса.

FeedPublicationDTO

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

Name

Description

full

Type: FeedPublicationFullDTO

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

priceAndStockUpdate

Type: FeedPublicationPriceAndStockUpdateDTO

Последнее обновление цен и наличия товаров на Маркете. Если последнее по времени обновление было полным, в параметре выводятся те же данные, что и в параметре full. Выводится, если параметр publication status=OK.

status

Type: FeedStatusType

Статус прайс-листа.

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

  • ERROR — найдены ошибки.
  • NA — прайс-лист не загружался более семи дней или на этапе загрузки произошла ошибка.
  • OK — ошибок не найдено.

Enum: ERROR, NA, OK

FeedContentErrorDTO

Информация об ошибке в содержимом прайс-листа. Выводится, если параметр content status=ERROR.

Name

Description

type

Type: FeedContentErrorType

Тип ошибки в содержимом прайс-листа.

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

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

Enum: PARSE_ERROR, PARSE_XML_ERROR, TOO_MANY_REJECTED_OFFERS

FeedStatusType

Статус прайс-листа.

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

  • ERROR — найдены ошибки.
  • NA — прайс-лист не загружался более семи дней или на этапе загрузки произошла ошибка.
  • OK — ошибок не найдено.

Type

Description

FeedStatusType

Enum: ERROR, NA, OK

FeedDownloadErrorDTO

Информация об ошибке при загрузке прайс-листа. Выводится, если параметр download status=ERROR.

Name

Description

description

Type: string

Описание ошибки. Выводится, если type=DOWNLOAD_ERROR.

httpStatusCode

Type: integer<int32>

HTTP-код ошибки индексации прайс-листа. Выводится, если type=DOWNLOAD_HTTP_ERROR.

type

Type: FeedDownloadErrorType

Тип ошибки загрузки прайс-листа.

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

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

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

HTTP-код выведен в параметре httpStatusCode.

Enum: DOWNLOAD_ERROR, DOWNLOAD_HTTP_ERROR

FeedPublicationFullDTO

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

Name

Description

fileTime

Type: string<date-time>

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

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

publishedTime

Type: string<date-time>

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

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

FeedPublicationPriceAndStockUpdateDTO

Последнее обновление цен и наличия товаров на Маркете. Если последнее по времени обновление было полным, в параметре выводятся те же данные, что и в параметре full. Выводится, если параметр publication status=OK.

Name

Description

fileTime

Type: string<date-time>

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

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

publishedTime

Type: string<date-time>

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

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

FeedContentErrorType

Тип ошибки в содержимом прайс-листа.

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

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

Type

Description

FeedContentErrorType

Enum: PARSE_ERROR, PARSE_XML_ERROR, TOO_MANY_REJECTED_OFFERS

FeedDownloadErrorType

Тип ошибки загрузки прайс-листа.

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

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

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

HTTP-код выведен в параметре httpStatusCode.

Type

Description

FeedDownloadErrorType

Enum: DOWNLOAD_ERROR, DOWNLOAD_HTTP_ERROR

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

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

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

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