Получение информации о заполненности карточек магазина
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- offers-and-cards-management — Управление товарами и карточками
- offers-and-cards-management:read-only — Просмотр товаров и карточек
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Возвращает сведения о состоянии контента для заданных товаров:
- создана ли карточка товара и в каком она статусе;
- рейтинг карточки — на сколько процентов она заполнена;
- переданные характеристики товаров;
- есть ли ошибки или предупреждения, связанные с контентом;
- рекомендации по заполнению карточки.
⚙️ Лимит: 600 запросов в минуту |
---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards
Path parameters
Name |
Description |
businessId* |
Type: integer<int64> Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
Query parameters
Name |
Description |
limit |
Type: integer<int32> Количество значений на одной странице.
|
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуем передавать значение выходного параметра Если задан |
Body
application/json
{
"offerIds": [
"string"
],
"cardStatuses": [
"HAS_CARD_CAN_NOT_UPDATE"
],
"categoryIds": [
0
]
}
Name |
Description |
cardStatuses |
Type: OfferCardStatusType[] Фильтр по статусам карточек. Что такое карточка товара
Что обозначает каждый из статусов Enum: Min items: Unique items |
categoryIds |
Type: integer<int32>[] Фильтр по категориям на Маркете. При изменении категории убедитесь, что характеристики товара и их значения в параметре Список категорий Маркета можно получить с помощью запроса POST categories/tree. Min value: Min items: Max items: Unique items |
offerIds |
Type: string[] Идентификаторы товаров, информация о которых нужна.
Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: Max length: Pattern: Min items: Max items: Unique items |
OfferCardStatusType
Статус карточки товара:
HAS_CARD_CAN_NOT_UPDATE
— Карточка Маркета.HAS_CARD_CAN_UPDATE
— Можно дополнить.HAS_CARD_CAN_UPDATE_ERRORS
— Изменения не приняты.HAS_CARD_CAN_UPDATE_PROCESSING
— Изменения на проверке.NO_CARD_NEED_CONTENT
— Создайте карточку.NO_CARD_MARKET_WILL_CREATE
— Создаст Маркет.NO_CARD_ERRORS
— Не создана из-за ошибки.NO_CARD_PROCESSING
— Проверяем данные.NO_CARD_ADD_TO_CAMPAIGN
— Разместите товар в магазине.
Что обозначает каждый из статусов
Type |
Description |
Enum: |
Responses
200 OK
Информация о карточках указанных товаров.
Body
application/json
{
"status": "OK",
"result": {
"offerCards": [
{
"offerId": "string",
"mapping": {
"marketSku": 0,
"marketSkuName": "string",
"marketModelId": 0,
"marketModelName": "string",
"marketCategoryId": 0,
"marketCategoryName": "string"
},
"parameterValues": [
{
"parameterId": 0,
"unitId": 0,
"valueId": 0,
"value": "string"
}
],
"cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
"contentRating": 0,
"averageContentRating": 0,
"contentRatingStatus": "UPDATING",
"recommendations": [
{
"type": "HAS_VIDEO",
"percent": 0,
"remainingRatingPoints": 0
}
],
"errors": [
{
"message": "string",
"comment": "string"
}
],
"warnings": [
{
"message": "string",
"comment": "string"
}
]
}
],
"paging": {
"nextPageToken": "string"
}
}
}
Name |
Description |
result |
Type: OfferCardsContentStatusDTO Список товаров с информацией о состоянии карточек. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
OfferCardsContentStatusDTO
Список товаров с информацией о состоянии карточек.
Name |
Description |
offerCards* |
Type: OfferCardDTO[] Страница списка товаров с информацией о состоянии карточек. Если поле |
paging |
Type: ForwardScrollingPagerDTO Идентификатор следующей страницы. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
OfferCardDTO
Информация о состоянии карточки товара.
Если поле mapping
отсутствует в ответе, Маркет еще не успел обработать информацию о товаре. Чтобы определить категорию такого товара, повторите запрос через несколько минут.
Name |
Description |
offerId* |
Type: string Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: Max length: Pattern: |
averageContentRating |
Type: integer<int32> Средний рейтинг карточки у товаров той категории, которая указана в |
cardStatus |
Type: OfferCardStatusType Статус карточки товара:
Что обозначает каждый из статусов Enum: |
contentRating |
Type: integer<int32> Рейтинг карточки. |
contentRatingStatus |
Type: OfferCardContentStatusType Статус вычисления рейтинга карточки и рекомендаций. Enum: |
errors |
Type: OfferErrorDTO[] Ошибки в контенте, препятствующие размещению товара на витрине. Min items: |
mapping |
Type: GetMappingDTO Основная информация о карточке товара. Может отсутствовать в ответе, если товар еще не привязан к карточке. Проверьте статус карточки или исправьте ошибки. |
parameterValues |
Type: ParameterValueDTO[] Список характеристик с их значениями.
Вы можете указывать несколько значений одной характеристики при условии, что:
Для этого в Min items: |
recommendations |
Type: OfferCardRecommendationDTO[] Список рекомендаций к заполнению карточки. Рекомендации Маркета помогают заполнять карточку так, чтобы покупателям было проще найти ваш товар и решиться на покупку.
Min items: |
warnings |
Type: OfferErrorDTO[] Связанные с контентом предупреждения, не препятствующие размещению товара на витрине. Min items: |
ForwardScrollingPagerDTO
Идентификатор следующей страницы.
Name |
Description |
nextPageToken |
Type: string Идентификатор следующей страницы результатов. |
OfferCardContentStatusType
Статус вычисления рейтинга карточки товара и рекомендаций:
UPDATING
— рейтинг обновляется.ACTUAL
— рейтинг актуальный.
Type |
Description |
Enum: |
OfferErrorDTO
Сообщение об ошибке, связанной с размещением товара.
Name |
Description |
comment |
Type: string Пояснение. |
message |
Type: string Тип ошибки. |
GetMappingDTO
Информация о товарах в каталоге.
Name |
Description |
marketCategoryId |
Type: integer<int64> Идентификатор категории на Маркете, в которую попал товар. Может отсутствовать в ответе, если Маркет еще не определил категорию товара. |
marketCategoryName |
Type: string Название категории карточки на Маркете. Может отсутствовать в ответе, если Маркет еще не определил категорию товара. |
marketModelId ⦸
|
Type: integer<int64> Идентификатор модели на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке. |
marketModelName ⦸
|
Type: string Название модели на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке. |
marketSku |
Type: integer<int64> Идентификатор карточки на Маркете. Min value: |
marketSkuName |
Type: string Название карточки товара. Может отсутствовать в ответе, если товар еще не привязан к карточке. |
ParameterValueDTO
Значение характеристики.
Вы можете указывать несколько значений одной характеристики при условии, что:
- Тип характеристики —
ENUM
. - В ответе на запрос POST category/{categoryId}/parameters у данной характеристики поле
multivalue
имеет значениеtrue
.
Для этого в parameterValues
передавайте каждое значение отдельно — несколько объектов с параметрами parameterId
, valueId
и value
. Параметр parameterId
должен быть одинаковым.
Name |
Description |
parameterId* |
Type: integer<int64> Идентификатор характеристики. Min value: |
unitId |
Type: integer<int64> Идентификатор единицы измерения. Если вы не передали параметр |
value |
Type: string Значение. |
valueId |
Type: integer<int64> Идентификатор значения. Обязательно указывайте идентификатор, если передаете значение из перечня допустимых значений, полученного от Маркета. Только для характеристик типа |
OfferCardRecommendationDTO
Рекомендация по заполнению карточки товара.
Name |
Description |
type* |
Type: OfferCardRecommendationType Рекомендация по дополнению или замене контента. Не возвращается для карточек, которые заполнены Маркетом или содержат бывшие в употреблении товары. Часть рекомендаций относятся к основным параметрам, которые есть у товаров любых категорий. Другие — к тем характеристикам, которые есть у товара потому, что он относится к определенной категории. 1. Рекомендации, относящиеся к основным параметрам Каждая такая рекомендация относится к единственному параметру. Чтобы заполнить этот параметр, пользуйтесь запросом POST businesses/{businessId}/offer-mappings/update. Рекомендации по заполнению параметров в
2. Рекомендации, относящиеся к характеристикам по категориям Каждая такая рекомендация предполагает заполнение одной или нескольких характеристик. Чтобы узнать, какие именно характеристики нужно заполнить, воспользуйтесь запросом POST category/{categoryId}/parameters. Например, если вы получили рекомендацию Рекомендации:
3. Устаревшие рекомендации
Enum: |
percent |
Type: integer<int32> Процент выполнения рекомендации. Указывается для рекомендаций некоторых типов:
Min value: Max value (exclusive): |
remainingRatingPoints |
Type: integer<int32> Максимальное количество баллов рейтинга карточки, которые можно получить за выполнение рекомендаций. Min value: Max value: |
OfferCardRecommendationType
Рекомендация по дополнению или замене контента. Не возвращается для карточек, которые заполнены Маркетом или содержат бывшие в употреблении товары.
Часть рекомендаций относятся к основным параметрам, которые есть у товаров любых категорий. Другие — к тем характеристикам, которые есть у товара потому, что он относится к определенной категории.
1. Рекомендации, относящиеся к основным параметрам
Каждая такая рекомендация относится к единственному параметру. Чтобы заполнить этот параметр, пользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.
Рекомендации по заполнению параметров в updateOfferMappings
:
-
RECOGNIZED_VENDOR
— напишите название производителя так, как его пишет сам производитель (параметрvendor
). -
PICTURE_COUNT
— добавьте изображения (параметрpictures
). ТребованияДля рекомендации приходит процент ее выполнения.
-
FIRST_PICTURE_SIZE
— замените первое изображение более крупным (параметрpictures
). Требования -
TITLE_LENGTH
— измените название (параметрname
). Составьте название по схеме: тип + бренд или производитель + модель + особенности, если есть (размер, вес, цвет). Требования -
DESCRIPTION_LENGTH
— добавьте описание рекомендуемого размера (параметрdescription
). Требования -
AVERAGE_PICTURE_SIZE
— замените все изображения на изображения высокого качества (параметрpictures
). Требования -
FIRST_VIDEO_LENGTH
— добавьте первое видео рекомендуемой длины (параметрvideos
). Требования -
FIRST_VIDEO_SIZE
— замените первое видео на видео высокого качества (параметрvideos
). Требования -
AVERAGE_VIDEO_SIZE
— замените все видео на видео высокого качества (параметрvideos
). Требования -
VIDEO_COUNT
— добавьте хотя бы одно видео (параметрvideos
). ТребованияДля рекомендации приходит процент ее выполнения.
2. Рекомендации, относящиеся к характеристикам по категориям
Каждая такая рекомендация предполагает заполнение одной или нескольких характеристик. Чтобы узнать, какие именно характеристики нужно заполнить, воспользуйтесь запросом POST category/{categoryId}/parameters. Например, если вы получили рекомендацию MAIN
, нужно заполнить характеристики, имеющие MAIN
в массиве recommendationTypes
.
Рекомендации:
-
MAIN
— заполните ключевые характеристики товара, которые используются в поиске и фильтрах.Для рекомендации приходит процент ее выполнения.
-
ADDITIONAL
— заполните дополнительные характеристики товара.Для рекомендации приходит процент ее выполнения.
-
DISTINCTIVE
— заполните характеристики, которыми отличаются друг от друга варианты товара.Для рекомендации приходит процент ее выполнения.
3. Устаревшие рекомендации
HAS_VIDEO
.FILTERABLE
.HAS_DESCRIPTION
.HAS_BARCODE
.
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.