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.
To get the categorical characteristics of the products, use the method POST v2/businesses/{businessId}/offer-cards.
| ⚙️ 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 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: Language:
Enum: |
|
limit |
Type: integer 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 Example: |
Body
application/json
{
"offerIds": [
"example"
],
"cardStatuses": [
"HAS_CARD_CAN_NOT_UPDATE"
],
"categoryIds": [
0
],
"vendorNames": [
"example"
],
"tags": [
"example"
],
"archived": true
}
|
Name |
Description |
|
archived |
Type: boolean Filter by location in the archive. Pass it on |
|
cardStatuses |
Type: string[] | null Filter by card status. Min items: Unique items: Example
|
|
categoryIds |
Type: integer[] | null Filter by category on the Market. Min items: Unique items: Example
|
|
offerIds |
Type: string[] | null 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:
Min items: Max items: Unique items: Example
|
|
tags |
Type: string[] | null Filter by tags. Min items: Unique items: Example
|
|
vendorNames |
Type: string[] | null Filter by brand. Min items: Unique items: Example
|
Responses
200 OK
Information about the products in the catalog.
Body
application/json
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "example",
"prevPageToken": "example"
},
"offerMappings": [
{
"offer": {},
"mapping": {},
"showcaseUrls": [
null
]
}
]
}
}
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,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
result
Type: object
offerMappings
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:
1A 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:
examplemarketModelName
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:
examplemarketSkuName
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:
exampleExample
{ "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
All of 2 types
-
Type: object
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:
1Max length:
255Pattern:
^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$Example:
exampleadult
Type: boolean
The parameter includes the label 18+ for the product. Set it only for products that are related to satisfying sexual needs.
age
Type: object
ageUnit
Type: string
Age measurement units:
YEAR— year.MONTH— month.
Enum:
YEAR,MONTHvalue
Type: number
Meaning.
Min value:
0Age in the specified units of measurement.
Example
{ "value": 0, "ageUnit": "YEAR" }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:
1Unique items:
trueExample
[ "46012300000000" ]boxCount
Type: integer
The number of cargo spaces.
This parameter is used if the product consists of several boxes, packages, and so on. For example, the air conditioner takes up two seats — the external and internal units are in two boxes.
For products that occupy one place, do not pass this parameter.
Min value:
1category
Type: string
Instead, use
marketCategoryId.The product category in your store.
Example:
examplecertificates
Type: string[] | null
The numbers of the documents for the product: certificate, declaration of conformity, etc.
You can only transfer the document numbers, the scans of which are uploaded in the merchant's office by Instructions.
Min items:
1Unique items:
trueExample
[ "example" ]commodityCodes
Type: object[]
code
Type: string
Product code.
Example:
exampletype
Type: string
Type of product code:
CUSTOMS_COMMODITY_CODE— the product code in the unified Commodity Nomenclature of Foreign Economic Activity (HS) — 10 or 14 digits without spaces.IKPU_CODE— The identification code of products and services in Uzbekistan is 17 digits without spaces.
Do not send multiple codes of the same type.
Enum:
CUSTOMS_COMMODITY_CODE,IKPU_CODEProduct codes.
Min items:
1Example
[ { "code": "example", "type": "CUSTOMS_COMMODITY_CODE" } ]condition
Type: object
quality
Type: string
Product appearance:
PERFECT— ideal.EXCELLENT— excellent.GOOD— good.NOT_SPECIFIED— not selected.
Enum:
PERFECT,EXCELLENT,GOOD,NOT_SPECIFIEDreason
Type: string
Product description. Describe the defects in detail, how noticeable they are and where to look for them.
Example:
exampletype
Type: string
Markdown type:
PREOWNED— used goods that used to belong to another person.SHOWCASESAMPLE— showcase sample.REFURBISHED— re-sale of the product.REDUCTION— the product is defective.RENOVATED— the restored product.NOT_SPECIFIED— not selected.
REFURBISHED— special significance for clothing, shoes, and accessories. It is used only for discounted products from this category. Other values for clothing, shoes, and accessories are not used.Enum:
PREOWNED,SHOWCASESAMPLE,REFURBISHED,REDUCTION,RENOVATED,NOT_SPECIFIEDThe condition of the discounted product.
Example
{ "type": "PREOWNED", "quality": "PERFECT", "reason": "example" }customsCommodityCode
Type: string
Instead, use
commodityCodeswith the typeCUSTOMS_COMMODITY_CODE.The product code in the unified Commodity Nomenclature of Foreign Economic Activity (HS) — 10 or 14 digits without spaces.
Be sure to indicate if there is one.
Example:
8517610008description
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.
Example:
exampledownloadable
Type: boolean
A sign of a digital product. Specify
trueif the product is delivered by e-mail.guaranteePeriod
Type: object
timePeriod
Type: integer
Duration in the specified units.
timeUnit
Type: string
Time measurement unit:
HOUR— hour.DAY— day.WEEK— a week.MONTH— month.YEAR— year.
Enum:
HOUR,DAY,WEEK,MONTH,YEARcomment
Type: string
Comment.
Max length:
500Example:
exampleA time period with a comment. The requirements for the comment content depend on the context of the parameter usage and are specified in the description of the field that contains it.
Example
{ "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }lifeTime
Type: object
timePeriod
Type: integer
Duration in the specified units.
timeUnit
Type: string
Time measurement unit:
HOUR— hour.DAY— day.WEEK— a week.MONTH— month.YEAR— year.
Enum:
HOUR,DAY,WEEK,MONTH,YEARcomment
Type: string
Comment.
Max length:
500Example:
exampleA time period with a comment. The requirements for the comment content depend on the context of the parameter usage and are specified in the description of the field that contains it.
Example
{ "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }manuals
Type: object[]
url
Type: string
Min length:
1Max length:
2000Example:
exampletitle
Type: string
The name of the instruction that will be displayed on the product card.
Max length:
500Example:
exampleA list of instructions on how to use the product.
Min items:
1Example
[ { "url": "example", "title": "example" } ]manufacturerCountries
Type: string[] | null
The country where the product was produced.
Write down the names of the countries as they are written in the list.
Min items:
1Unique items:
trueExample
[ "Россия" ]marketCategoryId
Type: integer
The ID of the category on the Market to which you attribute your product.
Always indicate when you transmit
parameterValuesIf, when changing the characteristics, you pass
parameterValuesand don't specifymarketCategoryId, the characteristics will be updated, but you will receive a warning in the response (parameterwarnings).If you do not pass both of them, information from outdated parameters will be used.
paramsandcategory, andmarketCategoryIdit will be detected automatically.When changing the category, make sure that the product characteristics and their values in the parameter
parameterValuesyou are submitting for a new category.You can get a list of Market categories using a request. POST v2/categories/tree.
Min value:
0Exclusive min:
truename
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.
Example:
Ударная дрель Makita HP1630, 710 Втparams
Type: object[]
name
Type: string
The name of the characteristic.
It must match the name of the feature on the Market. You can find it from the category's Excel template or through a query. POST v2/category/{categoryId}/parameters.
Max length:
200Example:
Wi-Fivalue
Type: string
Meaning.
Example:
естьWhen transmitting characteristics, use
parameterValues.Characteristics that only products of a specific category have. — for example, the diameter of the bicycle wheels or the material of the shoe sole.
Min items:
1Example
[ { "name": "Wi-Fi", "value": "есть" } ]pictures
Type: string[] | null
Links to product images. The image on the first link is considered the main one, the others are additional.
Link Requirements
- There can be up to 30 links.
- Specify the entire link, including the http or https protocol.
- Maximum length — 512 characters.
- Russian letters in URL may.
- You can use direct links to images and to Yandex.Disk. Links on Yandex.Disk must be copied using the function Share. Relative links and links to other cloud storage — They don't work.
✅
https://example-shop.ru/images/sku12345.jpg✅
https://yadi.sk/i/NaBoRsimVOLov❌
/images/sku12345.jpg❌
https://www.dropbox.com/s/818f/tovar.jpgLinks to the image must be permanent. You cannot use dynamic links that change from upload to upload.
If you need to replace the image, upload the new image via a new link, and delete the link to the old one. If you simply replace the image using the old link, it will not update.
Min items:
1Example
[ "example" ]shelfLife
Type: object
timePeriod
Type: integer
Duration in the specified units.
timeUnit
Type: string
Time measurement unit:
HOUR— hour.DAY— day.WEEK— a week.MONTH— month.YEAR— year.
Enum:
HOUR,DAY,WEEK,MONTH,YEARcomment
Type: string
Comment.
Max length:
500Example:
exampleA time period with a comment. The requirements for the comment content depend on the context of the parameter usage and are specified in the description of the field that contains it.
Example
{ "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }tags
Type: string[] | null
Product labels that the store uses. The tags are not visible to customers. You can group and filter different products in the catalog by tags. — for example, products of the same series, collection, or line.
Maximum tag length — 20 characters. One product can have a maximum of 10 tags.
Min items:
1Max items:
50Unique items:
trueExample
[ "до 500 рублей" ]type
Type: string
Special type of product:
DEFAULT— products for which you previously provided a special type and want to remove it.MEDICINE— medicines.BOOK— paper and electronic books.AUDIOBOOK— audiobooks.ARTIST_TITLE— music and video production.ON_DEMAND— custom-made products.ALCOHOL— alcohol.
If your product is — book
Specify the year of publication in the product specifications. More information about the parameter
Enum:
DEFAULT,MEDICINE,BOOK,AUDIOBOOK,ARTIST_TITLE,ON_DEMAND,ALCOHOLvendor
Type: string
The name of the brand or manufacturer. It should be written the way the brand itself writes it.
Example:
LEVENHUKvendorCode
Type: string
The article of the product from the manufacturer.
Example:
VNDR-0005Avideos
Type: string[] | null
Links (URL) on the product video.
Link Requirements
- Specify the entire link, including the http or https protocol.
- Maximum length — 512 characters.
- Russian letters in URL may.
- You can use direct links to videos and to Yandex.Disk. Links on Yandex.Disk must be copied using the function Share. Relative links and links to other cloud storage — They don't work.
✅
https://example-shop.ru/video/sku12345.avi✅
https://yadi.sk/i/NaBoRsimVOLov❌
/video/sku12345.avi❌
https://www.dropbox.com/s/818f/super-tovar.aviLinks to videos must be permanent. You cannot use dynamic links that change from upload to upload.
If you need to replace the video, upload the new video via a new link, and delete the link to the old one. If you simply replace the video using the old link, it will not update.
Min items:
1Example
[ "example" ]weightDimensions
Type: object
height
Type: number
Package height in cm.
Min value:
0length
Type: number
Package length in cm.
Min value:
0weight
Type: number
The weight of the product in kg, including packaging (gross).
Min value:
0width
Type: number
Package width in cm.
Min value:
0The dimensions of the package and the weight of the product.
If the product takes up several boxes, fold them compactly before measuring the dimensions.

Example
{ "length": 65.55, "width": 50.7, "height": 20, "weight": 1.001 }The main parameters of the product.
Example
{ "offerId": "example", "name": "Ударная дрель Makita HP1630, 710 Вт", "marketCategoryId": 0, "category": "example", "pictures": [ "example" ], "videos": [ "example" ], "manuals": [ { "url": "example", "title": "example" } ], "vendor": "LEVENHUK", "barcodes": [ "46012300000000" ], "description": "example", "manufacturerCountries": [ "Россия" ], "weightDimensions": { "length": 65.55, "width": 50.7, "height": 20, "weight": 1.001 }, "vendorCode": "VNDR-0005A", "tags": [ "до 500 рублей" ], "shelfLife": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "lifeTime": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "guaranteePeriod": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "customsCommodityCode": "8517610008", "commodityCodes": [ { "code": "example", "type": "CUSTOMS_COMMODITY_CODE" } ], "certificates": [ "example" ], "boxCount": 1, "condition": { "type": "PREOWNED", "quality": "PERFECT", "reason": "example" }, "type": "DEFAULT", "downloadable": true, "adult": true, "age": { "value": 0, "ageUnit": "YEAR" }, "params": [ { "name": "Wi-Fi", "value": "есть" } ] } -
-
Type: object
additionalExpenses
Type: object
All of 2 types
-
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,UEvalue
Type: number
The price of the product.
Min value:
0Exclusive min:
trueThe price of the product.
Example
{ "value": 0, "currencyId": "RUR" } -
Type: object
updatedAt
Type: string<date-time>
The time of the last update.
Example:
2025-01-01T00:00:00ZThe time of the last update.
Example
{ "updatedAt": "2025-01-01T00:00:00Z" }
Price indicating the time of the last update.
Example
{ "value": 0, "currencyId": "RUR", "updatedAt": "2025-01-01T00:00:00Z" }archived
Type: boolean
The product has been archived.
basicPrice
Type: object
All of 2 types
-
Type: object
All of 2 types
-
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,UEvalue
Type: number
The price of the product.
Min value:
0Exclusive min:
trueThe price of the product.
Example
{ "value": 0, "currencyId": "RUR" } -
Type: object
discountBase
Type: number
The crossed-out price.
The number must be an integer. You can specify a price with a discount from 5 to 99%.
Pass this parameter every time the price is updated if you provide a discount on the product.
Min value:
0Exclusive min:
trueExample
{ "discountBase": 0 }
Price with discount indication.
Example
{ "value": 0, "currencyId": "RUR", "discountBase": 0 } -
-
Type: object
updatedAt
Type: string<date-time>
The time of the last update.
Example:
2025-01-01T00:00:00ZThe time of the last update.
Example
{ "updatedAt": "2025-01-01T00:00:00Z" }
The price includes the currency, discount, and the time of the last update.
Example
{ "value": 0, "currencyId": "RUR", "discountBase": 0, "updatedAt": "2025-01-01T00:00:00Z" }campaigns
Type: object[]
campaignId
Type: integer
The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.
You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. Click on your account icon → Settings and in the menu on the left, select APIs and modules:
- block Campaign ID;
- tab Query log → drop-down list in the block Show logs.
⚠️ Do not confuse it with:
- the store's identifier, which is displayed in the merchant's personal account.
- advertising campaigns.
Min value:
1status
Type: string
Product status:
PUBLISHED— Ready for sale.CHECKING— Under review.DISABLED_BY_PARTNER— Hidden by you.REJECTED_BY_MARKET— Rejected.DISABLED_AUTOMATICALLY— Fix the errors.CREATING_CARD— A card is being created.NO_CARD— I need a card.NO_STOCKS— Not in stock.ARCHIVED— In the archive.
What does each of the statuses mean?
Enum:
PUBLISHED,CHECKING,DISABLED_BY_PARTNER,DISABLED_AUTOMATICALLY,REJECTED_BY_MARKET,CREATING_CARD,NO_CARD,NO_STOCKS,ARCHIVEDThe list of stores where the product is placed.
Min items:
1Example
[ { "campaignId": 1, "status": "PUBLISHED" } ]cardStatus
Type: string
Product card status:
HAS_CARD_CAN_NOT_UPDATE— The Market card.HAS_CARD_CAN_UPDATE— You can add it.HAS_CARD_CAN_UPDATE_ERRORS— The changes have not been accepted.HAS_CARD_CAN_UPDATE_PROCESSING— Changes are under review.NO_CARD_NEED_CONTENT— Create a card.NO_CARD_MARKET_WILL_CREATE— Creates a Marketplace.NO_CARD_ERRORS— It was not created due to an error.NO_CARD_PROCESSING— We check the data.NO_CARD_ADD_TO_CAMPAIGN— Place the product in the store.
Enum:
HAS_CARD_CAN_NOT_UPDATE,HAS_CARD_CAN_UPDATE,HAS_CARD_CAN_UPDATE_ERRORS,HAS_CARD_CAN_UPDATE_PROCESSING,NO_CARD_NEED_CONTENT,NO_CARD_MARKET_WILL_CREATE,NO_CARD_ERRORS,NO_CARD_PROCESSING,NO_CARD_ADD_TO_CAMPAIGNgroupId
Type: string
The identifier of the product group.
Products that are grouped together will have the same identifier.
How to combine products on a card
Example:
examplemediaFiles
Type: object
firstVideoAsCover
Type: boolean
Use the first video in the card as a video background.
Pass it on
truefor the first video to be used as a video background, orfalseso that the video background is not displayed in the product profile.manuals
Type: object[]
title
Type: string
The name of the media file.
Example:
exampleuploadState
Type: string
Media file download status:
UPLOADING— It's loading.UPLOADED— uploaded successfully.FAILED— an error occurred during the download. Please try again later.
Enum:
UPLOADING,UPLOADED,FAILEDurl
Type: string
Min length:
1Max length:
2000Example:
exampleProduct usage guidelines.
Min items:
1Example
[ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ]pictures
Type: object[]
title
Type: string
The name of the media file.
Example:
exampleuploadState
Type: string
Media file download status:
UPLOADING— It's loading.UPLOADED— uploaded successfully.FAILED— an error occurred during the download. Please try again later.
Enum:
UPLOADING,UPLOADED,FAILEDurl
Type: string
Min length:
1Max length:
2000Example:
exampleProduct images.
Min items:
1Example
[ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ]videos
Type: object[]
title
Type: string
The name of the media file.
Example:
exampleuploadState
Type: string
Media file download status:
UPLOADING— It's loading.UPLOADED— uploaded successfully.FAILED— an error occurred during the download. Please try again later.
Enum:
UPLOADING,UPLOADED,FAILEDurl
Type: string
Min length:
1Max length:
2000Example:
exampleVideo files of the product.
Min items:
1Example
[ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ]Information about the product's media files.
Example
{ "firstVideoAsCover": true, "videos": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ], "pictures": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ], "manuals": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ] }purchasePrice
Type: object
All of 2 types
-
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,UEvalue
Type: number
The price of the product.
Min value:
0Exclusive min:
trueThe price of the product.
Example
{ "value": 0, "currencyId": "RUR" } -
Type: object
updatedAt
Type: string<date-time>
The time of the last update.
Example:
2025-01-01T00:00:00ZThe time of the last update.
Example
{ "updatedAt": "2025-01-01T00:00:00Z" }
Price indicating the time of the last update.
Example
{ "value": 0, "currencyId": "RUR", "updatedAt": "2025-01-01T00:00:00Z" }sellingPrograms
Type: object[]
sellingProgram
Type: string
Working model:
FBY— FBY.FBS— FBS.DBS— DBS.EXPRESS— Express.
Enum:
FBY,FBS,DBS,EXPRESS,LAASstatus
Type: string
Information about availability or unavailability.
FINE— available.REJECT— unavailable.
Enum:
FINE,REJECTInformation about which placement models are available for the product.
Min items:
1Example
[ { "sellingProgram": "FBY", "status": "FINE" } ]Example
{ "basicPrice": { "value": 0, "currencyId": "RUR", "discountBase": 0, "updatedAt": "2025-01-01T00:00:00Z" }, "purchasePrice": { "value": 0, "currencyId": "RUR", "updatedAt": "2025-01-01T00:00:00Z" }, "additionalExpenses": { "value": 0, "currencyId": "RUR", "updatedAt": "2025-01-01T00:00:00Z" }, "cardStatus": "HAS_CARD_CAN_NOT_UPDATE", "campaigns": [ { "campaignId": 1, "status": "PUBLISHED" } ], "sellingPrograms": [ { "sellingProgram": "FBY", "status": "FINE" } ], "mediaFiles": { "firstVideoAsCover": true, "videos": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ], "pictures": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ], "manuals": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ] }, "archived": true, "groupId": "example" } -
Product parameters.
Example
{ "offerId": "example", "name": "Ударная дрель Makita HP1630, 710 Вт", "marketCategoryId": 0, "category": "example", "pictures": [ "example" ], "videos": [ "example" ], "manuals": [ { "url": "example", "title": "example" } ], "vendor": "LEVENHUK", "barcodes": [ "46012300000000" ], "description": "example", "manufacturerCountries": [ "Россия" ], "weightDimensions": { "length": 65.55, "width": 50.7, "height": 20, "weight": 1.001 }, "vendorCode": "VNDR-0005A", "tags": [ "до 500 рублей" ], "shelfLife": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "lifeTime": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "guaranteePeriod": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "customsCommodityCode": "8517610008", "commodityCodes": [ { "code": "example", "type": "CUSTOMS_COMMODITY_CODE" } ], "certificates": [ "example" ], "boxCount": 1, "condition": { "type": "PREOWNED", "quality": "PERFECT", "reason": "example" }, "type": "DEFAULT", "downloadable": true, "adult": true, "age": { "value": 0, "ageUnit": "YEAR" }, "params": [ { "name": "Wi-Fi", "value": "есть" } ], "basicPrice": { "value": 0, "currencyId": "RUR", "discountBase": 0, "updatedAt": "2025-01-01T00:00:00Z" }, "purchasePrice": { "value": 0, "currencyId": "RUR", "updatedAt": "2025-01-01T00:00:00Z" }, "additionalExpenses": { "value": 0, "currencyId": "RUR", "updatedAt": "2025-01-01T00:00:00Z" }, "cardStatus": "HAS_CARD_CAN_NOT_UPDATE", "campaigns": [ { "campaignId": 1, "status": "PUBLISHED" } ], "sellingPrograms": [ { "sellingProgram": "FBY", "status": "FINE" } ], "mediaFiles": { "firstVideoAsCover": true, "videos": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ], "pictures": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ], "manuals": [ { "url": "example", "title": "example", "uploadState": "UPLOADING" } ] }, "archived": true, "groupId": "example" }showcaseUrls
Type: object[]
showcaseType
Type: string
Showcase Type:
B2B— Yandex Market for Business (products for legal entities and sole proprietors). Read more about the service in Help.B2C— the main showcase of the Market (goods for individuals).
Enum:
B2B,B2CshowcaseUrl
Type: string
Product link.
Example:
exampleLinks to the same product on different storefronts of the Market.
Min items:
1Example
[ { "showcaseType": "B2B", "showcaseUrl": "example" } ]Information about the products.
Example
[ { "offer": { "offerId": "example", "name": "Ударная дрель Makita HP1630, 710 Вт", "marketCategoryId": 0, "category": "example", "pictures": [ "example" ], "videos": [ "example" ], "manuals": [ {} ], "vendor": "LEVENHUK", "barcodes": [ "46012300000000" ], "description": "example", "manufacturerCountries": [ "Россия" ], "weightDimensions": { "length": 65.55, "width": 50.7, "height": 20, "weight": 1.001 }, "vendorCode": "VNDR-0005A", "tags": [ "до 500 рублей" ], "shelfLife": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "lifeTime": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "guaranteePeriod": { "timePeriod": 0, "timeUnit": "HOUR", "comment": "example" }, "customsCommodityCode": "8517610008", "commodityCodes": [ {} ], "certificates": [ "example" ], "boxCount": 1, "condition": { "type": "PREOWNED", "quality": "PERFECT", "reason": "example" }, "type": "DEFAULT", "downloadable": true, "adult": true, "age": { "value": 0, "ageUnit": "YEAR" }, "params": [ {} ], "basicPrice": {}, "purchasePrice": {}, "additionalExpenses": {}, "cardStatus": "HAS_CARD_CAN_NOT_UPDATE", "campaigns": [ {} ], "sellingPrograms": [ {} ], "mediaFiles": { "firstVideoAsCover": true, "videos": [ null ], "pictures": [ null ], "manuals": [ null ] }, "archived": true, "groupId": "example" }, "mapping": { "marketSku": 1, "marketSkuName": "example", "marketModelName": "example", "marketCategoryId": 0, "marketCategoryName": "example" }, "showcaseUrls": [ { "showcaseType": "B2B", "showcaseUrl": "example" } ] } ]paging
Type: object
All of 2 types
-
Type: object
nextPageToken
Type: string
ID of the next results page.
Example:
exampleThe ID of the next page.
Example
{ "nextPageToken": "example" } -
Type: object
prevPageToken
Type: string
ID of the previous results page.
Example:
exampleExample
{ "prevPageToken": "example" }
Information about the result pages.
Example
{ "nextPageToken": "example", "prevPageToken": "example" }Information about the products.
Example
{ "paging": { "nextPageToken": "example", "prevPageToken": "example" }, "offerMappings": [ { "offer": { "offerId": "example", "name": "Ударная дрель Makita HP1630, 710 Вт", "marketCategoryId": 0, "category": "example", "pictures": [ null ], "videos": [ null ], "manuals": [ null ], "vendor": "LEVENHUK", "barcodes": [ null ], "description": "example", "manufacturerCountries": [ null ], "weightDimensions": {}, "vendorCode": "VNDR-0005A", "tags": [ null ], "shelfLife": {}, "lifeTime": {}, "guaranteePeriod": {}, "customsCommodityCode": "8517610008", "commodityCodes": [ null ], "certificates": [ null ], "boxCount": 1, "condition": {}, "type": "DEFAULT", "downloadable": true, "adult": true, "age": {}, "params": [ null ], "basicPrice": {}, "purchasePrice": {}, "additionalExpenses": {}, "cardStatus": "HAS_CARD_CAN_NOT_UPDATE", "campaigns": [ null ], "sellingPrograms": [ null ], "mediaFiles": {}, "archived": true, "groupId": "example" }, "mapping": { "marketSku": 1, "marketSkuName": "example", "marketModelName": "example", "marketCategoryId": 0, "marketCategoryName": "example" }, "showcaseUrls": [ { "showcaseType": "B2B", "showcaseUrl": "example" } ] } ] }Example
{ "result": { "paging": { "nextPageToken": "example", "prevPageToken": "example" }, "offerMappings": [ { "offer": {}, "mapping": {}, "showcaseUrls": [ {} ] } ] } } -
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,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "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,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "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,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "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,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "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,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "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,ERRORThe standard wrapper for server responses.
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
The error code.
Example:
examplemessage
Type: string
Description of the error.
Example:
exampleA list of errors.
Min items:
1Example
[ { "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.