View the cards on the Market that match your products
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
- Give the Market a list of products that need to be checked.
- In response, you will receive a list SKU 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
marketSKUwhich 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<int64> Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market?
Min value: |
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: object[] The list of products. Min items: Max items: |
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",
"marketModelName": "string",
"marketCategoryId": 0,
"marketCategoryName": "string"
}
}
]
}
}
|
Name |
Description |
||
|
status* |
Type: string The type of response. Possible values:
Enum: |
||
|
result |
Type: object
Selected cards on the Market. |
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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error of the Market. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
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.