View the cards on the Market that match your products

Deprecated

Info

Console

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

offers-and-cards-management — Manage products and cards
offers-and-cards-management:read-only — View products and cards
all-methods — Full account management
all-methods:read-only — View all data

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

Send the list of products that need to be checked to Yandex.Market.
In response, you will receive a list of SKUs on the Market with a description: name, model ID, category.
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>.
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/businesses/{businessId}/offer-mappings/suggestions

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

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

The list of products.
Product information.

Min items: 1

Max items: 500

SuggestedOfferDTO

Product information.

Name	Description
barcodes	Type: string[] Specify it as a sequence of numbers. Suitable codes are EAN-13, EAN-8, UPC-A, UPC-E or Code 128. For books, specify the ISBN. For products certain categories and brands The barcode must be a valid GTIN code. Please note: Internal barcodes starting with 2 or 02 and Code 128 format codes are not GTINs. What is GTIN? Example: `46012300000000` Min items: `1` Unique items
basicPrice	Type: BasePriceDTO The price of the product.
category ⦸	Type: string Instead, use `marketCategoryId`. The product category in your store.
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 headings; <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> is supported, but does not affect the text display. The optimal length is 400-600 characters. Recommendations and rules Max length: `6000`
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.). Do not write words in capital letters, except for the established names of brands and models. The optimal length is 50-60 characters. Recommendations and rules Example: `Impact drill Makita HP1630, 710 W` Max length: `256`
offerId	Type: string Your SKU is the product identifier in your system. SKU Usage Rules: Each product must have its own SKU. An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before. The SKU of 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. What is a SKU and how to assign it Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
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`

BasePriceDTO

The price of the product.

Name

Description

currencyId*

Type: CurrencyType

Currency.

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 (exclusive): 0

CurrencyType

Currency codes:

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

Type

Description

CurrencyType

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": {
                    "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

result

Selected cards on the Market.

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

GetSuggestedOfferMappingsResultDTO

Selected cards on the Market.

Name

Description

offers*

Type: SuggestedOfferMappingDTO[]

The list of products.
The product with the corresponding card is on the Market.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

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

SuggestedOfferMappingDTO

The product with the corresponding card is on the Market.

Name

Description

mapping

Type: GetMappingDTO

Information about the card on the Market.
The ID of the card on the Market. Shows the current product link to the card.

It may not be included in the response if the product is not linked to the card yet. Check the card's status or correct any errors.

offer

Type: SuggestedOfferDTO

Product information.

GetMappingDTO

Information about the products in the catalog.

Name

Description

marketCategoryId

Type: integer<int64>

ID of the category on the Market that the product belongs to.

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.

marketModelId

⦸

Type: integer<int64>

The ID of the model on the Market.

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

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.

marketSku

Type: integer<int64>

The ID of the card on the Market.

Min value: 1

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.

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Recommended cards

List of prices