Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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-й

Ответ:

...

status - статус выполнения функции

  • OK - экспорт прошел успешно

  • EXCEPTION - произошла ошибка

...

products - экспортируемые товары

...

products[i].article - артикул товара

...

products[i].parent_article - артикул родительского товара


...

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].display_in_showcase - отображать товар (1|0)article - артикул товара

    • products[i].parent - путь \ к \ разделу (Развивающие игрушки \ Игрушки для малышей) (обязательный параметр)products[i].brand - название бренда_article - артикул родительского товара

    • products[i].article_for_display - артикул модели
    • products[i].description - описание creation_time - дата добавления товара
    • products[i].

    • description.ru - значение на русском языке
    • title - название товара

    • products[i].
  • description.ua - значение на украинском языкеproducts[i].we_recommended - мы рекомендуем
    • display_in_showcase - отображать товар (1|0)
    • products[i].
  • icons - Иконки (["Распродажа", "Новинка", "Хит"])
    • price - Цена товара 
    • products[i].
  • seo
    • price_
  • title - СЕО заголовок для товара
    • old - Старая цена товара 
    • products[i].

  • seo_title.ru - значение на русском языке
    • discount - относительная скидка на товар

    • products[i].
  • seo_title.ua - значение на украинском языкеproducts[i].seo_keywords - СЕО ключевые слова для товара
    • parent - путь \ к \ разделу (Развивающие игрушки \ Игрушки для малышей) (обязательный параметр)
    • products[i].

  • seo_keywords.ru - значение на русском языке
    • brand - название бренда

    • products[i].

  • seo_keywords.ua - значение на украинском языкеproducts[i].seo_
    • description -

  • СЕО
    • описание

  • для
    • товара

      • products[i].

  • seo_
      • description.ru - значение на русском языке

      • products[i].

  • seo_
      • description.ua - значение на украинском языке

    • products[i].

  • characteristics[] - характеристики товара
    • we_recommended - мы рекомендуем (1|0)

    • products[i].

  • characteristics.material - Материал
    • icons - Иконки (["Распродажа", "Новинка", "Хит"])

    • products[i].

  • characteristics.weight - Вес
    • seo_title - СЕО заголовок для товара

      • products[i].

  • characteristics
      • seo_title.

  • consist - Состав
      • ru - значение на русском языке

      • products[i].

  • characteristics
      • seo_title.

  • country - Страна
      • ua - значение на украинском языке

    • products[i].

  • characteristics.gender - Пол
    • seo_keywords - СЕО ключевые слова для товара

      • products[i].

  • characteristics
      • seo_keywords.

  • age - Возраст
      • ru - значение на русском языке

      • products[i].

  • characteristics
      • seo_keywords.

  • physics - Физическое развитие (значения указывать через ;)
      • ua - значение на украинском языке

    • products[i].seo_description - СЕО описание для товара

      • products[i].

  • characteristics
      • seo_description.

  • brain - Умственное развитие (значения указывать через ;)
      • ru - значение на русском языке

      • products[i].

  • characteristics
      • seo_description.

  • social - Социальное развитие (значения указывать через ;)
      • ua - значение на украинском языке

    • products[i].

  • images - ссылки на изображения модификации
    • characteristics[] - характеристики товара

      • products[i].

  • gallery_common - ссылки на общие для всех модификаций изображения
      • characteristics.material - Материал

      • products[i].

  • gallery_360 - ссылки на изображения галереи 360
      • characteristics.weight - Вес

      • products[i].characteristics.

  • slug - алиас товара или null если он не указан (будет доступно в версии Хорошоп 3.8.0)
      • consist - Состав

      • products[i].characteristics.country - Страна

      • products[i].characteristics.gender - Пол

      • products[i].

  • link - абсолютная ссылка с доменом на товар или null если она не указан (будет доступно в версии Хорошоп 3.8.0)

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

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

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

...

      • 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



  • 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/): 


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


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

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

...

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

Code Block
{"
                },
          "status": "OK",     "responseseo_description": {
        "products": [           "ru": "",
   {                 "parent_articleua": "sdgasdgsa",
                "article": "sdgasdgsa"},
                "modh1_title": {
                    "ru": "dgasdgasdg",
                    "ua": "dgasdgasdg"
                },
                "pricealt_parent": 150, [
                    {
      "price_old": 0,                 "presenceid": 1681,
   {                     "idvalue": 2,"development colossus cluster 86070119 \/ boob bang builder 83177342 \/ portal cake 57566500"
        "value": {           }
             "ru": "Нет в наличии"],
                "icons": [],
      "ua": "Немає в наявності"       "characteristics": {
            }        "mod1": {
       },                 "display_in_showcaseid": 10,
                "discount        "value": null
 0,                  "quantity": 0},
                    "short_descriptionmod2": {
                        "ruid": "",0,
                        "ua": ""value": null
                    },
                    "colormod3": {
                        "id": 220,
                        "value": null
     {               },
         "ru": "Золотистый",           "mod4": {
               "ua": "Золотистий"        "id": 0,
           }             "value": null
  },                 "title": { },
                    "rumod5": "MacBook{
Air 11.6\" 128 ГБ",                     "uaid": 0,
 "MacBook Air 11.6\"  128 ГБ"                 }, "value": null
              "currency": {     },
               "id": 2,    "mod6": {
               "value": ""        "id": 0,
       },                 "parentvalue": {null
                    "id": 1124},
                    "valuemod7": "Mac"[]
                },
                "brandimages": { [],
                "gallery_common": [],
                "id": 0,
gallery_360": []
            }
      "value": null ]
    }
}


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


Code Block
{
       "limit" : }5,
       "token":"7189d5c9f5f469e8dbfdea1c2c33698c",
	        "popularityincludedParams": 0["price", "price_old", "title"]
}


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

Code Block
{
        "status": "OK",
    "descriptionresponse": {
        "products": [
          "ru": "",
    {
                "uaparent_article": "2318262",
                }"article": "2318262",
                "g_sizeprice": {
   649,
                "idprice_old": 0,
                    "valuetitle": null{
                },    "ru": "Stainless Steel Case with Milanese Loop",
      "seo_title": {             "ua": "Stainless Steel Case with    "ru": "",Milanese Loop"
                },
   "ua": ""            "parent": {
   },                 "seo_keywordsid": {1006,
                    "ruvalue": "Watch",
                }
     "ua": ""       },
           }, {
                "seoparent_descriptionarticle": {
 "2317217",
                  "ruarticle": "2317217",
  
                 "uaprice": 550,
""                 }"price_old": 650,
                "h1_title": {
                    "ru": "",Stainless Steel Case with Black           Sport Band",
     "ua": ""              "ua": "Stainless Steel },Case with Black Sport Band"
            "alt_parent": [   },
                "parent": {
 
                      "id": 16811006,
   
                    "value": "Watch"development
colossus cluster 86070119 \/ boob bang builder 83177342 \/ portal cake 57566500"     }
               },
                ],{
                "iconsparent_article": ["MD827",
                    {
       "article": "MD827",
                "idprice": 4599,
                "price_old": 0,
       "value":  {       "title": {
                    "ru": "Распродажа",Apple EarPods with Remote     and Mic",
                    "ua": "РаспродажаApple EarPods with Remote and Mic"
                },
       }         "parent": {
           },         "id": 1008,
              {      "value": "Аксессуары"
                }
   "id": 3,        },
            {
   "value": {            "parent_article": "MD564",
                "ruarticle": "НовинкаMD564",
                "price": 79,
                "uaprice_old": "Новинка"0,
                "title": {
      }              "ru": "Дисковод USB SuperDrive",
   }                 ],
   "ua": "Дисковод USB SuperDrive"
            "characteristics": {    },
                "mod1parent": {
   
                    "id": 01008,
                    "value": "Аксессуары"
       "value": null        }
            },
            {
       "mod2": {        "parent_article": "MB829",
                "idarticle": 0"MB829",
                "price": 69,
      "value": null          "price_old": 0,
                "title": {
     },               "ru": "Magic Mouse",
   "mod3": {                "ua": "Magic Mouse"
       "id": 0,        },
                "valueparent": {
null                    "id": }1032,
                    "mod4value": {"Аксессуары \/ Клавиатуры и мыши"
                }
   "id": 0,        }
        ]
    }
  "value}


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

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

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

Code Block
{
    "status": "OK",
    "response": {
        "mod5products": {[
               {
        "id": 0,       "parent_article": "2318262",
                "valuearticle": null"2318262",
                "mod_title": {
  },                  "ru": "",
  "mod6":  {                "ua": ""
       "id": 0,        },
                "valuepresence": {
null                    "id": }1,
                    "mod7value": []{
                },        "ru":  наличии",
      "images": [],                 "gallery_commonua": [],
"В наявності"
               "gallery_360": []    }
        },             {},
                "parentdisplay_in_articleshowcase": "asfasgasdg"1,
                "articlediscount": "asfasgasdg"0,
                "mod_titlequantity": {
 3,
                  "rushort_description": "efhsdfh",{
                    "uaru": "efhsdfh"
           jfhblagfue",
    },                 "priceua": 12000,""
                "price_old": 0},
                "presencecolor": {
                    "id": 220,
                    "value": {
                        "ru": "Нет в наличииЗелёный",
                        "ua": "Немає в наявностіЗелений"
                    }
                },
                "display_in_showcasecurrency": {
   1,                 "discountid": 04,
                    "quantityvalue": 0 "грн"
                },
                "short_descriptiontitle": {
                    "ru": "Stainless Steel Case with "ru":Milanese Loop"",
                    "ua": "Stainless Steel Case with Milanese Loop"
                },
                "colorparent": {
                    "id": 01006,
                    "value": null"Watch"
                },
                "titlebrand": {
                    "ruid": "MacBook88,
 Air 13.3\" 128 ГБ",                "value": {
   "ua": ""                     },"ru": "Air Jordan",
                   "currency":  {   "ua": "Air Jordan"
               "id": 1,    }
                "value": ""},
                "popularity": }0,
                "parentseo_title": {
                    "idru": 1124"",
                    "valueua": "Mac"
                },
                "brandseo_keywords": {
                    "idru": 0"",
                    "valueua": null""
                },
                "popularityseo_description": {
   0,                 "descriptionru": {"",
                    "ruua": "",
                },
   "ua": ""            "h1_title": {
   },                 "g_sizeru": {"",
                    "idua": 0,""
                  },
 "value": null                 }"alt_parent": [],
                "seo_titleicons": {[
                    {
  "ru": "",                     "uaid": ""3,
                },        "value": {
       "seo_keywords": {                     "ru": "Новинка",
                            "ua": "Новинка"
                },        }
        "seo_description": {           }
         "ru": "",      ],
                "uaselect": "" [],
                "characteristics": {
   },                 "h1_titlecountry": {
                        "ru": "",
                        "ua": ""
                    },
                "alt_parent    "sezon": 0,
[                    "iq": {
                        "id": 16810,
                        "value": "development colossus cluster 86070119 \/ boob bang builder 83177342 \/ portal cake 57566500"null
                    }
                },
                ],"images": [
                    "icons": [],http:\/\/my.horoshop.dev\/content\/images\/36\/58113884470528.jpg",
                    "characteristics": {http:\/\/my.horoshop.dev\/content\/images\/36\/22344377057419.jpg",
                     "mod1": {"http:\/\/my.horoshop.dev\/content\/images\/36\/96673477606640.jpg",
                         "id": 0,
      "http:\/\/my.horoshop.dev\/content\/images\/36\/92563395698865.jpg"
                ],
"value": null                     },
 "gallery_common": [],
                  "mod2gallery_360": {[],
                        "id"slug": 0,"stainless-steel-case-with-milanese-loop\/69",
                "link": "http:\/\/my.horoshop.dev\/stainless-steel-case-with-milanese-loop\/69\/"
        "value": null   }
        ]
    }
   },}


Пример запроса на адрес (http://<DOMAIN>/api/catalog/export/) с использованием параметров includedParams и excludedParams:

Code Block
{
    "limit" : 1,
    "includedParams": ["price",   "title", "color"],
    "mod3excludedParams": {
  ["price", "price_old", "description"]
}

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

Code Block
{
    "status": "OK",
    "response": {
         "idproducts": 0,[
              {
         "value": null      "parent_article": "2318262",
             },   "article": "2318262",
                "mod4color": {
                        "id": 020,
                        "value": null{
                    },                     "mod5"ru": {"Зелёный",
                        "idua": 0,
        "Зелений"
                "value": null    }
                },

                   "mod6title": {
   
                    "idru": "Stainless 0,Steel Case with Milanese Loop",
                    "valueua": null"Stainless Steel Case with Milanese Loop"
                },
 
                  "mod7parent": []{
                },    "id": 1006,
           "images": [],
                "gallery_common"value": [],"Watch"
                "gallery_360": []}
            }
        ]
    }
}