Документация »

products


URL
http://api.brain.com.ua/products/categoryID/SID [?vendorID=vendorID] [&search=search] [&filterID=filterID] [&filters[]=filterID] [&limit=limit] [&offset=offset] [&sortby=field_name] [&order=order] [&lang=lang]

HTTP Метод
GET

Описание
Метод для получения списка товаров указанной категории и всех ее дочерних категорий

Параметры
Название параметра Обязательный параметр Описание
categoryID да идентификатор категории
SID да идентификатор сессии
lang нет язык, возможные значения - ua и ru
по умолчанию ua
vendorID нет идентификатор производителя
search нет строка поиска
filterID нет идентификатор фильтра
filters[] нет массив идентификаторов фильтров
limit нет количество возвращаемых товаров
для пользователей без статуса OWN_MODE: максимальное значение - 100, значение по умолчанию - 100;
для пользователей со статусом OWN_MODE: максимальное значение - 1000, значение по умолчанию - 1000
offset нет смещение (количество товаров, пропускаемых перед выводом результатов; по умолчанию - 0)
sortby нет параметр, по которому производится сортировка товаров
([name|brief_description|productID|product_code|warranty|is_archive|vendorID|articul|volume|is_new|categoryID],
по умолчанию - productID)
order нет порядок сортировки ([asc|desc], по умолчанию - asc)

Для фильтрации товаров можно использовать как одиночный фильтр filterID, так и массив фильтров filters[].Если указаны оба параметра, они будут использованы как общий массив фильтров.

Строка поиска может быть двух видов:

1) строка текста - поиск производится по строке целиком. Пример:
    Запрос:
    http://api.brain.com.ua/products/125/gpkavk4s0aciujg6m698gev040?search=apple macbook pro

    SQL:
    SELECT * FROM `products`
    WHERE `category_id`='125' AND
    `search_field_ru` LIKE '%apple macbook pro%'

2) строка JSON - поисковый запрос формируется из параметров, переданных в строке. Пример:
    Запрос:
    http://api.brain.com.ua/products/125/gpkavk4s0aciujg6m698gev040?lang=ua&search={"and":["appl",{"or":["pro","mini","i7"]}]}

    SQL:
    SELECT * FROM `products`
    WHERE `category_id`='125' AND
    `search_field_ua` LIKE '%appl%' AND (`search_field_ua` LIKE '%pro%' OR `search_field_ua` LIKE '%mini%' OR `search_field_ua` LIKE '%i7%')


Результат
Метод возвращает список товаров указанной категории.

Если в запросе присутствуют необязательные параметры, то список товаров фильтруется в соответствии с ними.

Значения stocks, stocks_expected и available возвращаются только для пользователей со статусом OWN_LOGISTICS_MODE.

Параметр "count" результата показывает количество товаров без учета значений параметров offset и limit.

Пример
    Запрос:
    http://api.brain.com.ua/products/155/gpkavk4s0aciujg6m698gev040

    Ответ:
    {
    "status":1,
    "result":
        {
        "list":
            [
            {
            "name":"Ноутбук Apple MacBook Pro",
            "brief_description":"короткий опис товара Apple MacBook Pro",
            "country":"Китай",
            "productID":101,
            "product_code":"S1234567",
            "warranty":"24",
            "is_archive":false,
            "is_exclusive":false,
            "vendorID":155,
            "articul":"MD311RS5 A",
            "volume":0.02,
            "weight":"5.7",
            "kbt":"0",
            "is_new":false,
            "categoryID":155,
            "price": "1193.06",
            "price_uah": "10916.54",
            "recommendable_price":11234.56,
            "retail_price_uah":"11256.00",
            "bonus":"5.00",
            "stocks":[1,2,3],
            "stocks_expected":{"4":"2024-10-14 09:06:47","6":"2024-10-11 14:06:47"]},
            "available":{"1":3,"2":1,"3":1},
            "small_image": "https://opt.brain.com.ua/static/images/prod_img/6/7/S1234567_small.jpg",
            "medium_image": "https://opt.brain.com.ua/static/images/prod_img/6/7/S1234567.jpg",
            "large_image": "https://opt.brain.com.ua/static/images/prod_img/6/7/S1234567_big.jpg",
            "full_image": "https://opt.brain.com.ua/static/images/prod_img/6/7/S1234567_main.jpg",
            "quantity_package_sale": 0,
            "reservation_limit": 0,
            "non_returnable": 1
            },
            {
            "name":"Ноутбук Apple MacBook Pro2",
            "brief_description":"короткий опис товара Apple MacBook Pro2",
            "country":"Китай",
            "productID":102,
            "product_code":"S2345678",
            "warranty":"24",
            "is_archive":false,
            "is_exclusive":false,
            "vendorID":155,
            "articul":"RS555MD5 G",
            "volume":0.02,
            "weight":"13.5",
            "kbt":"1",
            "is_new":false,
            "categoryID":155,
            "price": "1764.03",
            "price_uah": "16141.16",
            "recommendable_price":16641.60,
            "retail_price_uah":"16682.00",
            "bonus":"0",
            "stocks":[1,2,3,4,5,6],
            "stocks_expected":[],
            "available":{"1":3,"2":1,"3":1,"4":2,"5":1,"6":1},
            "small_image": "https://opt.brain.com.ua/static/images/prod_img/7/8/S2345678_small.jpg",
            "medium_image": "https://opt.brain.com.ua/static/images/prod_img/7/8/S2345678.jpg",
            "large_image": "https://opt.brain.com.ua/static/images/prod_img/7/8/S2345678_big.jpg",
            "full_image": "https://opt.brain.com.ua/static/images/prod_img/7/8/S2345678_main.jpg",
            "quantity_package_sale": 0,
            "reservation_limit": 1,
            "non_returnable": 0
            }
            ],
        "count":2
        }
    }