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

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

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

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

Min value: 1

Body

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

Name

Description

offers

Type: SuggestedOfferDTO[] | null

Список товаров.

Min items: 1

Max items: 500

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

ShopSku

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

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

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

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

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

Важно

Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.

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

Type: string

Min length: 1

Max length: 255

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

Example: example

OfferName

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

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

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

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

Type: string

Max length: 256

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

OfferCategory

Deprecated

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

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

Type: string

Example: example

OfferVendor

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

Type: string

Example: LEVENHUK

OfferBarcodes

Штрихкод.

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

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

Что такое GTIN

Type: string[] | null

Min items: 1

Unique items: true

Example
[
  "46012300000000"
]

OfferDescription

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

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

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

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

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

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

Type: string

Max length: 6000

Example: example

OfferVendorCode

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

Type: string

Example: VNDR-0005A

CurrencyType

Коды валют:

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

Type: string

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

BasePriceDTO

Цена товара.

Name

Description

currencyId

Type: CurrencyType

Валюта.

Коды валют:

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

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

Exclusive min: true

Example
{
  "value": 0,
  "currencyId": "RUR"
}

SuggestedOfferDTO

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

Name

Description

barcodes

Type: OfferBarcodes

Штрихкод.

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

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

Что такое GTIN

Min items: 1

Unique items: true

Example
[
  "46012300000000"
]

basicPrice

Type: BasePriceDTO

Цена товара.

Цена товара.

Example
{
  "value": 0,
  "currencyId": "RUR"
}

category

Type: OfferCategory

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

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

Example: example

description

Type: OfferDescription

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

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

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

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

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

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

Max length: 6000

Example: example

name

Type: OfferName

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

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

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

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

Max length: 256

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

offerId

Type: ShopSku

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

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

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

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

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

Важно

Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.

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

Min length: 1

Max length: 255

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

Example: example

vendor

Type: OfferVendor

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

Example: LEVENHUK

vendorCode

Type: OfferVendorCode

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

Example: VNDR-0005A

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

Responses

200 OK

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

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

Body

application/json
{
  "status": "OK",
  "result": {
    "offers": [
      {
        "offer": {},
        "mapping": {}
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: GetSuggestedOfferMappingsResultDTO

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

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

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example
{
  "status": "OK"
}

MarketSku

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

Type: integer

Min value: 1

UpdateMappingDTO

Карточка на Маркете, которая, с вашей точки зрения, подходит товару. Чтобы определить идентификатор подходящей карточки, воспользуйтесь поиском в кабинете (ТоварыКаталогЗагрузить товары).

По результатам проверки Маркет может привязать товар к более подходящей карточке.

Name

Description

marketSku

Type: MarketSku

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

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

Min value: 1

Example: 1

Example
{
  "marketSku": 1
}

GetMappingDTO

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

Type: object

All of 2 types
  • Type: UpdateMappingDTO

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

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

    Карточка на Маркете, которая, с вашей точки зрения, подходит товару. Чтобы определить идентификатор подходящей карточки, воспользуйтесь поиском в кабинете (ТоварыКаталогЗагрузить товары).

    По результатам проверки Маркет может привязать товар к более подходящей карточке.

    Example
    {
      "marketSku": 1
    }
    
  • Type: object

    marketCategoryId

    Type: integer

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

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

    marketCategoryName

    Type: string

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

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

    Example: example

    marketModelName

    Type: string

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

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

    Example: example

    marketSkuName

    Type: string

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

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

    Example: example

    Example
    {
      "marketSkuName": "example",
      "marketModelName": "example",
      "marketCategoryId": 0,
      "marketCategoryName": "example"
    }
    
Example
{
  "marketSku": 1,
  "marketSkuName": "example",
  "marketModelName": "example",
  "marketCategoryId": 0,
  "marketCategoryName": "example"
}

SuggestedOfferMappingDTO

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

Name

Description

mapping

Type: GetMappingDTO

Информация о карточке на Маркете.

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

Example
{
  "marketSku": 1,
  "marketSkuName": "example",
  "marketModelId": 0,
  "marketModelName": "example",
  "marketCategoryId": 0,
  "marketCategoryName": "example"
}

offer

Type: SuggestedOfferDTO

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

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

GetSuggestedOfferMappingsResultDTO

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

Name

Description

offers

Type: SuggestedOfferMappingDTO[]

Список товаров.

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

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example

Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types
  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

    Example
    [
      {
        "code": "example",
        "message": "example"
      }
    ]
    
    Example
    {
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    
Example
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

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

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

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

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