Просмотр карточек на Маркете, которые подходят вашим товарам

Deprecated

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

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

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

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

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

  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 товаров в час

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

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

Description

offers

Type: SuggestedOfferDTO[]

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

Min items: 1

Max items: 500

SuggestedOfferDTO

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

Name

Description

barcodes

Type: string[]

Штрихкод.

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

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

Что такое GTIN

Example: 46012300000000

Min items: 1

Unique items  

basicPrice

Type: BasePriceDTO

Цена товара.

category

⦸

Type: string

Вместо него используйте marketCategoryId.

Категория товара в вашем магазине.

description

Type: string

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

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

Для форматирования текста можно использовать теги HTML:

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

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

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

Max length: 6000

name

Type: string

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

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

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

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

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

Max length: 256

offerId

Type: string

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

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

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

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

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

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

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

vendor

Type: string

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

Example: LEVENHUK

vendorCode

Type: string

Артикул товара от производителя.

Example: VNDR-0005A

BasePriceDTO

Цена товара.

Name

Description

currencyId*

Type: 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

value*

Type: number

Цена товара.

Min value (exclusive): 0

CurrencyType

Коды валют:

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

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

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: GetSuggestedOfferMappingsResultDTO

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

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetSuggestedOfferMappingsResultDTO

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

Name

Description

offers*

Type: SuggestedOfferMappingDTO[]

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

SuggestedOfferMappingDTO

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

Name

Description

mapping

Type: GetMappingDTO

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

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

offer

Type: SuggestedOfferDTO

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

GetMappingDTO

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

Name

Description

marketCategoryId

Type: integer<int64>

Идентификатор категории на Маркете, в которую попал товар.

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

marketCategoryName

Type: string

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

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

marketModelId

⦸

Type: integer<int64>

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

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

marketModelName

⦸

Type: string

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

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

marketSku

Type: integer<int64>

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

Min value: 1

marketSkuName

Type: string

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

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

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

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

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

No longer supported, please use an alternative and newer version.

Что такое GTIN
GTIN — это уникальный номер, присвоенный товару в единой международной базе GS1. Из этого номера получается штрихкод формата EAN, UPC или ISBN.

Как убедиться, что товар есть в базе
Проверить код можно на странице проверки на сайте ассоциации GS1. Если товар не находится, запросите код GTIN у вашего поставщика.

Как получить GTIN для своих товаров
Чтобы получить коды GTIN, производителю нужно вступить в ассоциацию GS1 и зарегистрировать товары.

Предыдущая
Рекомендованные карточки
Следующая
Список цен