Information about the products in the catalog
The method is available for models: FBY, FBS, Express and DBS.
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 a list of products in the catalog, their categories on the Market, and the characteristics of each product.
It can be used in three ways:
- set a list of people of interest SKU;
- set a filter — in this case, the results are returned page by page.
- do not send the request body to get a list of all the products in the catalog.
| ⚙️ Limit: 600 requests per minute, no more than 200 products per request |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/offer-mappings
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: |
Query parameters
|
Name |
Description |
|
language |
Type: string The language in which the values in the parameters are accepted and returned Default value:
Enum: |
|
limit |
Type: integer<int32> The number of values per page.
Min value: |
|
page_token |
Type: string ID of the results page. If the parameter is omitted, the first page is returned. We recommend transmitting the value of the output parameter If set |
Body
application/json
{
"offerIds": [
"string"
],
"cardStatuses": [
"HAS_CARD_CAN_NOT_UPDATE"
],
"categoryIds": [
0
],
"vendorNames": [
"string"
],
"tags": [
"string"
],
"archived": false
}
|
Name |
Description |
|
archived |
Type: boolean Filter by location in the archive. Pass it on |
|
cardStatuses |
Type: string[] Filter by card status. What is a product card?
Enum: Min items: Unique items |
|
categoryIds |
Type: integer[] Filter by category on the Market. Min value (exclusive): Min items: Unique items |
|
offerIds |
Type: string[] The IDs of the products that information is needed about. This list is returned only in its entirety. If you are requesting information on specific SKU, do not fill in:
Usage rules SKU:
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, What is SKU and how to assign it Min length: Max length: Pattern: Min items: Max items: Unique items |
|
tags |
Type: string[] Filter by tags. Min items: Unique items |
|
vendorNames |
Type: string[] Filter by brand. Min items: Unique items |
Responses
200 OK
Information about the products in the catalog.
Body
application/json
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"offerMappings": [
{
"offer": {
"offerId": "string",
"name": "Ударная дрель Makita HP1630, 710 Вт",
"marketCategoryId": 0,
"category": "string",
"pictures": [
"string"
],
"videos": [
"string"
],
"manuals": [
{
"url": "string",
"title": "string"
}
],
"vendor": "LEVENHUK",
"barcodes": [
"46012300000000"
],
"description": "string",
"manufacturerCountries": [
"Россия"
],
"weightDimensions": {
"length": 65.55,
"width": 50.7,
"height": 20,
"weight": 1.001
},
"vendorCode": "VNDR-0005A",
"tags": [
"до 500 рублей"
],
"shelfLife": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "string"
},
"lifeTime": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "string"
},
"guaranteePeriod": {
"timePeriod": 0,
"timeUnit": "HOUR",
"comment": "string"
},
"customsCommodityCode": "8517610008",
"commodityCodes": [
{
"code": "string",
"type": "CUSTOMS_COMMODITY_CODE"
}
],
"certificates": [
"string"
],
"boxCount": 0,
"condition": {
"type": "PREOWNED",
"quality": "PERFECT",
"reason": "string"
},
"type": "DEFAULT",
"downloadable": false,
"adult": false,
"age": {
"value": 0,
"ageUnit": "YEAR"
},
"params": [
{
"name": "Wi-Fi",
"value": "есть"
}
],
"basicPrice": {
"value": 0,
"currencyId": "RUR",
"discountBase": 0,
"updatedAt": "2022-12-29T18:02:01Z"
},
"purchasePrice": {
"value": 0,
"currencyId": "RUR",
"updatedAt": "2022-12-29T18:02:01Z"
},
"additionalExpenses": {
"value": 0,
"currencyId": "RUR",
"updatedAt": "2022-12-29T18:02:01Z"
},
"cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
"campaigns": [
{
"campaignId": 0,
"status": "PUBLISHED"
}
],
"sellingPrograms": [
{
"sellingProgram": "FBY",
"status": "FINE"
}
],
"mediaFiles": {
"firstVideoAsCover": false,
"videos": [
{
"url": "string",
"title": "string",
"uploadState": "UPLOADING"
}
],
"pictures": [
{
"url": "string",
"title": "string",
"uploadState": "UPLOADING"
}
],
"manuals": [
{
"url": "string",
"title": "string",
"uploadState": "UPLOADING"
}
]
},
"archived": false,
"groupId": "string"
},
"mapping": {
"marketSku": 0,
"marketSkuName": "string",
"marketModelId": 0,
"marketModelName": "string",
"marketCategoryId": 0,
"marketCategoryName": "string"
},
"showcaseUrls": [
{
"showcaseType": "B2B",
"showcaseUrl": "string"
}
]
}
]
}
}
|
Name |
Description |
||||||||
|
status* |
Type: string The type of response. Possible values:
Enum: |
||||||||
|
result |
Type: object
Information about the products. |
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.