Категории в интернет-магазине

Список категорий

Получает список категорий. Список можно фильтровать и производить поиск.

Путь: /wp-json/usam/v1/categories

Метод запроса: GET

hide_empty (число) (не обязательно) — Скрывать ли термины в которых нет записей. 1 — скрывать пустые, 0 — показывать пустые.
object_ids (массив) (не обязательно) — Укажите тут число или массив чисел, чтобы получить термины, у которых поле object_id таблицы wp_term_relationships совпадет с указанными значениями. Обычно в поле object_id находятся ID записей к которым прикреплен термин.
include (массив) (не обязательно) — ID терминов, которые нужно включить в выборку. Если указать этот параметр, то многие другие станут бесполезными..
external_code (массив) (не обязательно) — список внешних кодов, термины которых нужно получить
exclude_tree (массив) (не обязательно) — ID родительских терминов, которые нужно исключить. Исключена будет вся ветка.
exclude (массив) (не обязательно) — ID терминов, которые нужно исключить
parent (число) (не обязательно) — ID родительского термина, чтобы получить только прямых потомков. Будет получен только первый уровень вложенности, а не все дерево как в параметре child_of. Если указать 0, то будут выведены термины верхнего уровня.
meta_query (массив) (не обязательно) — Запрос для получения элементов на основе метаданных. Смотрите WP_Meta_Query.
meta_key (строка) (не обязательно) — Получит термины у которых есть указанное метаполе. Можно использовать в связке с meta_value.
meta_value (строка) (не обязательно) — Получит термины у которых значение метаполя равно указанному значению. Всегда используется в связке с meta_key.
childless (число) (не обязательно)— 1 пропустит (не получит) термины у которых есть дочерние термины.
hierarchical (число) (не обязательно)— Включать ли в результат термины, которые имеют не пустые дочерние термины (в которых есть записи).
fields — (строка) (не обязательно) дополнительные поля, которые нужно получить;
search (строка) (не обязательно) — поиск по названию;
count (число) (не обязательно) — количество, по умолчанию 10;
paged (число) (не обязательно) — страница списка;
orderby (строка) (не обязательно) — сортировать по полю;
order (строка) (не обязательно) — направление сортировки ASC или DESC;

fields может содержать:

ids — вернуть массив чисел;
names — вернуть массив строк.
count — возвращает количество найденных терминов.
id=>parent — вернуть массив, где ключ = ID термина, а значение = ID родительского термина.
id=>slug — вернуть массив, где ключ = ID термина, а значение = слаг (название для УРЛ) термина.
id=>name — вернуть массив, где ключ = ID термина, а значение = название (имя) термина.

Пример запроса

/wp-json/usam/v1/categories

Возвращает

Ответы в формате JSON

{
    "count": 1,
    "items": [       
        {"term_id":564,
        "name":"Кастрюли",
        "slug":"shhipcy",
        "term_group":0,
        "term_taxonomy_id":610,
        "taxonomy":"usam-category",
        "description":"",
        "parent":86,
        "count":17,
        "filter":"raw",
        "url":"http://radov39.ru/product-category/shhipcy"
    }]
}

Создать или обновить категорию

Этим методом вы можете создать или обновить категории. Если не будет передан term_id или external_code и название категории уникально, то категория будет создана. Нельзя создавать категории с одинаковыми именами, даже у разных родителей.

Путь: /wp-json/usam/v1/categories

Метод запроса: PUT

items — массив содержащий данные для создания или обновления (обязательный)

Значения items смотрите ниже.

name (строка) (обязательно) — название;
slug (строка) (не обязательно) — slug;
term_id (число) (не обязательно) — номер, число;
external_code (строка) (не обязательно) — внешний код;
sort (число) (не обязательно) — сортировка при отображении на сайте, число;
parent_id (число) (не обязательно) — номер категории родителя, число;
parent_external_code (строка) (не обязательно) — внешний код категории родителя;

Пример запроса

В примере ниже будет обновлена категория «Посуда для приготовления» и созданы две категории «Кастрюли» и «Сковородки», причем «Посуда для приготовления» будет родителем.

/wp-json/usam/v1/categories

{"items":[
   {"name":"Посуда для приготовления", "term_id":12},
   {"name":"Кастрюли", "parent_id":12},   
   {"name":"Сковородки", "parent_id":12}
]}