Получение коллекции по ID

Возвращает информацию о коллекции по ее уникальному идентификатору.

Request

GET

https://api.kit.yandex.net/v1/collections/{collection_id}

Responses

200 OK

Коллекция.

Body

application/json

{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "title": "Коллекция 1",
  "description": "Коллекция 1",
  "seo_title": "Коллекция 1",
  "seo_h1": "example",
  "seo_description": "Коллекция 1",
  "is_available_in_ad_feed": true,
  "slug": "kollektsiya-1",
  "status": "ACTIVE",
  "collection_type": "STATIC",
  "dynamic_filter": {
    "category_slugs": [
      "vsye-dlya-sna"
    ],
    "main_filter": [
      {
        "field": "price",
        "operator": "EQ",
        "value": "example"
      }
    ],
    "characteristic_filters": [
      null
    ]
  },
  "created_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-01T00:00:00Z",
  "cards_count": 10,
  "hidden_cards_count": 10,
  "image_path": "https://example.com/kollektsiya-1.jpg",
  "collection_sort": "OLDEST"
}

Name	Description
cards_count	Type: integer Общее количество карточек в коллекции.
collection_sort	Type: CollectionSort Сортировка карточек в коллекции: `OLDEST` — старые. `NEWEST` — новые. `SORT_WEIGHT` — приоритет в каталоге. `CHEAPEST` — дешевые. `EXPENSIVE` — дорогие. Enum: `OLDEST`, `NEWEST`, `SORT_WEIGHT`, `CHEAPEST`, `EXPENSIVE`
collection_type	Type: CollectionType Тип коллекции: `STATIC` — статическая коллекция. Контент заполняется вручную. `DYNAMIC` — динамическая коллекция. Контент заполняется автоматически на основе фильтров. Enum: `STATIC`, `DYNAMIC`
created_at	Type: string<date-time> Дата создания коллекции. Example: `2020-01-01T00:00:00Z`
description	Type: string Описание коллекции. Example: `Коллекция 1`
hidden_cards_count	Type: integer Количество скрытых карточек в коллекции.
id	Type: CollectionID Идентификатор коллекции. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`
is_available_in_ad_feed	Type: boolean Доступна ли коллекция в рекламном фиде.
seo_description	Type: string SEO описание коллекции. Example: `Коллекция 1`
seo_h1	Type: string SEO H1 коллекции. Example: `example`
seo_title	Type: string SEO заголовок коллекции. Example: `Коллекция 1`
slug	Type: string URL идентификатор коллекции. Example: `kollektsiya-1`
status	Type: CollectionStatus Статус коллекции: `ACTIVE` — активна, отображается в каталоге. `INACTIVE` — неактивна, не отображается в каталоге. Enum: `ACTIVE`, `INACTIVE`
title	Type: string Название коллекции. Example: `Коллекция 1`
updated_at	Type: string<date-time> Дата обновления коллекции. Example: `2020-01-01T00:00:00Z`
dynamic_filter	Type: DynamicCollectionFilter Конфигурация фильтра для динамических коллекций. Задает критерии автоматического наполнения коллекции товарами, удовлетворяющими указанным условиям. Использование: Обязателен для динамических коллекций. Запрещен для статических коллекций. Несколько фильтров объединяются по логике AND. URL идендификаторы категорий ограничивают выборку товарами из заданных категорий. В `main_filter` допустим только перечень полей `field`, указанный в описании этого поля. В `characteristic_filters` поле `field` — URL идентификатор характеристики (правила значений и операторов см. в описании `characteristic_filters`). Example `{ "category_slugs": [ "vsye-dlya-sna" ], "main_filter": [ { "field": "price", "operator": "EQ", "value": "example" } ], "characteristic_filters": [ null ] }`
image_path	Type: string Путь к изображению коллекции. Example: `https://example.com/kollektsiya-1.jpg`

CollectionID

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

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

CollectionStatus

Статус коллекции:

ACTIVE — активна, отображается в каталоге.
INACTIVE — неактивна, не отображается в каталоге.

Type: string

Enum: ACTIVE, INACTIVE

CollectionType

Тип коллекции:

STATIC — статическая коллекция. Контент заполняется вручную.
DYNAMIC — динамическая коллекция. Контент заполняется автоматически на основе фильтров.

Type: string

Enum: STATIC, DYNAMIC

SingleValueFilterOperator

Оператор фильтрации для одного значения:

EQ — равно.
NE — не равно.
GT — больше.
LT — меньше.
GE — больше или равно.
LE — меньше или равно.

Type: string

Enum: EQ, NE, GT, LT, GE, LE

ProductVariantSingleValueFilter

Name	Description
field	Type: string Поле для фильтрации. Example: `price`
operator	Type: SingleValueFilterOperator Оператор фильтрации для одного значения: `EQ` — равно. `NE` — не равно. `GT` — больше. `LT` — меньше. `GE` — больше или равно. `LE` — меньше или равно. Enum: `EQ`, `NE`, `GT`, `LT`, `GE`, `LE`
value	Type: string Example: `example`

Example

{
  "field": "price",
  "operator": "EQ",
  "value": "example"
}

MultiValueFilterOperator

Оператор фильтрации для нескольких значений:

IN — входит в массив.
NOT_IN — не входит в массив.

Type: string

Enum: IN, NOT_IN

ProductVariantMultiValueFilter

Name	Description
field	Type: string Example: `example`
operator	Type: MultiValueFilterOperator Оператор фильтрации для нескольких значений: `IN` — входит в массив. `NOT_IN` — не входит в массив. Enum: `IN`, `NOT_IN`
values	Type: string[] Массив значений для фильтрации. Min items: `1` Example `[ "example" ]`

Example

{
  "field": "example",
  "operator": "IN",
  "values": [
    "example"
  ]
}

ProductVariantRequestFilter

One of 2 types

Type: ProductVariantSingleValueFilter

Example

{
  "field": "price",
  "operator": "EQ",
  "value": "example"
}

Type: ProductVariantMultiValueFilter

Example

{
  "field": "example",
  "operator": "IN",
  "values": [
    "example"
  ]
}

Example

{
  "field": "price",
  "operator": "EQ",
  "value": "example"
}

DynamicCollectionFilter

Конфигурация фильтра для динамических коллекций. Задает критерии автоматического наполнения коллекции товарами, удовлетворяющими указанным условиям.

Использование:

Обязателен для динамических коллекций.
Запрещен для статических коллекций.
Несколько фильтров объединяются по логике AND.
URL идендификаторы категорий ограничивают выборку товарами из заданных категорий.
В main_filter допустим только перечень полей field, указанный в описании этого поля.
В characteristic_filters поле field — URL идентификатор характеристики (правила значений и операторов см. в описании characteristic_filters).

Name	Description
category_slugs	Type: string[] Массив URL идентификаторов категорий для фильтрации товаров. Товар должен принадлежать хотя бы одной из этих категорий, чтобы попасть в коллекцию. Пример: ["vsye-dlya-sna", "smartphones", "accessories"] Example `[ "vsye-dlya-sna" ]`
characteristic_filters	Type: ProductVariantRequestFilter[] В `field` указывается URL идентификатор характеристики. Все условия объединяются по логике AND. Числовая характеристика: укажите одно число в `value` (строкой, например, `"42.5"`). Доступные операторы: `EQ`, `NE`, `GE`, `GT`, `LT`, `LE` (равно, не равно, больше или равно, больше, меньше, меньше или равно). Строковая характеристика: укажите одно или несколько значений в `values`. Доступны только операторы `IN` и `NOT_IN` (входит в массив / не входит в массив ни одному из перечисленных). Поля `value` и `values` взаимоисключающие: для числовой характеристики заполняется `value`, для строковой — `values`. Пример (строковая характеристика): field: "tsvet" operator: "EQ" values: ["red", "blue"] Пример (числовая характеристика): field: "ves-kg" operator: "LE" value: "10" Example `[ { "field": "price", "operator": "EQ", "value": "example" } ]`
main_filter	Type: ProductVariantRequestFilter[] Массив дополнительных условий фильтрации (в JSON — массив объектов `[{...}, ...]`, не один объект). Все условия должны выполняться одновременно, чтобы товар попал в коллекцию (логика AND). Допустимые значения `field` (остальные поля в `main_filter` не поддерживаются): `total_quantity` — общее количество на складе (одно целочисленное значение в `value`). `price` — цена до скидки (одно целочисленное значение в `value`). `manual_discount_price` — цена с ручной скидкой (одно целочисленное значение в `value`). `promotion_price` — цена по акции (одно целочисленное значение в `value`). `final_price` — финальная цена (одно целочисленное значение в `value`). `sort_weight` — приоритет в каталоге (одно целочисленное значение в `value`). `vat` — НДС (одно или несколько целочисленных значений в `values`). `badge_slugs` — URL идентификаторы бейджей (строки в `values`). `has_characteristics` — наличие характеристик (URL идентификаторы характеристик в `value` или `values`). Операторы — см. схемы SingleValueFilterOperator и MultiValueFilterOperator. Пример: field: "final_price" operator: "LT" value: "1000" field: "badge_slugs" operator: "IN" values: ["sale", "discount"] Example `[ { "field": "price", "operator": "EQ", "value": "example" } ]`

Example

{
  "category_slugs": [
    "vsye-dlya-sna"
  ],
  "main_filter": [
    {
      "field": "price",
      "operator": "EQ",
      "value": "example"
    }
  ],
  "characteristic_filters": [
    null
  ]
}

CollectionSort

Сортировка карточек в коллекции:

OLDEST — старые.
NEWEST — новые.
SORT_WEIGHT — приоритет в каталоге.
CHEAPEST — дешевые.
EXPENSIVE — дорогие.

Type: string

Enum: OLDEST, NEWEST, SORT_WEIGHT, CHEAPEST, EXPENSIVE

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

Была ли статья полезна?

Список ресурсов

Удаление коллекции

Получение коллекции по ID

Request

Responses

200 OK

Body

CollectionID

CollectionStatus

CollectionType

SingleValueFilterOperator

ProductVariantSingleValueFilter

MultiValueFilterOperator

ProductVariantMultiValueFilter

ProductVariantRequestFilter

DynamicCollectionFilter

Пример: ["vsye-dlya-sna", "smartphones", "accessories"]

Пример (строковая характеристика):

Пример (числовая характеристика):

Пример:

CollectionSort

400 Bad Request

Body

401 Unauthorized

Body

404 Not Found

Body

500 Internal Server Error

Body

Была ли статья полезна?