Основы uAPI

Документация uAPI по модулям

Во всех PHP примерах запроса используется PHP модуль uAPI
Заказы | Категории магазина | Корзина магазина | Товары
Главная > Документация uAPI > Модуль "Интернет-магазин", категории
 

Получить список категорий - [GET]


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

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

{ 'error' => { ERROR_DATA } }

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

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

Дополнительные параметры запроса

  • parent_id=CATEGORY_ID – [Число] - ID родительской категории
  • get_globals=[0|1] – [Число] - указывает на то, что нужно получить список глобальных категорий магазина

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

  • 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" } ] }
     

    Добавить категорию - [POST]


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

    { 'error' => { ERROR_DATA } }

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

    { 'success': { 'msg': "Категория успешно добавлена", 'cat_data': CATEGORY_DATA } }

    Дополнительные параметры запроса

    • pid=PARENT_CAT_ID – [Число] - ID родительской категории. Если указан, то категория будет создана вложенной в указанную родительскую категорию. ID должен быть ID существующей в магазине категории
    • global_cat=GLOBAL_CAT_ID – [Число] - ID категории группы товаров.
    • dscr=DESCRIPTION – [Строка] - Описание категории
    • meta_title=TITLE – [Строка] - HTML Заголовок страницы
    • meta_dscr=DESCRIPTION – [Строка] - HTML meta description
    • url=CAT_URI – [Строка] - URI (Человеко Понятный Урл) категории
    • pos=POS – [Число] - Позиция категории в списке категорий
    • cat_img=IMG_PATH – [Строка] - путь к файлу на сервере из которого отсылается API-запрос
    • view_groups=ID_LIST – [Строка] - список, через запятую, ID групп которые будут иметь доступ к категории
    • add_groups=ID_LIST – [Строка] - список, через запятую, ID групп которые будут иметь возможность добавлять материалы в категорию
    • exclude_from_discount=[0|1] – [Число] - отключает/включает для категории признак “Исключить из скидок”
    • yml_name=NAME – [Строка] - Название категории для Яндекс.Маркета ()
    • yml_fee=FEE – [Строка] - Размер комиссии на товарное предложение ("fee") для Яндекс.Маркета
    • yml_is_adult=[0|1] – [Число] - отключает/включает атрибут “Категория с товарами adult-секции”
    • yml_is_delivery=[0|1] – [Число] - отключает/включает атрибут “Товары категории доставляются курьерской доставкой”
    • yml_is_pickup=[0|1] – [Число] - отключает/включает атрибут “Самовывоз товаров категории из пунктов выдачи”
    • yml_is_store=[0|1] – [Число] - отключает/включает атрибут “Товары категории можно купить в розничном магазине”
    • yml_name=NAME – [Строка] - Название категории для Яндекс.Маркета ()

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

    • CATEGORY_DATA – Cекция с данными категории
        • Содержит поля:
      • id – ID созданной категории
      • pid – ID родительской категории
      • global_cat – ID категории группы товаров
      • name – название категории
      • url – URI категории
      • cat_img – полная ссылка на изображение категории
      • pos – позиция категории в списке категорий
      • view_groups – список, через двоеточие, ID групп которые имеют доступ к категории
      • add_groups – список, через двоеточие, ID групп которые имеют возможность добавлять материалы в категорию
    POSTSHOP /uapi/shop/edit_cat
    <?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->post('/shop/edit_cat', array( 'mode' => 'add', 'name' => 'CAT_NAME' )); print_r($response); //Получаем ответ ?>
    { "success":{ "msg":"Категория успешно добавлена", "cat_data":{ "id":"2532", "view_groups":"", "url":"cat_name-1", "cat_img":"http://yoursite.ucoz.ru/.s/img/sh/nfp.png", "name":"CAT_NAME", "add_groups":"", "pos":"20", "pid":"0", "global_cat":"0" } } }
     

    Изменить данные категории - [POST]


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

    { 'error' => { ERROR_DATA } }

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

    { 'success': { 'msg': "Категория успешно изменена", 'cat_data': CATEGORY_DATA } }

    Дополнительные параметры запроса

    • name=NAME – [Строка] - название категории
    • pid=PARENT_CAT_ID – ID родительской категории. Если указан, то категория будет перемещена в указанную родительскую категорию. ID должен быть ID существующей в магазине категории. Если нужно перенести категорию в корень дерева, то нужно для параметра “pid” указывать значение 0.
    • global_cat=GLOBAL_CAT_ID – [Число] - ID категории группы товаров.
    • dscr=DESCRIPTION – [Строка] - Описание категории
    • meta_title=TITLE – [Строка] - HTML Заголовок страницы
    • meta_dscr=DESCRIPTION – [Строка] - HTML meta description
    • url=CAT_URI – [Строка] - URI (Человеко Понятный Урл) категории
    • pos=POS – [Число] - Позиция категории в списке категорий
    • cat_img=IMG_PATH – [Строка] - путь к файлу на сервере из которого отсылается API-запрос
    • view_groups=ID_LIST – [Строка] - список, через запятую, ID групп которые будут иметь доступ к категории
    • add_groups=ID_LIST – [Строка] - список, через запятую, ID групп которые будут иметь возможность добавлять материалы в категорию
    • exclude_from_discount=[0|1] – [Число] - отключает/включает для категории признак “Исключить из скидок”
    • yml_name=NAME – [Строка] - Название категории для Яндекс.Маркета ()
    • yml_fee=FEE – [Строка] - Размер комиссии на товарное предложение ("fee") для Яндекс.Маркета
    • yml_is_adult=[0|1] – [Число] - отключает/включает атрибут “Категория с товарами adult-секции”
    • yml_is_delivery=[0|1] – [Число] - отключает/включает атрибут “Товары категории доставляются курьерской доставкой”
    • yml_is_pickup=[0|1] – [Число] - отключает/включает атрибут “Самовывоз товаров категории из пунктов выдачи”
    • yml_is_store=[0|1] – [Число] - отключает/включает атрибут “Товары категории можно купить в розничном магазине”
    • yml_name=NAME – [Строка] - Название категории для Яндекс.Маркета ()

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

    • CATEGORY_DATA – Cекция с данными категории
        • Содержит поля:
      • id – ID созданной категории
      • pid – ID родительской категории
      • global_cat – ID категории группы товаров
      • name – название категории
      • url – URI категории
      • cat_img – полная ссылка на изображение категории
      • pos – позиция категории в списке категорий
      • view_groups – список, через двоеточие, ID групп которые имеют доступ к категории
      • add_groups – список, через двоеточие, ID групп которые имеют возможность добавлять материалы в категорию
    POSTSHOP /uapi/shop/edit_cat
    <?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->post('/shop/edit_cat', array( 'mode' => 'edit', 'id' => 2532, 'name' => 'Новое название категории' )); print_r($response); //Получаем ответ ?>
    { "success":{ "msg":"Категория успешно изменена", "cat_data":{ "id":"2532", "view_groups":"", "url":"cat_name-1", "cat_img":"http://yoursite.ucoz.ru/.s/img/sh/nfp.png", "name":"Новое название категории", "add_groups":"", "pos":"20", "pid":"0", "global_cat":"0" } } }
     

    Добавление/Изменение/Удаление изображения категории - [POST]


    del=1 - [Число] - флаг, указывающий, что нужно удалить изображение. Не учитывается, если указан параметр “cat_img”

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

    { 'error' => { ERROR_DATA } }

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

    { 'success': { 'msg': "Изображение изменено", 'cat_data': CATEGORY_DATA } }

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

    • CATEGORY_DATA – Cекция с данными категории
        • Содержит поля:
      • id – ID созданной категории
      • pid – ID родительской категории
      • global_cat – ID категории группы товаров
      • name – название категории
      • url – URI категории
      • cat_img – полная ссылка на изображение категории
      • pos – позиция категории в списке категорий
      • view_groups – список, через двоеточие, ID групп которые имеют доступ к категории
      • add_groups – список, через двоеточие, ID групп которые имеют возможность добавлять материалы в категорию
    POSTSHOP /uapi/shop/edit_cat
    <?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->post('/shop/edit_cat', array( 'mode' => 'img', 'id' => 2532, 'cat_img' => '@1.jpg' )); print_r($response); //Получаем ответ ?>
    { "success":{ "msg":"Изображение изменено", "cat_data":{ "id":"2532", "view_groups":"", "url":"cat_name-1", "cat_img":"http://yoursite.ucoz.ru/_sh/25/2532c.jpg", "name":"Новое название категории", "add_groups":"", "pos":"20", "pid":"0", "global_cat":"0" } } }
     

    Отображение / скрытие категории - [POST]


    С помощью данного запроса можно отобрахить/скрыть (mode=“show” и mode=”hide” соответственно) категорию с определенным ID

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

    { 'error' => { ERROR_DATA } }

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

    { 'success': { 'msg': "Категория успешно изменена", } }
    POSTSHOP /uapi/shop/edit_cat
    <?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->post('/shop/edit_cat', array( 'mode' => 'hide', 'id' => 2532, )); print_r($response); //Получаем ответ ?>
    { "success":{ "msg":"Категория успешно изменена", } }
    
    Яндекс.Метрика