Request
Responses
200 OK
400 Bad Request
- Body
- ApiErrorDTO
401 Unauthorized
- Body
403 Forbidden
- Body
404 Not Found
- Body
420 Method Failure
- Body
500 Internal Server Error
- Body

Получение информации о заполненности карточек

Info

Console

Возвращает сведения о состоянии контента для заданных товаров:

создана ли карточка товара и в каком она статусе;
заполненность карточки в процентах;
есть ли ошибки или предупреждения, связанные с контентом;
рекомендации по заполнению карточки.

⚙️ Лимит: рассчитывается по формуле

Request

POST

https://api.partner.market.yandex.ru/businesses/{businessId}/offer-cards

Path parameters

Name

Type

Description

businessId*

integer<int64>

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

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

Query parameters

Name

Type

Description

page_token

string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается самая старая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token, параметры offset, page_number и page_size игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

limit

integer<int32>

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

Body

application/json

{
    "offerIds": [
        "string"
    ],
    "cardStatuses": [
        "HAS_CARD_CAN_NOT_UPDATE"
    ],
    "categoryIds": [
        0
    ]
}

Name	Type	Description
offerIds	string[]	Идентификаторы товаров, информация о которых нужна. ⚠️ Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым. Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы `. , / \ ( ) [ ] - = _` Правила использования SKU: У каждого товара SKU должен быть свой. SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. Что такое SKU и как его назначать.
cardStatuses	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 — Разместите товар в магазине. Что обозначает каждый из статусов Enum: `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`
categoryIds	integer<int32>[]	Фильтр по категориям на Маркете. Идентификатор категории на Маркете.

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
OfferCardStatusType	Enum: `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`

200 OK

Информация о карточках указанных товаров.

Body

application/json

{
    "status": "OK",
    "result": {
        "offerCards": [
            {
                "offerId": "string",
                "mapping": {
                    "marketSku": 0,
                    "marketSkuName": "string",
                    "marketModelId": 0,
                    "marketModelName": "string",
                    "marketCategoryId": 0,
                    "marketCategoryName": "string"
                },
                "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
                "contentRating": 0,
                "recommendations": [
                    {
                        "type": "HAS_VIDEO",
                        "percent": 0
                    }
                ],
                "errors": [
                    {
                        "message": "string",
                        "comment": "string"
                    }
                ],
                "warnings": [
                    {
                        "message": "string",
                        "comment": "string"
                    }
                ]
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
result	OfferCardsContentStatusDTO	Список товаров с информацией о состоянии карточек.

ApiResponseStatusType

Тип ответа.

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

OfferCardsContentStatusDTO

Список товаров с информацией о состоянии карточек.

Name

Type

Description

offerCards

OfferCardDTO[]

Страница списка товаров с информацией о состоянии карточек.
Информация о состоянии карточки товара.

Если поле mapping отсутствует в ответе, Маркет еще не успел обработать информацию о товаре. Чтобы определить категорию такого товара, повторите запрос через несколько минут.

paging

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

OfferCardDTO

Информация о состоянии карточки товара.

Name	Type	Description
offerId*	string	Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы `. , / \ ( ) [ ] - = _` Правила использования SKU: У каждого товара SKU должен быть свой. SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. Что такое SKU и как его назначать.
mapping	GetMappingDTO	Основная информация о карточке товара. Идентификатор карточки на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке.
cardStatus	OfferCardStatusType	Статус карточки. Enum: `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`
contentRating	integer<int32>	Процент заполненности карточки.
recommendations	OfferCardRecommendationDTO[]	Список рекомендаций к заполнению карточки. Рекомендации Маркета помогают заполнять карточку так, чтобы покупателям было проще найти ваш товар и решиться на покупку. Рекомендация по заполнению карточки товара.
errors	OfferErrorDTO[]	Ошибки в контенте, препятствующие размещению товара на витрине. Сообщение об ошибке, связанной с размещением товара.
warnings	OfferErrorDTO[]	Связанные с контентом предупреждения, не препятствующие размещению товара на витрине. Сообщение об ошибке, связанной с размещением товара.

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name	Type	Description
nextPageToken	string	Идентификатор следующей страницы результатов.

GetMappingDTO

Информация о товарах в каталоге.

Name	Type	Description
marketSku	integer<int64>	Идентификатор карточки на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке.
marketSkuName	string	Название карточки товара. Может отсутствовать в ответе, если товар еще не привязан к карточке.
marketModelId	integer<int64>	Идентификатор модели на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке.
marketModelName	string	Название модели на Маркете. Может отсутствовать в ответе, если товар еще не привязан к карточке.
marketCategoryId	integer<int64>	Идентификатор категории карточки на Маркете. Может отсутствовать в ответе, если Маркет еще не определил категорию товара.
marketCategoryName	string	Название категории карточки на Маркете. Может отсутствовать в ответе, если Маркет еще не определил категорию товара.

OfferCardRecommendationDTO

Рекомендация по заполнению карточки товара.

Name	Type	Description
type*	OfferCardRecommendationType	Рекомендация. Enum: `HAS_VIDEO`, `RECOGNIZED_VENDOR`, `MAIN`, `ADDITIONAL`, `DISTINCTIVE`, `FILTERABLE`, `PICTURE_COUNT`, `HAS_DESCRIPTION`, `HAS_BARCODE`, `FIRST_PICTURE_SIZE`
percent	integer<int32>	Процент выполнения рекомендации. Указывается для рекомендаций некоторых типов.

OfferErrorDTO

Сообщение об ошибке, связанной с размещением товара.

Name	Type	Description
message	string	Тип ошибки.
comment	string	Пояснение.

OfferCardRecommendationType

Рекомендация по дополнению или замене контента.

Часть рекомендаций относятся к основным параметрам, которые есть у товаров любых категорий. Другие — к тем характеристикам, которые есть у товара потому, что он относится к определенной категории.

1. Рекомендации, относящиеся к основным параметрам

Каждая такая рекомендация относится к единственному параметру. Чтобы заполнить этот параметр, пользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

Рекомендация	Содержание	Параметр в updateOfferMappings
`HAS_VIDEO`	Добавьте на карточку видео.	`videos`
`RECOGNIZED_VENDOR`	Напишите название производителя так, как его пишет сам производитель.	`vendor`
`PICTURE_COUNT`	Добавьте изображения.	`pictures`
`HAS_DESCRIPTION`	Заполните описание.	`description`
`HAS_BARCODE`	Укажите штрихкод.	`barcode`
`FIRST_PICTURE_SIZE`	Замените первое изображение более крупным.	`pictures`

2. Рекомендации, относящиеся к характеристикам по категориям

Каждая такая рекомендация предполагает заполнение одной или нескольких характеристик. Чтобы узнать, какие именно характеристики нужно заполнить, воспользуйтесь запросом POST category/{categoryId}/parameters. Например, если вы получили рекомендацию MAIN, нужно заполнить характеристики, имеющие MAIN в массиве recommendationTypes.

Рекомендация	Содержание
`MAIN`	Заполните ключевые характеристики товара.
`ADDITIONAL`	Заполните дополнительные характеристики товара.
`FILTERABLE`	Заполните характеристики, используемые в фильтрах.
`DISTINCTIVE`	Заполните характеристики, которыми отличаются друг от друга варианты товара.

Type	Description
OfferCardRecommendationType	Enum: `HAS_VIDEO`, `RECOGNIZED_VENDOR`, `MAIN`, `ADDITIONAL`, `DISTINCTIVE`, `FILTERABLE`, `PICTURE_COUNT`, `HAS_DESCRIPTION`, `HAS_BARCODE`, `FIRST_PICTURE_SIZE`

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[]	Список ошибок. Общий формат ошибки.

Получение информации о заполненности карточек

RequestRequest

Path parametersPath parameters

Query parametersQuery parameters

BodyBody

OfferCardStatusTypeOfferCardStatusType

ResponsesResponses

200 OK200 OK

BodyBody

ApiResponseStatusTypeApiResponseStatusType

OfferCardsContentStatusDTOOfferCardsContentStatusDTO

OfferCardDTOOfferCardDTO

ForwardScrollingPagerDTOForwardScrollingPagerDTO

GetMappingDTOGetMappingDTO

OfferCardRecommendationDTOOfferCardRecommendationDTO

OfferErrorDTOOfferErrorDTO

OfferCardRecommendationTypeOfferCardRecommendationType

400 Bad Request400 Bad Request

BodyBody

ApiErrorDTOApiErrorDTO

401 Unauthorized401 Unauthorized

BodyBody

403 Forbidden403 Forbidden

BodyBody

404 Not Found404 Not Found

BodyBody

420 Method Failure420 Method Failure

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

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

Request

Path parameters

Query parameters

Body

OfferCardStatusType

Responses

200 OK

Body

ApiResponseStatusType

OfferCardsContentStatusDTO

OfferCardDTO

ForwardScrollingPagerDTO

GetMappingDTO

OfferCardRecommendationDTO

OfferErrorDTO

OfferCardRecommendationType

400 Bad Request

Body

ApiErrorDTO

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

420 Method Failure

Body

500 Internal Server Error

Body