Функция Function catalog/export (http://<DOMAIN>/api/catalog/export/)
ПараметрыParameters:
- token - ключ авторизации полученный через функцию auth
- authorization key obtained through the auth function
- expr - условие выборки товаров
- condition of goods selection
- parent -
путь \ к \ разделу (Развивающие игрушки \ Игрушки для малышей) ИЛИ - path to the section (Toys\Educational toys\Toys for Kids) OR
- parent.id -
идентификатор раздела для выборки (или идентификаторы parent: {“id”- section id for selection (or parent.id: {"id": [1,2,3,4]})
- display_in_showcase - 0
или 1 для выборки товаров которые включены- НАЧИНАЯ С ВЕРСИИ 3.21.1 article - выборка товаров по артикулу (строка или массив, например
- or 1 for selection of products that are included
- article - selection of products by article (string or array, for example: ['SKU-1-BLACK', 'MF-2010']).
Не обязательный параметр- Not a mandatory parameter
- offset - смещение относительно начала выборки товаров
- offset relative to the beginning of the goods selection
- limit - количество экспортируемых товаров (по умолчанию 500 записей, более 500 записей выгрузить невозможно во избежание перегрузки сервера). Работает совместно с параметром offset. Например
- number of exported items (by default 500 records, more than 500 records cannot be exported to avoid server overload). It works together with the offset parameter. For example: offset=20&limit=10 - выведет товары с 20-го по 30-й
| Info |
|---|
Параметры ниже доступны с версии 3.15.11 |
- includedParams - список полей которые необходимо выбрать (будут выбраны только указанные Вами и основные
- will output goods from the 20th to the 30th.
- includedParams - list of fields to be selected (only the fields specified by you will be selected: parent_article, article, parent). смsee example below. пример ниже
- excludedParams - список полей которые необходимо исключить из экспорта (также исключаются поля которые указаны в includedParams, если этот параметр заполнен). см. пример ниже
Ответ:
status - статус выполнения функции
OK - экспорт прошел успешно
EXCEPTION - произошла ошибка
- products - экспортируемые товарыlist of fields that should be excluded from export (also excluded are the fields specified in includedParams, if this parameter is filled). see example below.
Response:
- status - status of function execution
- OK - export was successful
- EXCEPTION - an error occurred
- products - exported goods
- products[i].title.
ru - значение на русском языке - en - value in English
- products[i].title.
ua - значение на украинском языке- ro - value in Romanian
- products[i].article -
артикул товара- product article
- products[i].parent_article -
артикул родительского товара- article of the parent product
- products[i].article_for_display -
артикул модели- model article
- products[i].creation_time -
дата добавления товара- date of product addition
- products[i].title -
название товара- product name
- products[i].display_in_showcase -
отображать товар - display item (1|0)
- products[i].price -
Цена товара - Price of the product
- products[i].price_old -
Старая цена товара - Old price of the product
- products[i].discount -
относительная скидка на товар- relative discount for the product
- products[i].parent -
путь \ к \ разделу (Развивающие игрушки \ Игрушки для малышей) (обязательный параметр)- path to the \ section (Developmental Toys\ Toys for Kids) (mandatory parameter).
- products[i].brand -
название бренда- brand name
- products[i].description -
описание товара- product description
- products[i].description.
ru - значение на русском языке- product description
- en - value in English
- products[i].description.
ua - значение на украинском языке- ro - value in Romanian
- products[i].we_recommended -
мы рекомендуем - we recommend (1|0)
- products[i].icons -
Иконки - Icons (["
Распродажа- Sale", "
Новинка- Novelty", "
Хит- Hit"])
- products[i].seo_title -
СЕО заголовок для товара- SEO title for the product
- products[i].seo_title.
ru - значение на русском языке- SEO title for the product
- en - value in English
- products[i].seo_title.
ua - значение на украинском языке- ro - value in Romanian
- products[i].seo_keywords -
СЕО ключевые слова для товара- SEO keywords for the product
- products[i].seo_keywords.
ru - значение на русском языке- SEO keywords for the product
- en - value in English
- products[i].seo_keywords.
ua - значение на украинском языке- ro - value in Romanian
- products[i].seo_description -
СЕО описание для товара- SEO description for the product
- products[i].seo_description.
ru - значение на русском языке- SEO description for the product
- en - value in English
- products[i].seo_description.
ua - значение на украинском языке- ro - value in Romanian
- products[i].characteristics[] -
характеристики товара- product characteristics
- products[i].characteristics.material -
Материал- Material
- products[i].characteristics.weight -
Вес- Weight
- products[i].characteristics.consist -
Состав- Composition
- products[i].characteristics.country -
Страна- Country
- products[i].characteristics.gender -
Пол- Gender
- products[i].characteristics.age -
Возраст- Age
- products[i].characteristics.physics -
Физическое развитие (значения указывать через - Physical development (specify values with ;)
- products[i].characteristics.brain -
Умственное развитие (значения указывать через - Mental development (specify values with ;)
- products[i].characteristics.social -
Социальное развитие (значения указывать через - Social development (specify values with ;)
- products[i].images -
ссылки на изображения модификации- links to images of the modification
- products[i].gallery_common -
ссылки на общие для всех модификаций изображения- links to images common for all modifications
- products[i].gallery_360 -
ссылки на изображения галереи 360- links to 360 gallery images
- products[i].slug -
алиас товара или null если он не указан- product alias or null if it is not specified
- products[i]
.link - абсолютная ссылка с доменом на товар или null если она не указана
...
- .link - absolute link with domain to the product or null if it is not specifie
- products[i].accessories - аксессуары для товара (массив). Перезаписывают существующие аксессуары
productsaccessories for the product (array). Overwrite existing accessoriesproducts[i].accessories[n] - артикул товара простой строкойproduct article in a simple string- products[i].accessories[n].article - явное указание артикула товараexplicit product article
- products[i].accessories[n].page - путь \ к \ разделу (Развивающие игрушки \ Игрушки для малышей)the path to the \ section (Toys\Educational toys\Toys for Kids).
- products[i].accessories[n].page.id - идентификатор разделаsection identifier
- products[i].gifts - подарки для товара (массив). Сработает только если на сайте включены подарки. Перезаписывают существующие подарки
- gifts for the product (array). Will work only if gifts are enabled on the site. Overwrite existing gifts
- products[i].gifts[n] -
артикул товара простой строкой - product article in a simple string
- products[i].gifts[n].article -
явное указание артикула товара- explicit product article
- products[i].gifts[n].page -
путь \ к \ разделу (Развивающие игрушки \ Игрушки для малышей)- the path to the section (Toys\Educational toys\Toys for Kids).
- products[i].gifts[n].page.id -
идентификатор раздела- section id
- products[i].residues - остатки товара на складах. Работает только если на сайте включён учёт остатков на складахproduct residues in warehouses. It works only if the site has enabled the accounting of residues in warehouses.
- products[i].residues[n].warehouse - Название для синхронизации склада (значение свойства "Название для синхронизации" в складеName for warehouse synchronization (value of "Name for synchronization" property in warehouse)
- products[i].residues[n].quantity - количество товара на складе
- products[i].accessories - аксессуары для товара (массив). Перезаписывают существующие аксессуары
...
- quantity of goods in the warehouse
- products[i].unit_of_measurement
— значение единицы измерения- - unit value
- products[i].unit_of_measurement.id
— идентификатор значения единицы в справочнике- - unit value
- - unit value identifier in the reference book
- products[i].unit_of_measurement.
value — значение единицы измерения
Важное примечание:
...
- value - unit value
- value - unit value
Important note:
If a parameter has a value translation - it will be output in the format
"param": { "id":1, "value": {
...
"lang_abbr_
...
1" :
...
"value_
...
1",
...
"lang_abbr_
...
2" :
...
"value_
...
2"}}
- Экспортируемые параметры могут отличаться в зависимости от параметров шаблона данных конкретного товара
Пример запроса на адрес (The exported parameters may vary depending on the parameters of the product-specific data template
Query example http://<DOMAIN>/api/catalog/export/):
Пример ответа на запрос:Response example
| Code Block |
|---|
{
"status": "OK",
"response": {
"products": [
{
"parent_article": "sdgasdgsa",
"article": "sdgasdgsa",
"mod_title": {
"ruen": "dgasdgasdg",
"uaro": "dgasdgasdg"
},
"price": 150,
"price_old": 0,
"presence": {
"id": 2,
"value": {
"ruen": "НетOut вof наличииstock",
"uaro": "НемаєStoc в наявностіepuizat"
}
},
"display_in_showcase": 1,
"discount": 0,
"quantity": 0,
"short_description": {
"ruen": "",
"uaro": ""
},
"color": {
"id": 22,
"value": {
"ru"en: "ЗолотистыйGold",
"uaro": "ЗолотистийGold"
}
},
"title": {
"ruen": "MacBook Air 11.6\" 128 ГБGB",
"uaro": "MacBook Air 11.6\" 128 ГБGB"
},
"currency": {
"id": 2,
"value": ""
},
"parent": {
"id": 1124,
"value": "Mac"
},
"brand": {
"id": 0,
"value": null
},
"popularity": 0,
"description": {
"ruen": "",
"uaro": ""
},
"g_size": {
"id": 0,
"value": null
},
"seo_title": {
"ruen": "",
"uaro": ""
},
"seo_keywords": {
"ruen": "",
"uaro": ""
},
"seo_description": {
"ruen": "",
"uaro": ""
},
"h1_title": {
"ruen": "",
"uaro": ""
},
"alt_parent": [
{
"id": 1681,
"value": "development colossus cluster 86070119 \/ boob bang builder 83177342 \/ portal cake 57566500"
}
],
"icons": [
{
"id": 4,
"value": {
"ruen": "РаспродажаSale",
"uaro": "РаспродажаReducere"
}
},
{
"id": 3,
"value": {
"ruen": "НовинкаNew",
"uaro": "НовинкаNou"
}
}
],
"characteristics": {
"mod1": {
"id": 0,
"value": null
},
"mod2": {
"id": 0,
"value": null
},
"mod3": {
"id": 0,
"value": null
},
"mod4": {
"id": 0,
"value": null
},
"mod5": {
"id": 0,
"value": null
},
"mod6": {
"id": 0,
"value": null
},
"mod7": []
},
"images": [],
"gallery_common": [],
"gallery_360": []
},
{
"parent_article": "asfasgasdg",
"article": "asfasgasdg",
"mod_title": {
"ruen": "efhsdfh",
"uaro": "efhsdfh"
},
"price": 12000,
"price_old": 0,
"presence": {
"id": 2,
"value": {
"ruen": "НетOut вof наличииstock",
"uaro": "Немає в"Stoc наявностіepuizat"
}
},
"display_in_showcase": 1,
"discount": 0,
"quantity": 0,
"short_description": {
"ruen": "",
"uaro": ""
},
"color": {
"id": 0,
"value": null
},
"title": {
"ruen": "MacBook Air 13.3\" 128 ГБ",
"uaro": ""
},
"currency": {
"id": 1,
"value": ""
},
"parent": {
"id": 1124,
"value": "Mac"
},
"brand": {
"id": 0,
"value": null
},
"popularity": 0,
"description": {
"ruen": "",
"uaro": ""
},
"g_size": {
"id": 0,
"value": null
},
"seo_title": {
"ruen": "",
"uaro": ""
},
"seo_keywords": {
"ruen": "",
"uaro": ""
},
"seo_description": {
"ruen": "",
"uaro": ""
},
"h1_title": {
"ruen": "",
"uaro": ""
},
"alt_parent": [
{
"id": 1681,
"value": "development colossus cluster 86070119 \/ boob bang builder 83177342 \/ portal cake 57566500"
}
],
"icons": [],
"characteristics": {
"mod1": {
"id": 0,
"value": null
},
"mod2": {
"id": 0,
"value": null
},
"mod3": {
"id": 0,
"value": null
},
"mod4": {
"id": 0,
"value": null
},
"mod5": {
"id": 0,
"value": null
},
"mod6": {
"id": 0,
"value": null
},
"mod7": []
},
"images": [],
"gallery_common": [],
"gallery_360": []
}
]
}
} |
Пример запроса на адрес An example of a query for an address (http://<DOMAIN>/api/catalog/export/) с использованием параметра includedParams:using the includedParams parameter
| Code Block |
|---|
{
"limit" : 5,
"token":"7189d5c9f5f469e8dbfdea1c2c33698c",
"includedParams": ["price", "price_old", "title"]
} |
Пример ответа на запрос:Respionse example
| Code Block |
|---|
{
"status": "OK",
"response": {
"products": [
{
"parent_article": "2318262",
"article": "2318262",
"price": 649,
"price_old": 0,
"title": {
"ruen": "Stainless Steel Case with Milanese Loop",
"uaro": "Stainless Steel Case with Milanese Loop"
},
"parent": {
"id": 1006,
"value": "Watch"
}
},
{
"parent_article": "2317217",
"article": "2317217",
"price": 550,
"price_old": 650,
"title": {
"ruen": "Stainless Steel Case with Black Sport Band",
"uaro": "Stainless Steel Case with Black Sport Band"
},
"parent": {
"id": 1006,
"value": "Watch"
}
},
{
"parent_article": "MD827",
"article": "MD827",
"price": 599,
"price_old": 0,
"title": {
"ruen": "Apple EarPods with Remote and Mic",
"uaro": "Apple EarPods with Remote and Mic"
},
"parent": {
"id": 1008,
"value": "АксессуарыAccessories"
}
},
{
"parent_article": "MD564",
"article": "MD564",
"price": 79,
"price_old": 0,
"title": {
"ruen": "Дисковод USB SuperDrive",
"uaro": "Дисковод USB SuperDrive"
},
"parent": {
"id": 1008,
"value": "АксессуарыAccessories"
}
},
{
"parent_article": "MB829",
"article": "MB829",
"price": 69,
"price_old": 0,
"title": {
"ruen": "Magic Mouse",
"uaro": "Magic Mouse"
},
"parent": {
"id": 1032,
"value": "Аксессуары \/ Клавиатуры и мыши"
}
}
]
}
} |
Пример запроса на адрес An example of a query for an address (http://<DOMAIN>/api/catalog/export/) с использованием параметра using the excludedParams parameter:
| Code Block |
|---|
{
"token": "7189d5c9f5f469e8dbfdea1c2c33698c"
"limit": 1,
"excludedParams": ["price", "price_old", "description"]
} |
Пример ответа на запрос:Response example
| Code Block |
|---|
{
"status": "OK",
"response": {
"products": [
{
"parent_article": "2318262",
"article": "2318262",
"mod_title": {
"ruen": "",
"uaro": ""
},
"presence": {
"id": 1,
"value": {
"ruen": "ВIn наличииstock",
"uaro": "ВÎn наявностіstoc"
}
},
"display_in_showcase": 1,
"discount": 0,
"quantity": 3,
"short_description": {
"ruen": "jfhblagfue",
"uaro": ""
},
"color": {
"id": 20,
"value": {
"ruen": "ЗелёныйGreen",
"uaro": "ЗеленийVerde"
}
},
"currency": {
"id": 4,
"value": "грнEUR"
},
"title": {
"ruen": "Stainless Steel Case with Milanese Loop",
"uaro": "Stainless Steel Case with Milanese Loop"
},
"parent": {
"id": 1006,
"value": "Watch"
},
"brand": {
"id": 88,
"value": {
"ruen": "Air Jordan",
"uaro": "Air Jordan"
}
},
"popularity": 0,
"seo_title": {
"ruen": "",
"uaro": ""
},
"seo_keywords": {
"ruen": "",
"uaro": ""
},
"seo_description": {
"ruen": "",
"uaro": ""
},
"h1_title": {
"ruen": "",
"uaro": ""
},
"alt_parent": [],
"icons": [
{
"id": 3,
"value": {
"ruen": "НовинкаNew",
"uaro": "НовинкаNou"
}
}
],
"select": [],
"characteristics": {
"country": {
"ruen": "",
"uaro": ""
},
"sezon": 0,
"iq": {
"id": 0,
"value": null
}
},
"images": [
"http:\/\/my.horoshopcartum.dev\/content\/images\/36\/58113884470528.jpg",
"http:\/\/my.horoshopcartum.dev\/content\/images\/36\/22344377057419.jpg",
"http:\/\/my.horoshopcartum.dev\/content\/images\/36\/96673477606640.jpg",
"http:\/\/my.horoshopcartum.dev\/content\/images\/36\/92563395698865.jpg"
],
"gallery_common": [],
"gallery_360": [],
"slug": "stainless-steel-case-with-milanese-loop\/69",
"link": "http:\/\/my.horoshopcartum.dev\/stainless-steel-case-with-milanese-loop\/69\/"
}
]
}
} |
Пример запроса на адрес Example of a query for an address (http://<DOMAIN>/api/catalog/export/) с использованием параметров includedParams и excludedParamsusing the includedParams and excludedParams parameters:
| Code Block |
|---|
{
"limit" : 1,
"includedParams": ["price", "title", "color"],
"excludedParams": ["price", "price_old", "description"]
} |
Пример ответа на запрос:Response example
| Code Block |
|---|
{
"status": "OK",
"response": {
"products": [
{
"parent_article": "2318262",
"article": "2318262",
"color": {
"id": 20,
"value": {
"ruen": "ЗелёныйGreen",
"uaro": "ЗеленийVerde"
}
},
"title": {
"ruen": "Stainless Steel Case with Milanese Loop",
"uaro": "Stainless Steel Case with Milanese Loop"
},
"parent": {
"id": 1006,
"value": "Watch"
}
}
]
}
} |
...