Product data object

Description

Product data object used in product import requests.

Parameter	Type	Example	Required	Description
name	string	"Canon EOS Digital Camera"	Yes	Product's name.
external_id	string	"12345"	Yes	Product ID that is used when adding an item to an order.
price	string	"490"	No	Current price of the product.
old_price	string	"520"	No	Old price of the product.
currency	string	"USD"	No	The currency that is used when specifying the product price. Currencies are configured in the platform interface: Market → Settings → Other. If the request passes a currency that is not set in the platform, an error will occur.
tags	array	[ "camera", "Canon" ]	No	List of tags.
manufacturer_name	string	"Canon"	No	Manufacturer's name.
description	string	"Test description"	No	Product description. The length of the text is no more than 1000 characters.
url	string	"https://example.com"	No	URL of the product page on the store site.
pictures	array	[ "https://example_1.com", "https://example_2.com" ]	No	List of URL links to the product images.
count	int	60	No	The number of products available for sale.
expiration_time	string	"730"	No	Shelf life or service life (in days).
is_available	bool	true	No	Whether the product is in stock or not.
delivery	bool	true	No	Possibility of courier delivery (for all regions to which the store delivers).
barcode	array	[ 5235235, 347347, 335578769 ]	No	List of product barcodes from the manufacturer.
manufacturer_warranty	bool	true	No	Manufacturer's official warranty.
custom_fields	object	{ "color": "black", "weight": 701, "dimensions": "105*141*77" }	No	Custom product fields. Learn more
regional_data	array	[ { "external_id": "region_YnCrJj8Y1", "price": "36000", "old_price": "38500", "currency": "RUB", "custom_fields":{ "color": "black", "weight": 701 }, "count": 30, "is_available": true, "delivery": true } ]	No	Product data that varies by region. external_id is the region ID. You can create a region and get its ID in the platform interface: Market → Settings.
categories	array	[ "category_1", "category_2" ]	No	Product category ID. Learn more
sku	array	[ { "name": "Canon EOS 90D Body", "external_id": "12345678", } ]	No	SKU data for this product. Learn more

JSON

JSON

[
    {
        "name": "iPhone",
        "external_id": "123456",
        "price": "500",
        "old_price": "400",
        "currency": "USD",
        "tags": [
            "one",
            "two"
        ],
        "manufacturer_name": "Apple",
        "description": "Test description",
        "url": "https://example.com",
        "pictures": [
            "https://example.com",
            "https://example.com"
        ],
        "count": 60,
        "expiration_time": "730",
        "is_available": true,
        "delivery": true,
        "barcode": [
            5235235,
            347347,
            335578769
        ],
        "manufacturer_warranty": false,
        "custom_fields": {
            "product_field_id_1": 123,
            "product_field_id_2": "data"
        },
        "regional_data": [
            {
                "external_id": "region_YnCrJj8Y1",
                "price": "864825",
                "old_price": "400",
                "currency": "USD",
                "custom_fields": {
                    "product_field_id_1": 123,
                    "product_field_id_2": "data"
                },
                "count": 30,
                "is_available": true,
                "delivery": true
            }
        ],
        "categories": [
            "category_1",
            "category_2"
        ],
        "sku": [
            {
                "name": "iPhone",
                "external_id": "12345678",
            }
        ]
    }
]

XML

<xml>
  <row>
    <name>iPhone</name>
    <external_id>123456</external_id>
    <price>500</price>
    <old_price>400</old_price>
    <currency>USD</currency>
    <tags>one</tags>
    <tags>two</tags>
    <manufacturer_name>Apple</manufacturer_name>
    <description>Test description</description>
    <url>https://example.com</url>
    <pictures>https://example.com</pictures>
    <pictures>https://example.com</pictures>
    <count>60</count>
    <expiration_time>730</expiration_time>
    <is_available>true</is_available>
    <delivery>true</delivery>
    <barcode>5235235</barcode>
    <barcode>347347</barcode>
    <barcode>335578769</barcode>
    <manufacturer_warranty>false</manufacturer_warranty>
    <custom_fields>
      <product_field_id_1>123</product_field_id_1>
      <product_field_id_2>data</product_field_id_2>
    </custom_fields>
    <regional_data>
      <external_id>region_YnCrJj8Y1</external_id>
      <price>864825</price>
      <old_price>400</old_price>
      <currency>USD</currency>
      <custom_fields>
        <product_field_id_1>123</product_field_id_1>
        <product_field_id_2>data</product_field_id_2>
      </custom_fields>
      <count>30</count>
      <is_available>true</is_available>
      <delivery>true</delivery>
    </regional_data>
    <categories>category_1</categories>
    <categories>category_2</categories>
    <sku>
      <name>iPhone</name>
      <external_id>12345678</external_id>
    </sku>
  </row>
</xml>