Information about the products in the catalog

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 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 SKUs of interest;
  • 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/businesses/{businessId}/offer-mappings

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

Query parameters

Name

Description

language

Type: CatalogLanguageType

The language in which the values in the parameters are accepted and returned name and description.

Default value: RU.

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

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 nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

CatalogLanguageType

Language:

  • RU — Russian.
  • UZ — Uzbek.

Type

Description

CatalogLanguageType

Enum: RU, UZ

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 true to receive the items in the archive. If the filter is not filled or passed false, the response returns items that are not in the archive.

cardStatuses

Type: OfferCardStatusType[]

Filter by card status.

What is a product card?
Product card status:

  • HAS_CARD_CAN_NOT_UPDATE — The Market card.
  • HAS_CARD_CAN_UPDATE — It can be supplemented.
  • 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 wasn't created because of a mistake.
  • 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_CAMPAIGN

Min items: 1

Unique items  

categoryIds

Type: integer[]

Filter by category on the Market.

Min items: 1

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 SKUs, do not fill in:

  • page_token;
  • limit;
  • cardStatuses;
  • categoryIds;
  • vendorNames;
  • tags;
  • archived.


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}$

Min items: 1

Max items: 200

Unique items  

tags

Type: string[]

Filter by tags.

Min items: 1

Unique items  

vendorNames

Type: string[]

Filter by brand.

Min items: 1

Unique items  

OfferCardStatusType

Product card status:

  • HAS_CARD_CAN_NOT_UPDATE — The Market card.
  • HAS_CARD_CAN_UPDATE — It can be supplemented.
  • 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 wasn't created because of a mistake.
  • NO_CARD_PROCESSING — We check the data.
  • NO_CARD_ADD_TO_CAMPAIGN — Place the product in the store.

Type

Description

OfferCardStatusType

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_CAMPAIGN

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
                },
                "mapping": {
                    "marketSku": 0,
                    "marketSkuName": "string",
                    "marketModelId": 0,
                    "marketModelName": "string",
                    "marketCategoryId": 0,
                    "marketCategoryName": "string"
                },
                "showcaseUrls": [
                    {
                        "showcaseType": "B2B",
                        "showcaseUrl": "string"
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: GetOfferMappingsResultDTO

Information about the products.

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

GetOfferMappingsResultDTO

Information about the products.

Name

Description

offerMappings*

Type: GetOfferMappingDTO[]

Information about the products.
Product information.

paging

Type: ScrollingPagerDTO

The ID of the next page.
The ID of the next page.

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

GetOfferMappingDTO

Product information.

Name

Description

mapping

Type: GetMappingDTO

Information about the product 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: GetOfferDTO

The main parameters of the product.
The main parameters of the product.

showcaseUrls

Type: ShowcaseUrlDTO[]

Links to the same product on different storefronts of the Market.
The link to the product in the showcase and its type.

Min items: 1

ScrollingPagerDTO

Information about the result pages.

Name

Description

nextPageToken

Type: string

ID of the next results page.

prevPageToken

Type: string

ID of the previous results page.

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.

GetOfferDTO

Product parameters.

Name

Description

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}$

additionalExpenses

Type: GetPriceDTO

Additional costs for the product. For example, for shipping or packaging.
The price of the product.
The time of the last update.

adult

Type: boolean

The parameter includes the 18+ label for the product. Set it only for products that are related to satisfying sexual needs.

age

Type: AgeDTO

If the product is not intended for children under a certain age, please indicate this.

The age limit can be set in years (from zero, from 6, 12, 16 or 18) or in months (any number from 0 to 12).

archived

Type: boolean

The product has been archived.

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: GetPriceWithDiscountDTO

Price.
Price with discount indication.
The time of the last update.

boxCount

Type: integer<int32>

The number of cargo spaces.

This parameter is used if the product consists of several boxes, packages, and so on. For example, an air conditioner takes up two spaces — an external and an internal unit in two boxes.

For products that occupy one place, do not pass this parameter.

Min value: 1

campaigns

Type: OfferCampaignStatusDTO[]

The list of stores where the product is placed.
The status of the product in the store.

Min items: 1

cardStatus

Type: OfferCardStatusType

Product card status:

  • HAS_CARD_CAN_NOT_UPDATE — The Market card.
  • HAS_CARD_CAN_UPDATE — It can be supplemented.
  • 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 wasn't created because of a mistake.
  • 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_CAMPAIGN

category

⦸

Type: string

Instead, use marketCategoryId.

The product category in your store.

certificates

Type: string[]

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: 1

Unique items  

commodityCodes

Type: CommodityCodeDTO[]

Product codes.
Product code.

Min items: 1

condition

Type: OfferConditionDTO

The condition of the discounted product.

It is only used for products sold at a markdown.

Rules for the sale of discounted goods

customsCommodityCode

⦸

Type: string

Instead, use commodityCodes with the type CUSTOMS_COMMODITY_CODE.

The product code in the unified Commodity Nomenclature of Foreign Economic Activity (HS) is 10 or 14 digits without spaces.

Be sure to indicate if there is one.

Example: 8517610008

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> — supported, but does not affect the text display.

The optimal length is 400-600 characters.

Recommendations and rules

downloadable

Type: boolean

A sign of a digital product. Specify true if the product is delivered by e-mail.

How to work with digital goods

guaranteePeriod

Type: TimePeriodDTO

The warranty period is the period during which the product can be replaced or repaired at no additional cost.

Be sure to specify the deadline, if any.

Describe the features of the warranty service in the comments. For example, The battery is guaranteed for 6 months..

lifeTime

Type: TimePeriodDTO

Service life is the period during which a product must perform its function properly.

Be sure to specify the deadline, if any.

Specify the storage conditions in the comments. For example, Use at a temperature not lower than -10 degrees.

manuals

Type: OfferManualDTO[]

A list of instructions for using the product.
Instructions for using the product.

Min items: 1

manufacturerCountries

Type: string[]

The country where the product was produced.

Write down the names of the countries as they are written in the list.

Example: Russia

Min items: 1

Unique items  

marketCategoryId

Type: integer<int64>

The ID of the category on the Market to which you attribute your product.

Always indicate when you transmit parameterValues

If, when changing the characteristics, you pass parameterValues and don't specify marketCategoryId, the characteristics will be updated, but you will receive a warning in the response (parameter warnings).

If you do not pass both of them, information from outdated parameters will be used. params and category, and marketCategoryId it will be detected automatically.

When changing the category, make sure that the product characteristics and their values in the parameter parameterValues you are submitting for a new category.

You can get a list of Market categories using a request. POST categories/tree.

mediaFiles

Type: OfferMediaFilesDTO

Information about the product's media files.

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

params

⦸

Type: OfferParamDTO[]

When transmitting characteristics, use parameterValues.

Characteristics that only products of a specific category have, such as the diameter of bicycle wheels or the material of shoe soles.
Product parameters.

If the product has several values of the same parameter, send them with the same name, but different value.

Example
"params": [
  {
    "name": "Цвет для фильтра",
    "value": "Зеленый"
  },
  {
    "name": "Цвет для фильтра",
    "value": "Желтый"
  }
]

Min items: 1

pictures

Type: string[]

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.
  • The maximum length is 512 characters.
  • Russian letters in the URL are allowed.
  • You can use direct links to images and to Yandex.Disk. Links on Yandex.Disk must be copied using the function To share. Relative links and links to other cloud storages do not work.

✅ https://example-shop.ru/images/sku12345.jpg

✅ https://yadi.sk/i/NaBoRsimVOLov

❌ /images/sku12345.jpg

❌ https://www.dropbox.com/s/818f/tovar.jpg

Links 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 from the old link, it will not update.

Image Requirements

Min length: 1

Max length: 2000

Min items: 1

Unique items false

purchasePrice

Type: GetPriceDTO

Cost is the cost of independently producing a product or purchasing it from a manufacturer or supplier.
The price of the product.
The time of the last update.

sellingPrograms

Type: OfferSellingProgramDTO[]

Information about which placement models are available for the product.
Information about which models can be used to sell the product and which cannot.

Min items: 1

shelfLife

Type: TimePeriodDTO

Expiration date is the period after which the product becomes unusable.

Specify the date indicated on the jar or package. The current date, delivery date, or shipment date does not matter.

Be sure to specify the deadline, if any.

Specify the storage conditions in the comments. For example, Store in a dry place.

tags

Type: string[]

Product labels that the store uses. The tags are not visible to customers. You can group and filter different products in a catalog by tags, for example, products from the same series, collection, or line.

The maximum tag length is 20 characters. One product can have a maximum of 10 tags.

Example: up to 500 rubles

Min items: 1

Max items: 50

Unique items  

type

Type: OfferType

A special type of product. It is indicated if the product:

  • it has a special type that you want to remove.
  • medicine;
  • paper or electronic book;
  • audiobook;
  • music or video;
  • made to order;
  • alcohol.

Enum: DEFAULT, MEDICINE, BOOK, AUDIOBOOK, ARTIST_TITLE, ON_DEMAND, ALCOHOL

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

videos

Type: string[]

Links (URLs) to the product video.

Link Requirements

  • Specify the entire link, including the http or https protocol.
  • The maximum length is 512 characters.
  • Russian letters in the URL are allowed.
  • You can use direct links to videos and to Yandex.Disk. Links on Yandex.Disk must be copied using the function To share. Relative links and links to other cloud storages do not work.

✅ https://example-shop.ru/video/sku12345.avi

✅ https://yadi.sk/i/NaBoRsimVOLov

❌ /video/sku12345.avi

❌ https://www.dropbox.com/s/818f/super-tovar.avi

Links 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 just replace the video using the old link, it will not update.

Video Requirements

Min length: 1

Max length: 2000

Min items: 1

Unique items false

weightDimensions

Type: OfferWeightDimensionsDTO

The dimensions of the package and the weight of the product.

ShowcaseUrlDTO

The link to the product in the showcase and its type.

Name

Description

showcaseType*

Type: ShowcaseType

The type of showcase.

Enum: B2B, B2C

showcaseUrl*

Type: string

The link to the product.

GetPriceDTO

Price indicating the time of the last update.

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

updatedAt*

Type: string<date-time>

The time of the last update.

value*

Type: number

The price of the product.

Min value (exclusive): 0

AgeDTO

Age in the specified units of measurement.

Name

Description

ageUnit*

Type: AgeUnitType

Unit of measurement.

Enum: YEAR, MONTH

value*

Type: number

Meaning.

Min value: 0

GetPriceWithDiscountDTO

The price includes the currency, discount, and the time of the last update.

Name

Description

updatedAt*

Type: string<date-time>

The time of the last update.

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

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

value

Type: number

The price of the product.

Min value (exclusive): 0

OfferCampaignStatusDTO

The status of the product in the store.

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:

  • Modules and APIs → block Sending data to Yandex.Market.
  • Query log → drop-down list in the block Show logs.

, Do not send the store's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.

status*

Type: OfferCampaignStatusType

The status of the product.

Enum: PUBLISHED, CHECKING, DISABLED_BY_PARTNER, DISABLED_AUTOMATICALLY, REJECTED_BY_MARKET, CREATING_CARD, NO_CARD, NO_STOCKS, ARCHIVED

CommodityCodeDTO

Product code.

Name

Description

code*

Type: string

Product code.

type*

Type: CommodityCodeType

The type of product code.

Enum: CUSTOMS_COMMODITY_CODE, IKPU_CODE

OfferConditionDTO

The condition of the discounted product.

Name

Description

quality

Type: OfferConditionQualityType

The appearance of the product.

Enum: PERFECT, EXCELLENT, GOOD, NOT_SPECIFIED

reason

Type: string

Product description. Describe the defects in detail, how noticeable they are and where to look for them.

type

Type: OfferConditionType

The type of markdown.

Enum: PREOWNED, SHOWCASESAMPLE, REFURBISHED, REDUCTION, RENOVATED, NOT_SPECIFIED

TimePeriodDTO

A 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.

Name

Description

timePeriod*

Type: integer

Duration in the specified units.

timeUnit*

Type: TimeUnitType

Unit of measurement.

Enum: HOUR, DAY, WEEK, MONTH, YEAR

comment

Type: string

Comment.

Max length: 500

OfferManualDTO

Instructions for using the product.

Name

Description

url*

Type: string

Link to the instructions.

Min length: 1

Max length: 2000

title

Type: string

The name of the instruction that will be displayed on the product card.

Max length: 500

OfferMediaFilesDTO

Information about the product's media files.

Name

Description

firstVideoAsCover

⦸

Type: boolean

Use the first video in the card as a video background.

Pass it on true for the first video to be used as a video background, or false so that the video background is not displayed in the product profile.

manuals

Type: OfferMediaFileDTO[]

Product usage guidelines.
Information about the product's media file.

Min items: 1

pictures

Type: OfferMediaFileDTO[]

Product images.
Information about the product's media file.

Min items: 1

videos

Type: OfferMediaFileDTO[]

Video files of the product.
Information about the product's media file.

Min items: 1

OfferParamDTO

Product parameters.

If the product has several values of the same parameter, send them with the same name, but different value.

Example
"params": [
  {
    "name": "Цвет для фильтра",
    "value": "Зеленый"
  },
  {
    "name": "Цвет для фильтра",
    "value": "Желтый"
  }
]

Name

Description

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 category/{categoryId}/parameters.

Example: Wi-Fi

Max length: 200

value*

Type: string

Meaning.

Example: there is

OfferSellingProgramDTO

Information about which models can be used to sell the product and which cannot.

Name

Description

sellingProgram*

Type: SellingProgramType

The placement model.

Enum: FBY, FBS, DBS, EXPRESS

status*

Type: OfferSellingProgramStatusType

Information about whether it is possible to sell goods using this model.

Enum: FINE, REJECT

OfferType

Special type of product:

  • DEFAULT — products for which you transferred a special type earlier 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 a book

Specify the year of publication in the product specifications. More information about the parameter

Type

Description

OfferType

Enum: DEFAULT, MEDICINE, BOOK, AUDIOBOOK, ARTIST_TITLE, ON_DEMAND, ALCOHOL

OfferWeightDimensionsDTO

The dimensions of the package and the weight of the product.

If the product takes up several boxes, fold them compactly before measuring the dimensions.

Multi-seat cargo measurement scheme

Name

Description

height*

Type: number

Package height in cm.

Example: 20

Min value: 0

length*

Type: number

Package length in cm.

Example: 65.55

Min value: 0

weight*

Type: number

The weight of the product in kg, including packaging (gross).

Example: 1.001

Min value: 0

width*

Type: number

Package width in cm.

Example: 50.7

Min value: 0

ShowcaseType

Showcase Type:

Type

Description

ShowcaseType

Enum: B2B, B2C

CurrencyType

Currency codes:

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

Type

Description

CurrencyType

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

AgeUnitType

Age measurement units:

  • YEAR — a year.
  • MONTH — a month.

Type

Description

AgeUnitType

Enum: YEAR, MONTH

OfferCampaignStatusType

Product status:

  • PUBLISHED — Ready for sale.
  • CHECKING — On inspection.
  • 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?

Type

Description

OfferCampaignStatusType

Enum: PUBLISHED, CHECKING, DISABLED_BY_PARTNER, DISABLED_AUTOMATICALLY, REJECTED_BY_MARKET, CREATING_CARD, NO_CARD, NO_STOCKS, ARCHIVED

CommodityCodeType

Type of product code:

  • CUSTOMS_COMMODITY_CODE — the product code in the unified Commodity nomenclature of Foreign Economic Activity (HS) is 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.

Type

Description

CommodityCodeType

Enum: CUSTOMS_COMMODITY_CODE, IKPU_CODE

OfferConditionQualityType

Product appearance:

  • PERFECT — perfect.
  • EXCELLENT — Excellent.
  • GOOD —A good one.
  • NOT_SPECIFIED — not selected.

Type

Description

OfferConditionQualityType

Enum: PERFECT, EXCELLENT, GOOD, NOT_SPECIFIED

OfferConditionType

Markdown type:

  • PREOWNED — used goods that used to belong to another person.
  • SHOWCASESAMPLE — showcase sample.
  • REFURBISHED — re-sale of the product.
  • REDUCTION — defective product.
  • RENOVATED — restored product.
  • NOT_SPECIFIED — not selected.

REFURBISHED — special value for clothes, shoes and accessories. It is used only for discounted products from this category. Other values for clothing, shoes, and accessories are not used.

Type

Description

OfferConditionType

Enum: PREOWNED, SHOWCASESAMPLE, REFURBISHED, REDUCTION, RENOVATED, NOT_SPECIFIED

TimeUnitType

Time measurement unit:

  • HOUR "An hour."
  • DAY — a day.
  • WEEK — a week.
  • MONTH — a month.
  • YEAR — a year.

Type

Description

TimeUnitType

Enum: HOUR, DAY, WEEK, MONTH, YEAR

OfferMediaFileDTO

Information about the product's media file.

Name

Description

title

Type: string

The name of the media file.

uploadState

Type: MediaFileUploadStateType

The download status of the media file.

Enum: UPLOADING, UPLOADED, FAILED

url

Type: string

The link to the media file.

Min length: 1

Max length: 2000

SellingProgramType

Placement model:

  • FBY — FBY.
  • FBS — FBS.
  • DBS — DBS.
  • EXPRESS — Express.

Type

Description

SellingProgramType

Enum: FBY, FBS, DBS, EXPRESS

OfferSellingProgramStatusType

Information about availability or unavailability.

  • FINE — available.
  • REJECT — not available.

Type

Description

OfferSellingProgramStatusType

Enum: FINE, REJECT

MediaFileUploadStateType

Media file download status:

  • UPLOADING — it's loading.
  • UPLOADED — uploaded successfully.
  • FAILED — an error occurred when uploading. Please try again later.

Type

Description

MediaFileUploadStateType

Enum: UPLOADING, UPLOADED, FAILED

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 in 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

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

What is GTIN?
GTIN 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
Editing product category characteristics
Next
In the shop