All elements included in offer in the simplified type
Simplified and custom types of descriptions are suitable for most products.
Both types of descriptions are equally useful and provide the same degree of binding to product profiles. However, the simplified type is more flexible, since the model and vendor elements are optional for it, whereas for the custom type they are mandatory.
List and description of elements:
| Elements specific to the simplified description | Description | Required |
|---|---|---|
name |
In the name element, using the simplified type, the following should be indicated:
Construct the name according to the scheme: type + brand or manufacturer + model + features, if any (such as color, size, or weight) + quantity per package. Do not include sale conditions (such as "discount," "free shipping," etc.) or emotional characteristics ("hit," "super," etc.) in the name. Do not write words in uppercase—except for established brand and model names. Optimal length is 50–60 characters, maximum is 150 characters. Attention! Do not include sale conditions (for example, promotional offers, delivery information, country of manufacture) in the name element. Sale conditions should be specified in the sales_notes element, and discount information — in the oldprice element. |
Required element. |
| Standard elements | Description | Required |
vendor |
Manufacturer name. Please specify the name exactly as the brand itself writes it. | Optional element. |
vendorCode |
Manufacturer's article number. The product code assigned to it by the manufacturer. If there are multiple article numbers, list them separated by commas. Example: VNDR-0005A, VNDR-0005B |
Optional element. |
id |
Offer item attribute. The product identifier in your system. Any sequence up to 80 characters in length. It can include English and Russian (except ё) letters, digits, and symbols . , / \ ( ) [ ] - = The identifier must be unique for each product, and it should correspond to different products. The same product can have different identifiers if it's sold in different regions or if it is used (second-hand). |
Required element. |
url |
The URL of the page on your website with photos and product description. The maximum length of the URL is 512 characters. Please record it according to the RFC 3986 standard. |
Required element. |
price |
The price of one unit of the product, including all taxes. The main part of the data is updated in Search every 4 hours. |
Required element. |
oldprice |
Original price before discount. If the item is sold at a discount, specify the price without the discount in this field. The price is listed in rubles. The number should be an integer. You can specify a discount of from 5% to 75%. The old price should be higher than the current price. |
Optional element. |
currencyId |
Product price currency: Note. The text format doesn't allow you to indicate your currency conversion conditions. Prices displayed to the buyer will be converted to the appropriate currency using the current exchange rate of the Central Bank of the Russian Federation. |
Required element. |
categoryId |
Product category ID assigned by the store (an integer up to 18 digits long). | Required element. |
available |
Product status:
Attention! This element is used in addition to the data specified in your personal account. This element is not used when the delivery terms of the local courier service are configured in the price list (in any format). This is an attribute for |
Optional element. |
picture |
URL link to product image. Images in JPEG, PNG, or WEBP format are accepted. File size up to 10 MB, dimensions no smaller than 300 × 400 pixels. We recommend using an aspect ratio of 3:4. Provide a link to the image or multiple images. The first photo will be the main image. |
Required element. |
delivery |
Courier delivery option for the store's region. Possible values:
If the element is not specified, then a value is assigned by default. |
Optional element. |
delivery-options |
The number of days required for delivery. One option element represents information about one type of courier delivery:
The Attribute cost — delivery cost
If the delivery cost varies across different city districts, specify the maximum delivery price. Attribute order-before — order deadline Specify the local time (in the store’s time zone) by which the delivery time applies. Use only an integer value from 0 to 24. For example, 18:00 is indicated as If the attribute is not specified, the default value is 13. |
Optional element. |
pickup |
Option to collect a product from a pick-up point. Possible values:
If the element is not specified, then a value is assigned by default. |
Optional element. |
pickup-options |
Use the One option element provides information about one type of pickup:
Attribute cost — pickup cost
If the pickup cost varies across different city districts, specify the maximum price for the service. Attribute order-before — order deadline Specify the local time (in the store’s time zone) by which the delivery time to the pickup point applies. Use only an integer from 0 to 24. For example, 18:00 is indicated as If the attribute is not specified, the default value is 13. |
Optional element. |
description |
Offer description.
|
Required element. |
sales_notes |
|
Optional element. |
adult |
The product is of a sexual nature or pertains to sexual interest in any way. Possible values: true, false. |
Optional element. |
barcode |
Product barcode from the manufacturer. If the product is sold in packages, a barcode for the package is required. Specify in the form of a sequence of digits. EAN-13, EAN-8, UPC-A, and UPC-E codes are suitable. For books, specify the ISBN. If there are multiple barcodes, list all of them separated by commas. |
Optional element. |
param |
All important characteristics of the product: color, size, volume, material, weight, age, gender, etc. In YML, the |
Optional element. |
weight |
Net weight of the product with packaging. Specify in kilograms. Fractions are allowed: the decimal separator can be a dot or a comma, with no more than three digits after it. |
Optional element. |
dimensions |
Length, width, height in the packaging. Specify in centimeters. Fractions are allowed: the decimal separator can be a dot or a comma, with no more than three digits after it. Write the numbers separated by / without spaces. Example: 20.1/20.551/22.5 |
Optional element. |
period-of-validity-days |
Shelf life. The period after which the product becomes unsuitable for use. It is calculated from the manufacturing date, not from the date it is added to the marketplace. The shelf life can be specified in years, months, days, weeks, and hours. Be sure to indicate the shelf life if it exists. The duration is expressed according to ISO 8601, that is, as a string starting with the letter P:
|
Optional element. |
comment-validity-days |
Comment on shelf life. The field is intended for describing storage conditions. No longer than 250 characters and without special symbols (only the following can be used: . , ; ( ) - ? ! ' " « » ﹠ % / °). Example: Store in a dry place. |
Optional element. |
service-life-days |
Service life. During the service life, the product must perform its function properly. Be sure to specify the duration if available. The duration can be indicated in years, months, and days. The duration is specified according to ISO 8601, starting with the letter P:
|
Optional element. |
comment-life-days |
Comment on the service life. This field is designed for descriptions of operating conditions. No longer than 250 characters and without special symbols (only the following can be used: . , ; ( ) - ? ! ' " « » ﹠ % / °) . Example: Use at a temperature not below -10 degrees. |
Optional element. |
warranty-days |
Warranty period. The time during which the product can be replaced or repaired free of charge. The period can be specified in years, months, or days. The duration is indicated according to ISO 8601, as a string starting with the letter P:
|
Optional element. |
comment-warranty |
Comment on the warranty period. This field is intended for describing the specifics of the warranty conditions. Only include information related to the manufacturer's warranty. It should be no longer than 250 characters and without special symbols (only the following can be used: . , ; ( ) - ? ! ' " « » ﹠ % / °) . Example: Battery warranty — 6 months. |
Optional element. |
certificate |
Document number. The document number for the product: certificate, declaration of conformity, etc. Example: 6241421. |
Optional element. |
tn-ved-code |
HS code. Please specify it if available. 10 or 14 digits without spaces. Example: 8517610008 |
Optional element. |
|
|
Indicator of used goods (pre-owned). Please обязательно specify the attribute type:
|
Optional element. |
Elements inside condition:
quality |
Element inside Possible values:
|
Required element. |
reason |
Element inside
|
Required element. |
Examples
Example of a single offer (offer) for YML format.
<yml_catalog date="2020-04-20T12:34:56+03:00">
<shop>
<name>Space Agency</name>
<company>Space Agency Local inc.</company>
<url>http://example.com</url>
<currencies>
<currency id="EUR" rate="1"/>
</currencies>
<categories>
<category id="1">Optical instruments</category>
<category id="10" parentId="1">Telescopes</category>
</categories>
<delivery-options>
<option cost="200" days="1"/>
</delivery-options>
<offers>
<offer id="9012" bid="420">
<name>Very Big Telescope 3000 ProMax</name>
<vendor>Brand</vendor>
<vendorCode>SOMEVENDORCODE</vendorCode>
<url>http://example.com/product_page.asp?pid=12345</url>
<price>420.15</price>
<enable_auto_discounts>false</enable_auto_discounts>
<currencyId>EUR</currencyId>
<categoryId>10</categoryId>
<picture>http://example.com/image.jpg</picture>
<supplier ogrn="12345678"/>
<delivery>true</delivery>
<delivery-options>
<option cost="300" days="1" order-before="18"/>
</delivery-options>
<pickup>true</pickup>
<pickup-options>
<option cost="300" days="4" order-before="18"/>
</pickup-options>
<store>true</store>
<description>
This is the largest telescope in which you can see everything
you want!
</description>
<sales_notes>Prepayment is required.</sales_notes>
<min-quantity>2</min-quantity>
<manufacturer_warranty>true</manufacturer_warranty>
<country_of_origin>China</country_of_origin>
<adult>false</adult>
<barcode>4719512011041</barcode>
<param name="Color">silver</param>
<weight>3.6</weight>
<dimensions>20.1/20.551/22.5</dimensions>
</offer>
</offers>
<gifts>
<!-- gifts not from price list -->
</gifts>
<promos>
<!-- promo actions -->
</promos>
</shop>
</yml_catalog>