Adding products to the catalog and changing information about them

Info

Console

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

offers-and-cards-management — Manage products and cards
all-methods — Full account management

Adds products to the catalog and transmits:

their categories on the Market and categorical characteristics;
main features;
prices of goods in the cabinet.

It also combines products on the card, edits and deletes information about already added products, including prices in the cabinet and product categories.

You can get a list of Market categories using a request. POST categories/tree, and product characteristics by category using POST category/{categoryId}/parameters.

Add a new product

Transfer it with a new ID that has never been used in the folder before.

Be sure to specify the parameters: offerId, name, marketCategoryId, pictures, vendor, description.

Try to convey as much information as possible right away. The Market will need it to select a suitable card or create a new one.

If you know which card on the Market corresponds to the product, you can immediately specify the ID of this card (SKU on the Market) in the field marketSKU.

For sellers of the Yandex Go Market:

When you add products to the catalog, specify the parameter values name and description in Russian. To display them in a different language on the showcase, make the request again. POST businesses/{businessId}/offer-mappings/update where to specify:

the language in the parameter language;
parameter values name and description in the specified language.

You do not need to retransmit the remaining product characteristics.

Change product information

Send the new data by specifying in offerId appropriate your SKU.

Fields where nothing changes can be omitted.

Delete previously transmitted product parameters

In deleteParameters specify the values of the parameters that you want to delete. You can pass multiple values at once.

For parameters with the type string you can also pass an empty value.

Parameter offerId must be unique for all the products that you transfer.

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.

The data in the catalog is not updated instantly

It takes up to a few minutes.

, Limit: 10,000 products per minute, no more than 100 products per request

Request

POST

https://api.partner.market.yandex.ru/businesses/{businessId}/offer-mappings/update

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.

CatalogLanguageType

Language:

RU — Russian.
UZ — Uzbek.

Type	Description
CatalogLanguageType	Enum: `RU`, `UZ`

Body

application/json

{
    "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": "есть"
                    }
                ],
                "parameterValues": [
                    {
                        "parameterId": 0,
                        "unitId": 0,
                        "valueId": 0,
                        "value": "string"
                    }
                ],
                "basicPrice": {
                    "value": 0,
                    "currencyId": "RUR",
                    "discountBase": 0
                },
                "purchasePrice": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "additionalExpenses": {
                    "value": 0,
                    "currencyId": "RUR"
                },
                "firstVideoAsCover": false,
                "deleteParameters": [
                    "ADDITIONAL_EXPENSES"
                ]
            },
            "mapping": {
                "marketSku": 0
            }
        }
    ],
    "onlyPartnerMediaContent": false
}

Name

Description

offerMappings*

Type: UpdateOfferMappingDTO[]

A list of products that need to be added or updated.

We will soon reduce the maximum number of products per request.

Don't send more than 100 right now.

Product information.

Min items: 1

Max items: 500

onlyPartnerMediaContent

Type: boolean

Whether only the product data you provided will be used.

Default value: false. To delete the data that the Market added, pass the value true.

UpdateOfferMappingDTO

Product information.

Name

Description

offer*

Type: UpdateOfferDTO

Product parameters.
The main parameters of the product.

mapping

Type: UpdateMappingDTO

Information about the product card on the Market.

UpdateOfferDTO

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

The price of the product.

adult

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: 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).

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

Price with discount indication.
The price of the product.

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

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

Max items: 6

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

deleteParameters

Type: DeleteOfferParameterType[]

The parameters that you previously passed to UpdateOfferDTO, and now you want to delete it.

If you pass adult, downloadable and firstVideoAsCover if they are not deleted , their value will change to false.

You can pass multiple values at once.

Do not use together with the corresponding parameter in UpdateOfferDTO. This will result in an error. 400.
The values of the parameters you want to delete and the corresponding parameters in UpdateOfferDTO in which you passed these values earlier:

ADDITIONAL_EXPENSES — additional costs for the product (parameter additionalExpenses).
ADULT — mark 18+ (parameter adult)
AGE — age limit for children (parameter age).
BARCODES — barcode (parameter barcodes).
BOX_COUNT — the number of cargo spaces (parameter boxCount).
CERTIFICATES — document numbers for the product (parameter certificates).
COMMODITY_CODES — product codes (parameter commodityCodes).
CONDITION — the condition of the discounted product (parameter condition).
CUSTOMS_COMMODITY_CODE — the product code in the HS code (parameter customsCommodityCode).
DESCRIPTION — product description (parameter description).
DOWNLOADABLE — digital product attribute (parameter downloadable).
GUARANTEE_PERIOD — warranty period (parameter guaranteePeriod).
LIFE_TIME — service life (parameter lifeTime).
MANUALS — a list of instructions for using the product (parameter manuals).
MANUFACTURER_COUNTRIES — country of manufacture (parameter manufacturerCountries).
PARAMETERS — product characteristics (parameters params, parameterValues).
PICTURES — links to product images (parameter pictures).
PURCHASE_PRICE — cost price (parameter purchasePrice).
SHELF_LIFE — expiration date (parameter shelfLife).
TAGS — product tags that the store uses (parameter tags).
TYPE — a special type of product (parameter type).
VENDOR_CODE — the name of the brand or manufacturer (parameter vendorCode).
VIDEOS — links to the product video (parameter videos).

Enum: ADDITIONAL_EXPENSES, ADULT, AGE, BARCODES, BOX_COUNT, CERTIFICATES, COMMODITY_CODES, CONDITION, CUSTOMS_COMMODITY_CODE, DESCRIPTION, DOWNLOADABLE, GUARANTEE_PERIOD, LIFE_TIME, MANUALS, MANUFACTURER_COUNTRIES, PARAMETERS, PICTURES, PURCHASE_PRICE, SHELF_LIFE, TAGS, TYPE, VENDOR_CODE, VIDEOS

Min items: 1

Unique items

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

Max length: 6000

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

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.

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

Max items: 6

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.

name

Type: string

Make up the name according to the scheme: type + brand or manufacturer + model + features, if any (for example, color, size or weight) and quantity in the package.

Do not include emotional characteristics ("hit", "super", etc.) in the name of the terms of sale (for example, "discount", "free shipping", etc.). Do not write words in capital letters, except for the established names of brands and models.

The optimal length is 50-60 characters.

Recommendations and rules

Example: Impact drill Makita HP1630, 710 W

Max length: 256

parameterValues

Type: ParameterValueDTO[]

A list of characteristics with their values.

Always transmit along with marketCategoryId

If you don't pass it marketCategoryId when the characteristics change, they will be updated, but a warning will be received 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.

By change pass only those characteristics whose value needs to be updated. If in marketCategoryId you are changing the category, the values of the common characteristics for the old and new categories will remain, and you do not need to transfer them.

To delete the value of the specified characteristic, transmit it parameterId with an empty value.
The value of the characteristic.

You can specify multiple values for the same characteristic, provided that:

Type of feature — ENUM.
In response to the request POST category/{categoryId}/parameters this characteristic has a field multivalue it matters true.

To do this, in parameterValues pass each value separately — multiple objects with parameters parameterId, valueId and value. Parameter parameterId it must be the same.

Min items: 1

Max items: 300

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

Specify the entire link, including the http or https protocol.
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

Max items: 30

Unique items false

purchasePrice

Type: BasePriceDTO

The price of the product.

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.

UpdateMappingDTO

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

Name

Description

marketSku

Type: integer<int64>

The ID of the card on the Market.

Min value: 1

BasePriceDTO

The price of the product.

Name

Description

currencyId*

Type: CurrencyType

Currency.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

value*

Type: number

The price of the product.

Min value (exclusive): 0

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

PriceWithDiscountDTO

Price with discount indication.

Name	Description
currencyId*	Type: CurrencyType Currency. Enum: `RUR`, `USD`, `EUR`, `UAH`, `AUD`, `GBP`, `BYR`, `BYN`, `DKK`, `ISK`, `KZT`, `CAD`, `CNY`, `NOK`, `XDR`, `SGD`, `TRY`, `SEK`, `CHF`, `JPY`, `AZN`, `ALL`, `DZD`, `AOA`, `ARS`, `AMD`, `AFN`, `BHD`, `BGN`, `BOB`, `BWP`, `BND`, `BRL`, `BIF`, `HUF`, `VEF`, `KPW`, `VND`, `GMD`, `GHS`, `GNF`, `HKD`, `GEL`, `AED`, `EGP`, `ZMK`, `ILS`, `INR`, `IDR`, `JOD`, `IQD`, `IRR`, `YER`, `QAR`, `KES`, `KGS`, `COP`, `CDF`, `CRC`, `KWD`, `CUP`, `LAK`, `LVL`, `SLL`, `LBP`, `LYD`, `SZL`, `LTL`, `MUR`, `MRO`, `MKD`, `MWK`, `MGA`, `MYR`, `MAD`, `MXN`, `MZN`, `MDL`, `MNT`, `NPR`, `NGN`, `NIO`, `NZD`, `OMR`, `PKR`, `PYG`, `PEN`, `PLN`, `KHR`, `SAR`, `RON`, `SCR`, `SYP`, `SKK`, `SOS`, `SDG`, `SRD`, `TJS`, `THB`, `TWD`, `BDT`, `TZS`, `TND`, `TMM`, `UGX`, `UZS`, `UYU`, `PHP`, `DJF`, `XAF`, `XOF`, `HRK`, `CZK`, `CLP`, `LKR`, `EEK`, `ETB`, `RSD`, `ZAR`, `KRW`, `NAD`, `TL`, `UE`
value*	Type: number The price of the product. Min value (exclusive): `0`
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`

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`

DeleteOfferParameterType

The values of the parameters you want to delete and the corresponding parameters in UpdateOfferDTO in which you passed these values earlier:

ADDITIONAL_EXPENSES — additional costs for the product (parameter additionalExpenses).
ADULT — mark 18+ (parameter adult)
AGE — age limit for children (parameter age).
BARCODES — barcode (parameter barcodes).
BOX_COUNT — the number of cargo spaces (parameter boxCount).
CERTIFICATES — document numbers for the product (parameter certificates).
COMMODITY_CODES — product codes (parameter commodityCodes).
CONDITION — the condition of the discounted product (parameter condition).
CUSTOMS_COMMODITY_CODE — the product code in the HS code (parameter customsCommodityCode).
DESCRIPTION — product description (parameter description).
DOWNLOADABLE — digital product attribute (parameter downloadable).
GUARANTEE_PERIOD — warranty period (parameter guaranteePeriod).
LIFE_TIME — service life (parameter lifeTime).
MANUALS — a list of instructions for using the product (parameter manuals).
MANUFACTURER_COUNTRIES — country of manufacture (parameter manufacturerCountries).
PARAMETERS — product characteristics (parameters params, parameterValues).
PICTURES — links to product images (parameter pictures).
PURCHASE_PRICE — cost price (parameter purchasePrice).
SHELF_LIFE — expiration date (parameter shelfLife).
TAGS — product tags that the store uses (parameter tags).
TYPE — a special type of product (parameter type).
VENDOR_CODE — the name of the brand or manufacturer (parameter vendorCode).
VIDEOS — links to the product video (parameter videos).

Type	Description
DeleteOfferParameterType	Enum: `ADDITIONAL_EXPENSES`, `ADULT`, `AGE`, `BARCODES`, `BOX_COUNT`, `CERTIFICATES`, `COMMODITY_CODES`, `CONDITION`, `CUSTOMS_COMMODITY_CODE`, `DESCRIPTION`, `DOWNLOADABLE`, `GUARANTEE_PERIOD`, `LIFE_TIME`, `MANUALS`, `MANUFACTURER_COUNTRIES`, `PARAMETERS`, `PICTURES`, `PURCHASE_PRICE`, `SHELF_LIFE`, `TAGS`, `TYPE`, `VENDOR_CODE`, `VIDEOS`

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

ParameterValueDTO

The value of the characteristic.

You can specify multiple values for the same characteristic, provided that:

Type of feature — ENUM.
In response to the request POST category/{categoryId}/parameters this characteristic has a field multivalue it matters true.

To do this, in parameterValues pass each value separately — multiple objects with parameters parameterId, valueId and value. Parameter parameterId it must be the same.

Name	Description
parameterId*	Type: integer<int64> The identifier of the characteristic. Min value: `1`
unitId	Type: integer<int64> ID of the unit of measurement. If you did not pass the parameter `unitId`, the default unit of measurement is used.
value	Type: string Meaning. For type characteristics `ENUM` transmit along with `valueId`.
valueId	Type: integer<int64> ID of the value. Be sure to specify the identifier if you are transmitting a value from the list of acceptable values received from the Market. Transmit along with `value`. Only for type characteristics `ENUM`.

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

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`

CurrencyType

Currency codes:

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

Type

Description

CurrencyType

AgeUnitType

Age measurement units:

YEAR — a year.
MONTH — a month.

Type	Description
AgeUnitType	Enum: `YEAR`, `MONTH`

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`

Responses

200 OK

The request was executed correctly, and the data has been processed.

The answer 200 by itself does not mean that the transmitted values are correct.

Be sure to look at the details of the response.: status and a list of errors, if any.

Even if an error is made in the characteristics of just one product, no changes from the request will be included in the catalog.

Body

application/json

{
    "status": "OK",
    "results": [
        {
            "offerId": "string",
            "errors": [
                {
                    "type": "UNKNOWN_CATEGORY",
                    "parameterId": 0,
                    "message": "string"
                }
            ],
            "warnings": [
                {
                    "type": "UNKNOWN_CATEGORY",
                    "parameterId": 0,
                    "message": "string"
                }
            ]
        }
    ]
}

Name

Description

results

Type: UpdateOfferMappingResultDTO[]

Errors and warnings that appeared when processing the list of characteristics. Each item in the list corresponds to one product.

If there are no errors or warnings, the field is not passed.
Errors and warnings that appeared due to the transmitted characteristics.

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

UpdateOfferMappingResultDTO

Errors and warnings that appeared due to the transmitted characteristics.

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}$`
errors	Type: OfferMappingErrorDTO[] Mistakes. If there is an error for at least one product, the information in the catalog will not be updated for all transferred products. The text of the error or warning. Min items: `1`
warnings	Type: OfferMappingErrorDTO[] Warnings. The information in the catalog will be updated. The text of the error or warning. Min items: `1`

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`

OfferMappingErrorDTO

The text of the error or warning.

Name	Description
message*	Type: string The text of the error or warning.
type*	Type: OfferMappingErrorType Types of errors and warnings: `UNKNOWN_CATEGORY` — an unknown category is specified. `INVALID_CATEGORY` — a non-leaf category is specified. Specify the one that has no child categories. `EMPTY_MARKET_CATEGORY` — the Market category is not specified when transmitting the category characteristics. `UNKNOWN_PARAMETER` — a characteristic has been transmitted that is not among the characteristics of the category. `UNEXPECTED_BOOLEAN_VALUE` — something else is passed instead of the boolean value. `NUMBER_FORMAT` — a string was passed that does not represent a number, instead of a number. `INVALID_UNIT_ID` — a unit of measurement that is unacceptable for the characteristic has been passed. `INVALID_GROUP_ID_LENGTH` — the name exceeds the allowed character value of 255. `INVALID_GROUP_ID_CHARACTERS` — transferred invalid characters. `INVALID_PICKER_URL` — a link to the thumbnail image has been transmitted, which is not included in the transmitted links to the product image. `LOCKED_DIMENSIONS` — the dimensions of the package have been transferred, which cannot be changed. `INVALID_COMMODITY_CODE` — an incorrect product code has been transmitted. You can check which category characteristics are available for a given category and get their settings using a request. POST category/{categoryId}/parameters. Enum: `UNKNOWN_CATEGORY`, `INVALID_CATEGORY`, `EMPTY_MARKET_CATEGORY`, `UNKNOWN_PARAMETER`, `UNEXPECTED_BOOLEAN_VALUE`, `NUMBER_FORMAT`, `INVALID_UNIT_ID`, `INVALID_GROUP_ID_LENGTH`, `INVALID_GROUP_ID_CHARACTERS`, `INVALID_PICKER_URL`, `LOCKED_DIMENSIONS`, `INVALID_COMMODITY_CODE`
parameterId	Type: integer<int64> ID of the feature that the error or warning is associated with.

OfferMappingErrorType

Types of errors and warnings:

UNKNOWN_CATEGORY — an unknown category is specified.
INVALID_CATEGORY — a non-leaf category is specified. Specify the one that has no child categories.
EMPTY_MARKET_CATEGORY — the Market category is not specified when transmitting the category characteristics.
UNKNOWN_PARAMETER — a characteristic has been transmitted that is not among the characteristics of the category.
UNEXPECTED_BOOLEAN_VALUE — something else is passed instead of the boolean value.
NUMBER_FORMAT — a string was passed that does not represent a number, instead of a number.
INVALID_UNIT_ID — a unit of measurement that is unacceptable for the characteristic has been passed.
INVALID_GROUP_ID_LENGTH — the name exceeds the allowed character value of 255.
INVALID_GROUP_ID_CHARACTERS — transferred invalid characters.
INVALID_PICKER_URL — a link to the thumbnail image has been transmitted, which is not included in the transmitted links to the product image.
LOCKED_DIMENSIONS — the dimensions of the package have been transferred, which cannot be changed.
INVALID_COMMODITY_CODE — an incorrect product code has been transmitted.

You can check which category characteristics are available for a given category and get their settings using a request. POST category/{categoryId}/parameters.

Type	Description
OfferMappingErrorType	Enum: `UNKNOWN_CATEGORY`, `INVALID_CATEGORY`, `EMPTY_MARKET_CATEGORY`, `UNKNOWN_PARAMETER`, `UNEXPECTED_BOOLEAN_VALUE`, `NUMBER_FORMAT`, `INVALID_UNIT_ID`, `INVALID_GROUP_ID_LENGTH`, `INVALID_GROUP_ID_CHARACTERS`, `INVALID_PICKER_URL`, `LOCKED_DIMENSIONS`, `INVALID_COMMODITY_CODE`

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

423 Locked

The specified method cannot be applied to the resource. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

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

Enum: OK, ERROR

Was the article helpful?

Lists of product characteristics by category

Changing the terms of sale