Предварительный просмотр карточек на Маркете, соответствующих вашим товарам

Возвращает идентификаторы карточек на Маркете, которые соответствуют товарам с заданными параметрами.

Пользоваться этим запросом необязательно: он просто помогает заранее убедиться, что Маркет верно определяет карточке по предоставленным вами данным.

Как пользоваться запросом

  1. Передайте Маркету список товаров, которые нужно проверить.
  2. В ответ вы получите список SKU на Маркете с расшифровкой: названием, идентификатором модели, категорией.
  3. Если расшифровки мало, вы можете открыть карточку. Для этого перейдите по ссылке вида https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
  4. Если карточка соответствует товару, значит его можно добавлять в каталог с теми данными, что вы указали. Если карточка определилась неправильно — проверьте данные о товаре. Возможно, их нужно уточнить или дополнить. Кроме того, на этапе добавления товара вы можете указать marketSKU, который ему подходит по вашему мнению.

𝓠 Как определить marketSku товара, найденного на Маркете?

𝓐 Он есть в адресе страницы товара — расположен после sku=.

Например, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016

⚙️ Лимит: 100 000 товаров в час, не более 500 товаров в одном запросе

Request

POST

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

Path parameters

Name

Type

Description

businessId*

integer<int64>

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

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

Body

application/json
{
    "offers": [
        {
            "offerId": "string",
            "name": "Ударная дрель Makita HP1630, 710 Вт",
            "category": "string",
            "vendor": "LEVENHUK",
            "barcodes": [
                46012300000000
            ],
            "description": "string",
            "vendorCode": "VNDR-0005A",
            "basicPrice": {
                "value": 0,
                "currencyId": "RUR"
            }
        }
    ]
}

Name

Type

Description

offers

SuggestedOfferDTO[]

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

SuggestedOfferDTO

Информация о товаре.

Name

Type

Description

offerId

string

Ваш SKU — идентификатор товара в вашей системе.

Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы . , / \ ( ) [ ] - = _

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать


Min length: 1
Max length: 80

name

string

Составляйте название по схеме: тип + бренд или производитель + модель + особенности, если есть (например, цвет, размер или вес) и количество в упаковке.

Не включайте в название условия продажи (например, «скидка», «бесплатная доставка» и т. д.), эмоциональные характеристики («хит», «супер» и т. д.). Не пишите слова большими буквами — кроме устоявшихся названий брендов и моделей.

Оптимальная длина — 50–60 символов, максимальная — 256.

Рекомендации и правила


Example: Ударная дрель Makita HP1630, 710 Вт
Max length: 256

category

string

Категория товара в вашем магазине. Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

Указывайте конкретные категории — например, набор ножей лучше отнести к категории Столовые приборы, а не просто Посуда.

Выбирайте категории, которые описывают товар, а не абстрактный признак — например, Духи, а не Подарки.

Значение будет использовано для определения категории товара на Маркете в случае, если вы не передали категорию в параметре marketCategoryId.

vendor

string

Название бренда или производителя. Должно быть записано так, как его пишет сам бренд.
Example: LEVENHUK

barcodes

string[]

Указывайте в виде последовательности цифр. Подойдут коды EAN-13, EAN-8, UPC-A, UPC-E или Code 128.

Для книг указывайте ISBN.

Для товаров определенных категорий и торговых марок штрихкод должен быть действительным кодом GTIN. Обратите внимание: внутренние штрихкоды, начинающиеся на 2 или 02, и коды формата Code 128 не являются GTIN.

Что такое GTIN


Example: 46012300000000

description

string

Подробное описание товара: например, его преимущества и особенности.

Не давайте в описании инструкций по установке и сборке. Не используйте слова «скидка», «распродажа», «дешевый», «подарок» (кроме подарочных категорий), «бесплатно», «акция», «специальная цена», «новинка», «new», «аналог», «заказ», «хит». Не указывайте никакой контактной информации и не давайте ссылок.

Можно использовать теги:

  • <h>, <h1>, <h2> и так далее — для заголовков;
  • <br> и <p> — для переноса строки;
  • <ol> — для нумерованного списка;
  • <ul> — для маркированного списка;
  • <li> — для создания элементов списка (должен находиться внутри <ol> или <ul>);
  • <div> — поддерживается, но не влияет на отображение текста.

Оптимальная длина — 400–600 символов, максимальная — 6000.

Рекомендации и правила


Max length: 6000

vendorCode

string

Артикул товара от производителя.
Example: VNDR-0005A

basicPrice

BasePriceDTO

Цена товара

BasePriceDTO

Цена на товар.

Name

Type

Description

value*

number

Значение.

currencyId*

CurrencyType

Валюта.

Если BasePriceDTO присутствует в запросе, указывайте RUR — российский рубль.


Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

CurrencyType

Коды валют. Возможные значения:

  • BYR — белорусский рубль.
  • KZT — казахстанский тенге.
  • RUR — российский рубль.
  • UAH — украинская гривна.

Type

Description

CurrencyType

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

Responses

200 OK

Подобранные карточки на Маркете.

По результатам проверки товара полученная через этот запрос карточка может быть заменена на другую.

Body

application/json
{
    "status": "OK",
    "result": {
        "offers": [
            {
                "offer": {
                    "offerId": "string",
                    "name": "Ударная дрель Makita HP1630, 710 Вт",
                    "category": "string",
                    "vendor": "LEVENHUK",
                    "barcodes": [
                        46012300000000
                    ],
                    "description": "string",
                    "vendorCode": "VNDR-0005A",
                    "basicPrice": {
                        "value": 0,
                        "currencyId": "RUR"
                    }
                },
                "mapping": {
                    "marketSku": 0,
                    "marketSkuName": "string",
                    "marketModelId": 0,
                    "marketModelName": "string",
                    "marketCategoryId": 0,
                    "marketCategoryName": "string"
                }
            }
        ]
    }
}

Name

Type

Description

status

ApiResponseStatusType

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

result

GetSuggestedOfferMappingsResultDTO

Подобранные карточки на Маркете.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetSuggestedOfferMappingsResultDTO

Подобранные карточки на Маркете.

Name

Type

Description

offers

SuggestedOfferMappingDTO[]

Список товаров.
Товар с соответствующей карточкой на Маркете.

SuggestedOfferMappingDTO

Товар с соответствующей карточкой на Маркете.

Name

Type

Description

offer

SuggestedOfferDTO

Информация о товаре.

mapping

GetMappingDTO

Информация о карточке на Маркете.
Идентификатор карточки на Маркете. Показывает текущую привязку товара к карточке.

Может отсутствовать в ответе, если товар еще не привязан к карточке. Проверьте статус карточки или исправьте ошибки.

GetMappingDTO

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

Name

Type

Description

marketSku

integer<int64>

Идентификатор карточки на Маркете.

marketSkuName

string

Название карточки товара.

Может отсутствовать в ответе, если товар еще не привязан к карточке.

marketModelId

integer<int64>

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

Может отсутствовать в ответе, если товар еще не привязан к карточке.

marketModelName

string

Название модели на Маркете.

Может отсутствовать в ответе, если товар еще не привязан к карточке.

marketCategoryId

integer<int64>

Идентификатор категории карточки на Маркете.

Может отсутствовать в ответе, если Маркет еще не определил категорию товара.

marketCategoryName

string

Название категории карточки на Маркете.

Может отсутствовать в ответе, если Маркет еще не определил категорию товара.

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[]

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