Главная > Документация uAPI > Модуль "Интернет-магазин", категории
 

[GET] Список всех категорий


Параметр page=categories имитирует работу переменной $CATEGORIES$ в шаблонизаторе uCoz (вывод всех категорий)

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

{ 'error' => { ERROR_DATA } }

В случае успешного ответа

{ 'success': { '0': { CATEGORY_DATA } '1': { CATEGORY_DATA } ... } }

Расшифровка ответа

  • CATEGORY_DATA – Cекция с данными категории
    • Содержит поля:
    • sort - SORT_DATA – секция с данными по режимах сортировки товаров категории
    • filters - FILTERS_DATA – секция с данными по фильтрам товаров категории
    • paginator – секция с данными по пагинатору выборки. cur_page - номер текущей страницы выборки, заданный параметром pnum. num_pages - количество страниц выборки.
    • duplicate – признак, что запрос был отправлен на дублирующуюся по URL страницу (например, /category;0 /category;1)
    • goods_count – количество товаров в категории
    • meta_data – META-DATA - секция с META-данными категории
  • sort - SORT_DATA – Cекция с данными по режимах сортировки товаров категории
    • Содержит поля:
    • sort – поле по которому был отсортирован список товаров
    • order – использованный режим сортировки
    • slist – секция с подписями к полям сортировки. field - поле сортировки. name - подпись к полю
  • FILTERS_DATA – секция с данными по фильтрам товаров категории
    • Содержит поля:
    • fdata – набор данных по фильтрам (все возможные значения фильтра, мин/макс значение для фильтра по цене, позиция каждого значения фильтра в блоке значений и количество товаров подпадающих под каждое значение фильтра).
    • filters – значения примененых фильтров. for_uri - содержит строку с фильтрами, если включена опция “Дублировать фильтры товаров в адресной строке
  • META-DATA – секция с META-данными категории
    • Содержит поля:
    • meta_title – содержимое TITLE-тега
    • meta_description – содержимое тега <meta name="description" content="..." />
  • GOODS_LIST – секция со списком товаров категории. Данная секция содержит список подсекций с данными по каждому выбранному товару. ID подсекции - порядковый номер подсекции в списке подсекций
    • Содержит поля:
    • entry_id – ID товара
    • entry_title – наименование товара
    • entry_cat – ENTRY_CAT - секция с данными категории товара (может отличаться от данных категории в секции CATEGORY_DATA, если товар находится в дочерней категории)
    • entry_cats – ENTRY_CATS - секция с дополнительными категориями товара
    • entry_brand – значение поля “Производитель”
    • entry_brief – краткое описание товара
    • entry_description – описание товара
    • entry_photo – ENTRY_PHOTO - секция с изображениями товара
    • entry_hgu – ЧПУ товара
    • entry_shop_url – URL товара в магазине
    • entry_type – тип товара (0 - материальный товар, 1 - товар-файл, 2 - товар-электронный код, 3 - товар-услуга)
    • entry_price – цена товара
    • entry_price_in – входящая цена товара
    • entry_price_old – старая цена товара
    • entry_price_vat – цена товара с НДС (если в настройках магазина включен расчет НДС)
    • entry_price_vat_eval – цена товара без НДС (если в настройках магазина включен расчет НДС)
    • entry_unit – значение поля “Единица”
    • entry_weight – вес товара
    • entry_art_no – значение поля “Артикул”
    • entry_stock – остаток товара
    • entry_warr – значение поля “Гарантия”
    • entry_others – секция со значениями дополнительных полей товара. Количество элеметов секции зависит от количества дополнительных полей товара, установленного в настройках магазина.
    • entry_options – ENTRY_OPTIONS - секция с опциями товара
    • entry_is_in_discount – признак, что товар включается в расчет скидок
    • entry_is_hidden – признак, что товар скрыт
    • entry_is_in_basket – признак, что товар добавлен в корзину текущего пользователя
    • entry_is_in_wishlist – признак, что товар добавлен в список желаний текущего пользователя
    • entry_rating – ENTRY_RATING - секция с данными по рейтингу товара
    • entry_views – количество просмотров товара
    • entry_solds – количество продаж товара
    • entry_ordered – количество заказов, оформленных с данным товаром
    • num_com – оличество комментариев товара
    • entry_file_size – размер прикрепленного к товару файла
    • entry_add_uid – ID пользователя, добавившего товар
    • entry_add_user – логин пользователя, добавившего товар
    • entry_added_time – время добавления товара
    • entry_modified_time – время последнего изменения товара
  • ENTRY_CAT – екция с данными категории товара (может отличаться от данных категории в секции CATEGORY_DATA, если товар находится в дочерней категории)
  • sort=FIELD_NAME – [Строка] – поле по которому будет отсортирован список товаров
    • Содержит поля:
    • id – ID товара
    • pid – ID родительской категории
    • name – название категории товара
    • pname – название родительской категории товара
    • url – URI категории относительно корня магазина
    • purl – URI родительской категории относительно корня магазина
  • ENTRY_CATS – секция с дополнительными категориями товара
    • Содержит поля:
    • cats – подсекция с данными дополнительных категорий товара. id - ID категории. url - URI категории относительно корня магазина. name - название категории.
    • num_cats – количество дополнительных категорий товара
  • ENTRY_PHOTO – секция с изображениями товара
    • Содержит поля:
    • num_photos – количество изображений
    • def_photo – секция с данными изображения “по умолчанию”. small - URL к изображению-иконке товара. thumb - URL к изображению-превю товара. photo - URL к полному изображению товара
    • others_photo – секциями с данными других изображений товара (набор полей аналогичен секции def_photo)
  • sort - SORT_DATA – секция с данными по режимах сортировки товаров категории
  • GETSHOP /uapi/shop/request?page=categories
    <?php require 'uAPImodule.php'; $request = new Request(array( 'oauth_consumer_key' => 'Мой consumer_key', 'oauth_consumer_secret' => 'Мой consumer_secret', 'oauth_token' => 'Мой token', 'oauth_token_secret' => 'Мой token_secret' )); $response = $request->get('/shop/request', array( 'page' => 'categories' )); print_r($response); //Получаем ответ ?>
    { "success":[ { "cat_id":"1", "cat_descr":"Нематериальные товары", "goods_count":3, "cat_img":"", "cat_name":"Цифровые товары", "meta_data":{ "META_DESCRIPTION":". Нематериальные товары", "META_TITLE":"Цифровые товары" }, "childs":"", "cat_url":"digital-goods" }, { "cat_id":"2", "cat_descr":"Необычные товары. Категория содержит подкатегории", "goods_count":4, "cat_img":"http://yoursite.ucoz.ru/_sh/00/2c.png", "cat_name":"Гаджеты", "meta_data":{ "META_DESCRIPTION":"Спорт Игры. Необычные товары. Категория содержит подкатегории", "META_TITLE":"Гаджеты" }, "childs":[ { "cat_id":"5", "cat_descr":"Игровые товары", "goods_count":2, "cat_img":"", "cat_name":"Игры", "meta_data":{ "META_DESCRIPTION":". Игровые товары", "META_TITLE":"Игры" }, "childs":"", "cat_url":"gadjets/games" }, { "cat_id":"6", "cat_descr":"", "goods_count":2, "cat_img":"", "cat_name":"Спорт", "meta_data":{ "META_DESCRIPTION":"", "META_TITLE":"" }, "childs":"", "cat_url":"gadjets/sport" } ], "cat_url":"gadjets" }, { "cat_id":"4", "cat_descr":"В этой категории содержатся товары с опциями", "goods_count":2, "cat_img":"http://yoursite.ucoz.ru/_sh/00/4c.png", "cat_name":"Одежда", "meta_data":{ "META_DESCRIPTION":"продажа одежды", "META_TITLE":"Одежда" }, "childs":"", "cat_url":"clothing" } ] }
    Яндекс.Метрика