Получение списка продуктов

Возвращает список продуктов с пагинацией.

Request

GET

https://api.kit.yandex.net/v1/products

Query parameters

Name

Description

page

Type: integer

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

Default: 1

Min value: 1

per_page

Type: integer

Количество элементов на странице.

Default: 25

Min value: 1

Max value: 100

Responses

200 OK

Список продуктов.

Body

application/json

{
  "products": [
    {
      "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "category_ids": [
        "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
      ],
      "group_id": "group-123",
      "size_table": {
        "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
        "enabled": true
      },
      "settings": {
        "grouping_characteristic_ids": [
          "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
        ],
        "splitting_characteristic_ids": [
          "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
        ]
      }
    }
  ]
}

Name

Description

products

Type: Product[]

Example

[
  {
    "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "category_ids": [
      "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
    ],
    "group_id": "group-123",
    "size_table": {
      "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "enabled": true
    },
    "settings": {
      "grouping_characteristic_ids": [
        "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
      ],
      "splitting_characteristic_ids": [
        "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
      ]
    }
  }
]

ProductID

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

Type: string<uuid>

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

CategoryID

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

Type: string<uuid>

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

ProductSizeTable

Таблица размеров для товара. Содержит изображение с размерной сеткой (размеры одежды, обуви и т.д.). Применяется ко всем вариантам продукта.

Name

Description

enabled

Type: boolean

Флаг включения/выключения отображения таблицы размеров.

true — таблица отображается на странице товара.
false — таблица скрыта от покупателей.

file_id

Type: string<uuid>

Уникальный идентификатор файла с таблицей размеров. Файл должен быть предварительно загружен через POST /v1/files.

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

Example

{
  "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "enabled": true
}

ProductSettings

Name

Description

grouping_characteristic_ids

Type: CharacteristicID[]

Массив идентификаторов характеристик для группировки.

Example

[
  "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
]

splitting_characteristic_ids

Type: CharacteristicID[]

Массив идентификаторов характеристик для разбиения.

Example

[
  "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
]

Example

{
  "grouping_characteristic_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ],
  "splitting_characteristic_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ]
}

Product

Name	Description
category_ids	Type: CategoryID[] Идентификаторы активных (неархивированных) категорий продукта. Продукт может быть привязан к нескольким категориям, в том числе к архивированным — такие привязки сохраняются, но в этом поле не отображаются, пока категория имеет статус ARCHIVED. Если все привязанные категории архивированы, массив может быть пустым до разархивации категории или товара. Min items: `1` Example `[ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ]`
id	Type: ProductID Идентификатор продукта. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`
settings	Type: ProductSettings Example `{ "grouping_characteristic_ids": [ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ], "splitting_characteristic_ids": [ "019b21d9-c5d9-777d-80bd-d67c664bc6d9" ] }`
group_id	Type: string Идентификатор группы товаров в Excel. Example: `group-123`
size_table	Type: ProductSizeTable Таблица размеров для товара. Содержит изображение с размерной сеткой (размеры одежды, обуви и т.д.). Применяется ко всем вариантам продукта. Example `{ "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9", "enabled": true }`

Example

{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "category_ids": [
    "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
  ],
  "group_id": "group-123",
  "size_table": {
    "file_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "enabled": true
  },
  "settings": {
    "grouping_characteristic_ids": [
      "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
    ],
    "splitting_characteristic_ids": [
      "019b21d9-c5d9-777d-80bd-d67c664bc6d9"
    ]
  }
}

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`

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`

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

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

Создание нового продукта