Функция Функція catalog/export (http://<DOMAIN>/api/catalog/export/)
ПараметрыПараметри:
- token - ключ авторизации полученный
- авторизації отриманий через функцию
- функцію auth
- expr - условие выборки товаров
- умова вибірки товарів
- parent -
путь - шлях \
к - до \
разделу - розділу (
Развивающие игрушки - Розвиваючі іграшки \
Игрушки - Іграшки для
малышей- малюків)
ИЛИ- АБО
- parent.id -
идентификатор раздела - ідентифікатор розділу для
выборки - вибірки (
или идентификаторы - або ідентифікатори parent: {
“id”- "id": [1,2,3,4]})
- display_in_showcase - 0
или - або 1 для
выборки товаров которые включеныНАЧИНАЯ С ВЕРСИИ - вибірки товарів, які включені
- ПОЧИНАЮЧИ З ВЕРСІЇ 3.21.1
- article -
выборка товаров по артикулу (строка или массив, например- вибірка товарів за артикулом (рядок або масив, наприклад: ['SKU-1-BLACK', 'MF-2010']). Не
обязательный - обов'язковий параметр
- offset - смещение относительно начала выборки товаров
- зміщення щодо початку вибірки товарів
- limit - количество экспортируемых товаров (по умолчанию 500 записей, более 500 записей выгрузить невозможно во избежание перегрузки сервера). Работает совместно с параметром offset. Например
- кількість експортованих товарів (за замовчуванням 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 если он не указан- аліас товару або 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 и з використанням параметру 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"
}
}
]
}
} |
...