Skip to main content

Product data object

Description

Product data object used in product import requests.

ParameterTypeExampleRequiredDescription
namestring"Canon EOS Digital Camera"YesProduct's name.
external_idstring"12345"YesProduct ID that is used when adding an item to an order.
pricestring"490"NoCurrent price of the product.
old_pricestring"520"NoOld price of the product.
currencystring"USD"NoThe currency that is used when specifying the product price.

Currencies are configured in the platform interface: Market SettingsOther. If the request passes a currency that is not set in the platform, an error will occur.

tagsarray
[
"camera",
"Canon"
]
NoList of tags.
manufacturer_namestring"Canon"NoManufacturer's name.
descriptionstring"Test description"NoProduct description.
The length of the text is no more than 1000 characters.
urlstring"https://example.com"NoURL of the product page on the store site.
picturesarray
[
"https://example_1.com",
"https://example_2.com"
]
NoList of URL links to the product images.
countint60NoThe number of products available for sale.
expiration_timestring"730"NoShelf life or service life (in days).
is_availablebooltrueNoWhether the product is in stock or not.
deliverybooltrueNoPossibility of courier delivery (for all regions to which the store delivers).
barcodearray
[
5235235,
347347,
335578769
]
NoList of product barcodes from the manufacturer.
manufacturer_warrantybooltrueNoManufacturer's official warranty.
custom_fieldsobject
{
"color": "black",
"weight": 701,
"dimensions": "105*141*77"
}
NoCustom product fields.
Learn more
regional_dataarray
[
{
"external_id": "region_YnCrJj8Y1",
"price": "36000",
"old_price": "38500",
"currency": "RUB",
"custom_fields":{
"color": "black",
"weight": 701
},
"count": 30,
"is_available": true,
"delivery": true
}
]
NoProduct data that varies by region.

external_id is the region ID. You can create a region and get its ID in the platform interface: MarketSettings.
categoriesarray
[
"category_1",
"category_2"
]
NoProduct category ID.
Learn more
skuarray
[
{
"name": "Canon EOS 90D Body",
"external_id": "12345678",
}
]
NoSKU data for this product.
Learn more

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",
}
]
}
]