Skip to main content

/api/lite/collections

Получение списка коллекций

/api/lite/collections

Возвращает список всех коллекций.

Товары группируются по коллекциям для отображения в каталоге товаров в интернет-магазине.

 

Фильтры:

/api/lite/collections?id=1000 – возвращает информацию только по выбранной коллекции с указанным id

Поля возвращаемого значения

Параметр Тип\формат Описание
collections array Массив коллекций
id string Идентификатор коллекции
title string Заголовок коллекции
description string Описание коллекции (html)
surl string Семантическое наименование ссылки (friendly URL) на коллекцию
parentId string Идентификатор родительской коллекции
type string Тип коллекции (CATALOG/PRODUCT)

isAllProducts

 boolean Является коллекцией Все продукты
fillType enum "MANUAL", "AUTO". Тип заполнения коллекции продуктами
defaultImage string Ссылка на изображение коллекции
productCount integer Количество продуктов (не удаленных) в коллекции (readonly)
includedInCatalog boolean Входит в активный каталог-меню сайта  (readonly)
breadcrumbs array Хлебные крошки с путем от корневой коллекции до заданной (только при фильтре по id)
products array Массив продуктов, входящих в коллекцию 
filters array Массив фильтров коллекции

 

Пример ответа:

{
    "success": true,
    "collections": [
        {
            "id": "1029",
            "title": "Зерновой кофе",
            "description": "<P>Лучший <B>зерновой</B> кофе</P>",
            "surl": "zernovoy_coffee",
            "parentId": "123",
            "type": "PRODUCT",
            "defaultImage":"http://address.ru/123.jpg",
            "breadcrumbs":[
                {"id": "1", "title": "Все товары", "level":0},
                {"id": "1023", "title": "Кофе", "level":1},
                {"id": "1029", "title": "Зерновой кофе", "level":2}
            ],
            "products": [
              {
                "id": "1000",
                "extId": null,
                "shortName": "Кактус Эуфобия Триангуларис",
                "description": null,
                "available": null,
                "deleted": null,
                "brandName": null,
                "countryOfOrigin": null,
                "tnvedCode": null,
                "internationalDescription": null,
                "isBestseller": null,
                "isNovelty": null,
                "type": null,
                "vat": null,
                "options": null,
                "images": null,
                "variants": null,
                "collections": null,
                "attributes": null,
                "collectionPos": "100.000000000000000"
              }
            ]
            "fillType":"AUTO", 
            "isAllProducts": false,    
            "productCount": 15,
            "includedInCatalog": true,
            "logicMode":"AND",
            "filters":[
                {"num":1, "filterType":"BRAND_NAME", "compareOperation":"CONTAINS", "compareValue":"Samsung"}
            ]
        }
    ]
}

 

Создание/обновление коллекции

/api/lite/collections

Создает или обновляет коллекцию.

Если id указан - проводится обновление коллекции с указанным id, если не указан - создается новая коллекция.

 

Пример обновления коллекции:

{
    "id":"1029",
    "title": "Зерновой кофе",
    "description": "<P>Лучший <B>зерновой</B> кофе</P>",
    "surl": "zernovoy_coffee",
    "parentId" : "123",
    "defaultImage":"http://address.ru/123.jpg",
    "type": "PRODUCT",
    "fillType":"MANUAL", 
     "products": [
       {
       "id": "1000",
       "extId": null,
       "shortName": "Кактус Эуфобия Триангуларис",
       "description": null,
       "available": null,
       "deleted": null,
       "brandName": null,
       "countryOfOrigin": null,
       "tnvedCode": null,
       "internationalDescription": null,
       "isBestseller": null,
       "isNovelty": null,
       "type": null,
       "vat": null,
       "options": null,
       "images": null,
       "variants": null,
       "collections": null,
       "attributes": null,
       "collectionPos": "100.000000000000000"
       }
     ]
    "logicMode":"AND",
    "filters":[
        {"num":1, "filterType":"BRAND_NAME", "compareOperation":"CONTAINS", "compareValue":"Samsung"}
    ]
}

Удаление коллекции

/api/lite/collections

Для удаления коллекции, выполняется следующий DELETE запрос с указанием идентификатора коллекции в параметре id.

В ответ возвращается результат операции и id удаленной коллекции.

Продукты, входившие в удаляемую коллекцию - более не будут входить в нее.

Дочерние коллекции у удаляемой - тоже удаляются, как и привязки их к товарам.


Пример успешного ответа 

{
  "success": true,
  "id": "6F9619FF-8B86-D011-B42D-00CF4FC964FF"
}

 

В случае ошибки:

{
  "success": false,
  "errors": [
    {
      "code": 0,
      "message": "Картинки с указанным id не существует"
    }
  ]
}
Наверх