Функція catalog/export (http://<DOMAIN>/api/catalog/export/)
Параметри:
- token - ключ авторизації отриманий через функцію auth
- expr - умова вибірки товарів
- parent - шлях \ до \ розділу (Розвиваючі іграшки \ Іграшки для малюків) АБО
- parent.id - ідентифікатор розділу для вибірки (або ідентифікатори parent: {"id": [1,2,3,4]})
- display_in_showcase - 0 або 1 для вибірки товарів, які включені
- ПОЧИНАЮЧИ З ВЕРСІЇ 3.21.1
- article - вибірка товарів за артикулом (рядок або масив, наприклад: ['SKU-1-BLACK', 'MF-2010']). Не обов'язковий параметр
- offset - зміщення щодо початку вибірки товарів
- limit - кількість експортованих товарів (за замовчуванням 500 записів, понад 500 записів вивантажити неможливо, щоб уникнути перевантаження сервера). Працює спільно з параметром offset. Наприклад: offset=20&limit=10 - виведе товари з 20-го по 30-й
| Info | ||
|---|---|---|
| ||
Параметри нижче доступні з версії 3.15.11 |
- includedParams - список полів, які необхідно вибрати (будуть обрані тільки зазначені Вами і основні: parent_article, article, parent). див. приклад нижче
- excludedParams - список полів, які необхідно виключити з експорту (також виключаються поля, які вказані в includedParams, якщо цей параметр заповнений). див. приклад нижче
Відповідь:
- status - статус виконання функції
- OK - експорт пройшов успішно
- EXCEPTION - сталася помилка
- products - експортовані товари
- products[i].title.ru - значення російською мовою
- products[i].title.ua - значення українською мовою
- products[i].article - артикул товару
- products[i].parent_article - артикул батьківського товару
- products[i].article_for_display - артикул моделі
- products[i].creation_time - дата додавання товару
- products[i].title - назва товару
- products[i].display_in_showcase - відображати товар (1|0)
- products[i].price - Ціна товару
- products[i].price_old - Стара ціна товару
- products[i].discount - відносна знижка на товар
- products[i].parent - шлях\до\розділу (Розвиваючі іграшки\Іграшки для малюків) (обов'язковий параметр)
- products[i].brand - назва бренду
- products[i].description - опис товару
- products[i].description.ru - значення російською мовою
- products[i].description.ua - значення українською мовою
- products[i].we_recommended - ми рекомендуємо (1|0)
- products[i].icons - Іконки (["Розпродаж", "Новинка", "Хіт"])
- products[i].seo_title - СЕО заголовок для товару
- products[i].seo_title.ru - значення російською мовою
- products[i].seo_title.ua - значення українською мовою
- products[i].seo_keywords - СЕО ключові слова для товару
- products[i].seo_keywords.ru - значення російською мовою
- products[i].seo_keywords.ua - значення українською мовою
- products[i].seo_description - СЕО опис для товару
- products[i].seo_description.ru - значення російською мовою
- products[i].seo_description.ua - значення українською мовою
- products[i].characteristics[] - характеристики товару
- products[i].characteristics.material - Матеріал
- products[i].characteristics.weight - Вага
- products[i].characteristics.consist - Склад
- products[i].characteristics.country - Країна
- products[i].characteristics.gender - Стать
- products[i].characteristics.age - Вік
- products[i].characteristics.physics - Фізичний розвиток (значення вказувати через ;)
- products[i].characteristics.brain - Розумовий розвиток (значення вказувати через ;)
- products[i].characteristics.social - Соціальний розвиток (значення вказувати через ;)
- products[i].images - посилання на зображення модифікації
- products[i].gallery_common - посилання на загальні для всіх модифікацій зображення
- products[i].gallery_360 - посилання на зображення галереї 360
- products[i].slug - аліас товару або null, якщо він не вказаний
- products[i].link - абсолютне посилання з доменом на товар або null якщо його не вказано
| Info | ||
|---|---|---|
| ||
Нові параметри з версії 3.15.15 |
- products[i].accessories - аксесуари для товару (масив). Перезаписують наявні аксесуари
- products[i].accessories[n] - артикул товару простим рядком
- products[i].accessories[n].article - явна вказівка артикулу товару
- products[i].accessories[n].page - шлях \ до \ розділу (Розвиваючі іграшки \ Іграшки для малюків)
- products[i].accessories[n].page.id - ідентифікатор розділу
- products[i].gifts - подарунки для товару (масив). Спрацює тільки якщо на сайті ввімкнено подарунки. Перезаписують наявні подарунки
- products[i].gifts[n] - артикул товару простим рядком
- products[i].gifts[n].article - явна вказівка артикулу товару
- products[i].gifts[n].page - шлях \ до \ розділу (Розвиваючі іграшки \ Іграшки для малюків)
- products[i].gifts[n].page.id - ідентифікатор розділу
- products[i].residues - залишки товару на складах. Працює тільки якщо на сайті ввімкнено облік залишків на складах
- products[i].residues[n].warehouse - Назва для синхронізації складу (значення властивості "Назва для синхронізації" у складі)
- products[i].residues[n].quantity - кількість товару на складі
| Info | ||
|---|---|---|
| ||
Доступно починаючи з Хорошоп 4.0 |
- products[i].unit_of_measurement - значення одиниці виміру
- products[i].unit_of_measurement.id - ідентифікатор значення одиниці в довіднику
- products[i].unit_of_measurement.value - значення одиниці виміру
Важлива примітка:
Якщо у параметра є переклад значення - воно буде виведено у форматі "param": {"id":1, "value": {"lang_abbr_1" : "value_1", "lang_abbr_2" : "value_2"}}
Експортовані параметри можуть відрізнятися залежно від параметрів шаблону даних конкретного товару
Приклад запиту на адресу (http://<DOMAIN>/api/catalog/export/):
Приклад відповіді на запит
| Code Block |
|---|
{
"status": "OK",
"response": {
"products": [
{
"parent_article": "sdgasdgsa",
"article": "sdgasdgsa",
"mod_title": {
"ru": "dgasdgasdg",
"ua": "dgasdgasdg"
},
"price": 150,
"price_old": 0,
"presence": {
"id": 2,
"value": {
"ru": "Нет в наличии",
"ua": "Немає в наявності"
}
},
"display_in_showcase": 1,
"discount": 0,
"quantity": 0,
"short_description": {
"ru": "",
"ua": ""
},
"color": {
"id": 22,
"value": {
"ru": "Золотистый",
"ua": "Золотистий"
}
},
"title": {
"ru": "MacBook Air 11.6\" 128 ГБ",
"ua": "MacBook Air 11.6\" 128 ГБ"
},
"currency": {
"id": 2,
"value": ""
},
"parent": {
"id": 1124,
"value": "Mac"
},
"brand": {
"id": 0,
"value": null
},
"popularity": 0,
"description": {
"ru": "",
"ua": ""
},
"g_size": {
"id": 0,
"value": null
},
"seo_title": {
"ru": "",
"ua": ""
},
"seo_keywords": {
"ru": "",
"ua": ""
},
"seo_description": {
"ru": "",
"ua": ""
},
"h1_title": {
"ru": "",
"ua": ""
},
"alt_parent": [
{
"id": 1681,
"value": "development colossus cluster 86070119 \/ boob bang builder 83177342 \/ portal cake 57566500"
}
],
"icons": [
{
"id": 4,
"value": {
"ru": "Распродажа",
"ua": "Распродажа"
}
},
{
"id": 3,
"value": {
"ru": "Новинка",
"ua": "Новинка"
}
}
],
"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": {
"ru": "efhsdfh",
"ua": "efhsdfh"
},
"price": 12000,
"price_old": 0,
"presence": {
"id": 2,
"value": {
"ru": "Нет в наличии",
"ua": "Немає в наявності"
}
},
"display_in_showcase": 1,
"discount": 0,
"quantity": 0,
"short_description": {
"ru": "",
"ua": ""
},
"color": {
"id": 0,
"value": null
},
"title": {
"ru": "MacBook Air 13.3\" 128 ГБ",
"ua": ""
},
"currency": {
"id": 1,
"value": ""
},
"parent": {
"id": 1124,
"value": "Mac"
},
"brand": {
"id": 0,
"value": null
},
"popularity": 0,
"description": {
"ru": "",
"ua": ""
},
"g_size": {
"id": 0,
"value": null
},
"seo_title": {
"ru": "",
"ua": ""
},
"seo_keywords": {
"ru": "",
"ua": ""
},
"seo_description": {
"ru": "",
"ua": ""
},
"h1_title": {
"ru": "",
"ua": ""
},
"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": []
}
]
}
} |
Приклад запиту на адресу (http://<DOMAIN>/api/catalog/export/) звикористанням параметру includedParams:
| Code Block |
|---|
{
"limit" : 5,
"token":"7189d5c9f5f469e8dbfdea1c2c33698c",
"includedParams": ["price", "price_old", "title"]
} |
Приклад відповіді на запит
| Code Block |
|---|
{
"status": "OK",
"response": {
"products": [
{
"parent_article": "2318262",
"article": "2318262",
"price": 649,
"price_old": 0,
"title": {
"ru": "Stainless Steel Case with Milanese Loop",
"ua": "Stainless Steel Case with Milanese Loop"
},
"parent": {
"id": 1006,
"value": "Watch"
}
},
{
"parent_article": "2317217",
"article": "2317217",
"price": 550,
"price_old": 650,
"title": {
"ru": "Stainless Steel Case with Black Sport Band",
"ua": "Stainless Steel Case with Black Sport Band"
},
"parent": {
"id": 1006,
"value": "Watch"
}
},
{
"parent_article": "MD827",
"article": "MD827",
"price": 599,
"price_old": 0,
"title": {
"ru": "Apple EarPods with Remote and Mic",
"ua": "Apple EarPods with Remote and Mic"
},
"parent": {
"id": 1008,
"value": "Аксессуары"
}
},
{
"parent_article": "MD564",
"article": "MD564",
"price": 79,
"price_old": 0,
"title": {
"ru": "Дисковод USB SuperDrive",
"ua": "Дисковод USB SuperDrive"
},
"parent": {
"id": 1008,
"value": "Аксессуары"
}
},
{
"parent_article": "MB829",
"article": "MB829",
"price": 69,
"price_old": 0,
"title": {
"ru": "Magic Mouse",
"ua": "Magic Mouse"
},
"parent": {
"id": 1032,
"value": "Аксессуары \/ Клавиатуры и мыши"
}
}
]
}
} |
Приклад запиту на адресу (http://<DOMAIN>/api/catalog/export/) з використання параметру excludedParams:
| Code Block |
|---|
{
"token": "7189d5c9f5f469e8dbfdea1c2c33698c"
"limit": 1,
"excludedParams": ["price", "price_old", "description"]
} |
Приклад відповіді на запит
| Code Block |
|---|
{
"status": "OK",
"response": {
"products": [
{
"parent_article": "2318262",
"article": "2318262",
"mod_title": {
"ru": "",
"ua": ""
},
"presence": {
"id": 1,
"value": {
"ru": "В наличии",
"ua": "В наявності"
}
},
"display_in_showcase": 1,
"discount": 0,
"quantity": 3,
"short_description": {
"ru": "jfhblagfue",
"ua": ""
},
"color": {
"id": 20,
"value": {
"ru": "Зелёный",
"ua": "Зелений"
}
},
"currency": {
"id": 4,
"value": "грн"
},
"title": {
"ru": "Stainless Steel Case with Milanese Loop",
"ua": "Stainless Steel Case with Milanese Loop"
},
"parent": {
"id": 1006,
"value": "Watch"
},
"brand": {
"id": 88,
"value": {
"ru": "Air Jordan",
"ua": "Air Jordan"
}
},
"popularity": 0,
"seo_title": {
"ru": "",
"ua": ""
},
"seo_keywords": {
"ru": "",
"ua": ""
},
"seo_description": {
"ru": "",
"ua": ""
},
"h1_title": {
"ru": "",
"ua": ""
},
"alt_parent": [],
"icons": [
{
"id": 3,
"value": {
"ru": "Новинка",
"ua": "Новинка"
}
}
],
"select": [],
"characteristics": {
"country": {
"ru": "",
"ua": ""
},
"sezon": 0,
"iq": {
"id": 0,
"value": null
}
},
"images": [
"http:\/\/my.horoshop.dev\/content\/images\/36\/58113884470528.jpg",
"http:\/\/my.horoshop.dev\/content\/images\/36\/22344377057419.jpg",
"http:\/\/my.horoshop.dev\/content\/images\/36\/96673477606640.jpg",
"http:\/\/my.horoshop.dev\/content\/images\/36\/92563395698865.jpg"
],
"gallery_common": [],
"gallery_360": [],
"slug": "stainless-steel-case-with-milanese-loop\/69",
"link": "http:\/\/my.horoshop.dev\/stainless-steel-case-with-milanese-loop\/69\/"
}
]
}
} |
Приклад запиту на адресу (http://<DOMAIN>/api/catalog/export/) з використанням параметру includedParams та excludedParams:
| Code Block |
|---|
{
"limit" : 1,
"includedParams": ["price", "title", "color"],
"excludedParams": ["price", "price_old", "description"]
} |
Приклад відповіді на запит
| Code Block |
|---|
{
"status": "OK",
"response": {
"products": [
{
"parent_article": "2318262",
"article": "2318262",
"color": {
"id": 20,
"value": {
"ru": "Зелёный",
"ua": "Зелений"
}
},
"title": {
"ru": "Stainless Steel Case with Milanese Loop",
"ua": "Stainless Steel Case with Milanese Loop"
},
"parent": {
"id": 1006,
"value": "Watch"
}
}
]
}
} |