Экспорт товаров

Owned by Andrey Telesh (Unlicensed)
Last updated: 2022 Jan 10 by Artem Bruhal
34 min read

Функция 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-й


Параметры ниже доступны с версии 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 если она не указана

Новые параметры начиная с версии 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 - количество товара на складе

Доступно с версии Хорошоп 4



  • products[i].unit_of_measurement — значение единицы измерения
    • products[i].unit_of_measurement.id — идентификатор значения единицы в справочнике
    • products[i].unit_of_measurement.value — значение единицы измерения


Важное примечание:

    1. Если у параметра есть перевод значения - оно будет выведено в формате
      “param”: {"id":1, "value": {“lang_abbr_1” : “value_1”, “lang_abbr_2” : “value_2”}}

  1. Экспортируемые параметры могут отличаться в зависимости от параметров шаблона данных конкретного товара


Пример запроса на адрес (http://<DOMAIN>/api/catalog/export/): 


{
       "expr" : {
           "parent":"Mac",
           "article": ["sdgasdgsa", "asfasgasdg"]
       },
       "limit" : 5,
       "token":"7189d5c9f5f469e8dbfdea1c2c33698c"
}

Пример ответа на запрос:

{
    "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: 


{
       "limit" : 5,
       "token":"7189d5c9f5f469e8dbfdea1c2c33698c",
	   "includedParams": ["price", "price_old", "title"]
}

Пример ответа на запрос:

{
    "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: 

{
	"token": "7189d5c9f5f469e8dbfdea1c2c33698c"
    "limit": 1,
    "excludedParams": ["price", "price_old", "description"]
}

Пример ответа на запрос:

{
    "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:

{
    "limit" : 1,
    "includedParams": ["price", "title", "color"],
    "excludedParams": ["price", "price_old", "description"]
}

Пример ответа на запрос:

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