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

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-04-21 01:21:42","6":"2024-04-18 06:21:42"]},
            "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
        }
    }