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

Описание

GET /{version}/categories/{id}/children

Возвращает список категорий товарного дерева, вложенных в категорию с указанным в запросе идентификатором.

Ресурс является списочным.

URL ресурса:

https://api.content.market.yandex.ru/{version}/categories/{id}/children

Входные данные

Параметр Положе­ние Тип Обяза­тельность Описание
version PATH Enum Да

Версия API.

id PATH Int32 Да

Идентификатор категории.

fields QUERY Enum list Нет

Параметры категории, которые необходимо показать в выходных данных.

Возможные значения:
  • PARENT — информация о родительской категории.
  • STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
  • WARNINGS — предупреждения, связанные с показом категории.
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
format QUERY Enum Нет

Формат выходных данных.

Возможные значения:
  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.
Значение по умолчанию: JSON .
sort QUERY Enum Нет

Тип сортировки категорий.

Возможные значения:
  • BY_NAME — сортировка категорий в алфавитном порядке;
  • BY_OFFERS_NUM — сортировка по количеству товарных предложений в каждой категории;
  • NONE — сортировка по умолчанию.
Значение по умолчанию: NONE.
Параметры страницы
count QUERY Int32 Нет

Размер страницы (количество элементов на странице).

Ограничения:
  • Минимальное значение: 1, максимальное значение: 30

Значение по умолчанию: 10.
page QUERY Int32 Нет

Номер страницы.

Ограничения:
  • Минимальное значение: 1

Значение по умолчанию: 1.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

{
  "status" : "{enum}",
  "context" : {
    "region" : {
      "id" : {int32},
      "name" : "{string}",
      "type" : "{enum}",
      "childCount" : {int32},
      "country" : {
        Содержимое объекта
      }
    },
    "currency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "alternateCurrency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "page" : {
      "number" : {int32},
      "count" : {int32},
      "total" : {int32},
      "last" : {boolean}
    },
    "warnings" : [
      {
        "type" : "{string}",
        "code" : "{string}",
        "message" : "{string}"
      },
      ...
    ],
    "id" : "{string}",
    "time" : "{date}",
    "link" : "{string}",
    "marketUrl" : "{string}"
  },
  "categories" : [
    {
      "id" : {int32},
      "name" : "{string}",
      "fullName" : "{string}",
      "parent" : {int32},
      "adult" : {boolean},
      "link" : "{string}",
      "childCount" : {int32},
      "modelCount" : {int32},
      "offerCount" : {int32},
      "advertisingModel" : "{enum}",
      "viewType" : "{enum}",
      "warnings" : [
        {
          "text" : "{string}",
          "shortText" : "{string}",
          "age" : {int32}
        },
        ...
      ]
    },
    ...
  ]
}

Описание параметров:

Параметр для формата JSON Параметр для формата XML Тип Описание
status status

Enum

Статус обработки запроса.

Возможные значения:
  • OK — операция выполнена успешно.

  • ERROR — произошла ошибка.

context context

Object

Контекст обработки запроса.

categories categories

Object list

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

result-context-v2 Параметры, вложенные в context
id id

String

Уникальный идентификатор запроса.

time time

Date

Дата и время выполнения запроса в формате ISO 8601.

link link

String

Ссылка на текущий запрос.

marketUrl marketUrl

String

Ссылка на Яндекс.Маркет.

region region

Object

Информация о регионе запроса.

currency currency

Object

Валюта запроса.

alternateCurrency alternateCurrency

Object

Альтернативная валюта запроса.

page page

Object

Информация о параметрах страницы запроса.

warnings warnings

Object list

Список предупреждений, возникших при обработке запроса.

Предупреждение может быть связано с некритичной ошибкой, позволяющей продолжить обработку запроса. При этом результат может частично не соответствовать параметрам запроса.

region-v2 Параметры, вложенные в context/region
id id

Int32

Идентификатор региона.

name name

String

Наименование региона.

type type

Enum

Тип региона.

Возможные значения:
  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

childCount childCount

Int32

Количество дочерних регионов.

country country

Object

Страна, к которой относится регион.

Регион

currency-v2 Параметры, вложенные в context/currency, context/alternateCurrency
id id

String

Код валюты.

name name

String

Название валюты.

page-info Параметры, вложенные в context/page
number number

Int32

Номер страницы.

count count

Int32

Размер страницы.

total total

Int32

Количество страниц в результате.

last last

Boolean

Признак последней страницы.

warning Параметры, вложенные в context/warnings
type type

String

Тип предупрежедния.

code code

String

Код предупреждения.

message message

String

Сообщение с описанием предупреждения.

category-v2 Параметры, вложенные в categories
id id

Int32

Идентификатор категории.

name name

String

Наименование категории.

fullName fullName

String

Полное наименование категории.

parent parent

Int32

Идентификатор родительской категории.

adult adult

Boolean

Признак категории, имеющей возрастное ограничение (18+).

link link

String

Ссылка на карточку категории на Яндекс.Маркете.

childCount childCount

Int32

Количество дочерних категорий.

modelCount modelCount

Int32

Количество моделей в категории.

offerCount offerCount

Int32

Количество товарных предложений в категории.

advertisingModel advertisingModel

Enum

Тип размещения товарных предложений в категории.

Возможные значения:
  • CPC — плата только за клики по предложению магазина.

viewType viewType

Enum

Тип отображения товаров в категории.

Возможные значения:
  • LIST — список.

  • GRID — сетка.

warnings warnings

Object list

Предупреждения, связанные с категорией.

category-warning Параметры, вложенные в categories/warnings
text text

String

Текст предупреждения.

shortText shortText

String

Краткий текст предупреждения.

Предназначен для устройств с узким экраном.

age age

Int32

Возрастное ограничение для категории.

Возможные ошибки

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.