View the cards on the Market that match your products

Deprecated

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

Returns the IDs of the cards on the Market that correspond to the products with the specified parameters.

You don't need to use this query: it just helps to make sure in advance that the Market correctly identifies the cards based on the data you provided.

How to use the request

  1. Send the list of products that need to be checked to Yandex.Market.
  2. In response, you will receive a list SKU on the Market with a description: name, model ID, category.
  3. If there is not enough decryption, you can open the card. To do this, follow the link in the form https://market.yandex.ru/product/<marketModelId>?sku=<marketSku>.
  4. If the card matches the product, then it can be added to the catalog with the data that you specified. If the card was identified incorrectly — check the product information. They may need to be clarified or supplemented. In addition, at the stage of adding the product, you can specify marketSKU which one suits him in your opinion.

How to determine marketSku a product found on the Market?

It is in the address of the product page. — located after sku=.

For example, https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016

⚙️ Limit: 100,000 products per hour

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

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

barcodes

Type: string[] | null

Barcode.

Specify it as a sequence of numbers. The codes will do EAN-13, EAN-8, UPC-A, UPC-E or Code 128. For books — ISBN.

For products certain categories and brands The barcode must be a valid code. GTIN. Please note: internal barcodes starting with 2 or 02, and format codes Code 128 They are not GTIN.

What is it GTIN

Min items: 1

Unique items: true

Example
[
  "46012300000000"
]

basicPrice
Type: object

currencyId

Type: string

Currency codes:

  • RUR — the Russian ruble.
  • UAH — the Ukrainian hryvnia.
  • BYR — the Belarusian ruble.
  • KZT — Kazakhstani tenge.
  • UZS — Uzbek sum.

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

The price of the product.

Min value: 0

Exclusive min: true

The price of the product.

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

category

Type: string

Instead, use marketCategoryId.

The product category in your store.

Example: example

description

Type: string

Detailed product description: for example, its advantages and features.

Do not provide installation and assembly instructions in the description. Do not use the words "discount", "sale", "cheap", "gift" (except gift categories), "free", "special offer", "special price", "novelty", "new", "analog", "order", "hit". Do not provide any contact information or links.

You can use HTML tags to format the text:

  • <h>, <h1>, <h2> and so on — for headlines;
  • <br> and <p> — for line breaks;
  • <ol> — for a numbered list;
  • <ul> — for a bulleted list.
  • <li> — to create list items (must be inside <ol> or <ul>);
  • <div> — It is supported, but it does not affect the text display.

Optimal length — 400-600 characters.

Recommendations and rules

Max length: 6000

Example: example

name

Type: string

Make up the name according to the scheme: type + brand or manufacturer + model + features, if any (for example, color, size or weight) and quantity in the package.

Do not include emotional characteristics ("hit", "super", etc.) in the name of the terms of sale (for example, "discount", "free shipping", etc.). Don't write words in capital letters. — except for well-established brand names and models.

Optimal length — 50-60 characters.

Recommendations and rules

Max length: 256

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

offerId

Type: string

Your SKU — the product ID in your system.

Usage rules SKU:

  • For each product SKU there must be one.

  • Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

Warning

Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

What is SKU and how to assign it

Min length: 1

Max length: 255

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

Example: example

vendor

Type: string

The name of the brand or manufacturer. It should be written the way the brand itself writes it.

Example: LEVENHUK

vendorCode

Type: string

The article of the product from the manufacturer.

Example: VNDR-0005A

The list of products.

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"
    }
  }
]

Responses

200 OK

Selected cards on the Market.

Based on the results of product verification, the card received through this request can be replaced with another one.

Body

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

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    The type of response. Possible values:

    • OK — There are no errors.
    • ERROR — an error occurred while processing the request.

    Enum: OK, ERROR

    The standard wrapper for server responses.

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

    result
    Type: object

    offers
    Type: object[]

    mapping

    Type: object

    All of 2 types

    • Type: object

      marketSku

      Type: integer

      The ID of the product card on the Market.

      Min value: 1

      A card on the Market that, from your point of view, fits the product. To determine the ID of the appropriate card, use the search in the cabinet (Products → Catalog → Upload products).

      Based on the verification results, the Market can link the product to a more suitable card.

      Example
      {
  "marketSku": 1
}

    • Type: object

      marketCategoryId

      Type: integer

      The ID of the category on the Market that the product is in.

      It may be missing from the response if the Market has not yet determined the product category.

      marketCategoryName

      Type: string

      The name of the card's category on the Market.

      It may be missing from the response if the Market has not yet determined the product category.

      Example: example

      marketModelName

      Type: string

      The name of the model on the Market.

      It may not be included in the response if the product is not linked to the card yet.

      Example: example

      marketSkuName

      Type: string

      The name of the product card.

      It may not be included in the response if the product is not linked to the card yet.

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

    Information about the products in the catalog.

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

    offer
    Type: object

    barcodes

    Type: string[] | null

    Barcode.

    Specify it as a sequence of numbers. The codes will do EAN-13, EAN-8, UPC-A, UPC-E or Code 128. For books — ISBN.

    For products certain categories and brands The barcode must be a valid code. GTIN. Please note: internal barcodes starting with 2 or 02, and format codes Code 128 They are not GTIN.

    What is it GTIN

    Min items: 1

    Unique items: true

    Example
    [
  "46012300000000"
]

    basicPrice
    Type: object

    currencyId

    Type: string

    Currency codes:

    • RUR — the Russian ruble.
    • UAH — the Ukrainian hryvnia.
    • BYR — the Belarusian ruble.
    • KZT — Kazakhstani tenge.
    • UZS — Uzbek sum.

    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

    The price of the product.

    Min value: 0

    Exclusive min: true

    The price of the product.

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

    category

    Type: string

    Instead, use marketCategoryId.

    The product category in your store.

    Example: example

    description

    Type: string

    Detailed product description: for example, its advantages and features.

    Do not provide installation and assembly instructions in the description. Do not use the words "discount", "sale", "cheap", "gift" (except gift categories), "free", "special offer", "special price", "novelty", "new", "analog", "order", "hit". Do not provide any contact information or links.

    You can use HTML tags to format the text:

    • <h>, <h1>, <h2> and so on — for headlines;
    • <br> and <p> — for line breaks;
    • <ol> — for a numbered list;
    • <ul> — for a bulleted list.
    • <li> — to create list items (must be inside <ol> or <ul>);
    • <div> — It is supported, but it does not affect the text display.

    Optimal length — 400-600 characters.

    Recommendations and rules

    Max length: 6000

    Example: example

    name

    Type: string

    Make up the name according to the scheme: type + brand or manufacturer + model + features, if any (for example, color, size or weight) and quantity in the package.

    Do not include emotional characteristics ("hit", "super", etc.) in the name of the terms of sale (for example, "discount", "free shipping", etc.). Don't write words in capital letters. — except for well-established brand names and models.

    Optimal length — 50-60 characters.

    Recommendations and rules

    Max length: 256

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

    offerId

    Type: string

    Your SKU — the product ID in your system.

    Usage rules SKU:

    • For each product SKU there must be one.

    • Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

    SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

    Warning

    Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

    What is SKU and how to assign it

    Min length: 1

    Max length: 255

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

    Example: example

    vendor

    Type: string

    The name of the brand or manufacturer. It should be written the way the brand itself writes it.

    Example: LEVENHUK

    vendorCode

    Type: string

    The article of the product from the manufacturer.

    Example: VNDR-0005A

    Product information.

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

    The list of products.

    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",
      "marketModelName": "example",
      "marketCategoryId": 0,
      "marketCategoryName": "example"
    }
  }
]

    Selected cards on the Market.

    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",
        "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": {}
      }
    ]
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

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

    A standard wrapper for server errors.

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

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

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

    A standard wrapper for server errors.

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

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

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

    A standard wrapper for server errors.

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

404 Not Found

The requested resource was not found. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

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

    A standard wrapper for server errors.

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

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

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

    A standard wrapper for server errors.

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

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

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

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

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

    A standard wrapper for server errors.

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

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

What is GTIN?
GTIN — This is a unique number assigned to a product in a single international database. GS1. This number generates an EAN, UPC, or ISBN barcode.

How to make sure that the product is in the database
You can check the code on verification page on the GS1 association's website. If the product is not found, request the GTIN code from your supplier.

How to get a GTIN for your products
To receive GTIN codes, the manufacturer needs to join the GS1 association and register the products.

Previous
Recommended cards
Next
List of prices