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

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

Возможна фильтрация по:

  • идентификатору продукта;
  • статусу товара;
  • тексту названия товара, артикулу, штрихкоду и KIT ID.

Request

GET

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

Query parameters

Name

Description

name

Type: string

Текст для поиска по тексту названия товара, артикулу, штрихкоду и KIT ID. Поиск регистронезависимый, частичный.

Example: iPhone

page

Type: integer

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

Default: 1

Min value: 1

per_page

Type: integer

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

Default: 25

Min value: 1

Max value: 100

product_card_id

Type: ProductCardID

Фильтр по идентификатору карточки товара.

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

Examples

``

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

product_id

Type: ProductID

Фильтр по идентификатору продукта.

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

Examples

``

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

status

Type: VariantStatus[]

Фильтр по статусу товара. По умолчанию возвращаются товары всех статусов, кроме ARCHIVED.

Example: ``

ProductID

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

Type: string<uuid>

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

ProductCardID

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

Type: string<uuid>

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

VariantStatus

Статус товара:

  • PUBLISHED — опубликован, доступен для покупки.
  • HIDDEN — скрыт, не отображается в каталоге.
  • ARCHIVED — архивирован, недоступен.

Type: string

Enum: PUBLISHED, HIDDEN, ARCHIVED

Responses

200 OK

Список товаров.

Body

application/json
{
  "variants": [
    {
      "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "kit_id": 0,
      "sku": "SKU-12345",
      "barcode": "1234567890123",
      "slug": "iphone-15-pro-black",
      "name": "iPhone 15 Pro Черный",
      "description": "Флагманский смартфон с титановым корпусом",
      "brand": "Apple",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-16T14:20:00Z",
      "status": "PUBLISHED",
      "product_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "product_card_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "characteristics": [
        {
          "characteristic_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
          "value": "Черный",
          "values": [
            "Желтый",
            "Красный"
          ]
        }
      ],
      "stocks": [
        {
          "warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
          "quantity": 10,
          "reserved": 2
        }
      ],
      "media": [
        {
          "type": "IMAGE",
          "display_sequence": 1,
          "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
          "video_id": "abc123xyz"
        }
      ],
      "pricing": {
        "price": "1000",
        "manual_discount_price": "900",
        "promotion_price": "850",
        "final_price": "850"
      },
      "sort_weight": 100,
      "cargo_boxes": [
        {
          "length": 20,
          "width": 15,
          "height": 10,
          "weight": 500,
          "display_sequence": 1
        }
      ],
      "seo_title": "iPhone 15 Pro Черный - купить в интернет-магазине.",
      "seo_h1": "iPhone 15 Pro Черный.",
      "seo_description": "Купить iPhone 15 Pro Черный по выгодной цене.",
      "vat": 20,
      "requires_marking": false
    }
  ],
  "total_count": 100
}

Name

Description

total_count

Type: integer

Общее количество товаров.

variants

Type: Variant[]

Список товаров.

Example
[
  {
    "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "kit_id": 0,
    "sku": "SKU-12345",
    "barcode": "1234567890123",
    "slug": "iphone-15-pro-black",
    "name": "iPhone 15 Pro Черный",
    "description": "Флагманский смартфон с титановым корпусом",
    "brand": "Apple",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-16T14:20:00Z",
    "status": "PUBLISHED",
    "product_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "product_card_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "characteristics": [
      {
        "characteristic_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
        "value": "Черный",
        "values": [
          "Желтый",
          "Красный"
        ]
      }
    ],
    "stocks": [
      {
        "warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
        "quantity": 10,
        "reserved": 2
      }
    ],
    "media": [
      {
        "type": "IMAGE",
        "display_sequence": 1,
        "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
        "video_id": "abc123xyz"
      }
    ],
    "pricing": {
      "price": "1000",
      "manual_discount_price": "900",
      "promotion_price": "850",
      "final_price": "850"
    },
    "sort_weight": 100,
    "cargo_boxes": [
      {
        "length": 20,
        "width": 15,
        "height": 10,
        "weight": 500,
        "display_sequence": 1
      }
    ],
    "seo_title": "iPhone 15 Pro Черный - купить в интернет-магазине.",
    "seo_h1": "iPhone 15 Pro Черный.",
    "seo_description": "Купить iPhone 15 Pro Черный по выгодной цене.",
    "vat": 20,
    "requires_marking": false
  }
]

VariantID

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

Type: string<uuid>

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

CharacteristicID

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

Type: string<uuid>

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

VariantCharacteristic

Значение характеристики товара.

Name

Description

characteristic_id

Type: CharacteristicID

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

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

value

Type: string

Значение характеристики.

Example: Черный

values

Type: string[]

Значения характеристик.

Example
[
  "Желтый",
  "Красный"
]
Example
{
  "characteristic_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "value": "Черный",
  "values": [
    "Желтый",
    "Красный"
  ]
}

WarehouseID

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

Type: string<uuid>

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

VariantStock

Остатки товара на складе.

Name

Description

quantity

Type: integer

Количество на складе.

reserved

Type: integer

Зарезервированное количество.

warehouse_id

Type: WarehouseID

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

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9
Example
{
  "warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "quantity": 10,
  "reserved": 2
}

FileType

Тип файла.

Type: string

Enum: IMAGE, VIDEO, OTHER

FileID

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

Type: string<uuid>

Example: 019b30d4-3e28-7a98-ae46-cb66932d1936

VariantMedia

Медиафайлы товара (изображения и видео).

Name

Description

display_sequence

Type: integer

Порядок отображения.

type

Type: FileType

Тип файла.

Enum: IMAGE, VIDEO, OTHER

image_id

Type: FileID

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

Example: 019b30d4-3e28-7a98-ae46-cb66932d1936

video_id

Type: string

Идентификатор видео (для VIDEO).

Example: abc123xyz
Example
{
  "type": "IMAGE",
  "display_sequence": 1,
  "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
  "video_id": "abc123xyz"
}

VariantPricing

Цена товара.

Name

Description

final_price

Type: string<decimal>

Итоговая цена.

Example: 850

manual_discount_price

Type: string<decimal>

Цена со скидкой (установлена вручную).

Example: 900

price

Type: string<decimal>

Цена до скидки. Базовая цена товара от которой считается цена со скидкой.

Example: 1000

promotion_price

Type: string<decimal>

Цена по акции.

Example: 850
Example
{
  "price": "1000",
  "manual_discount_price": "900",
  "promotion_price": "850",
  "final_price": "850"
}

VariantCargoBox

Name

Description

display_sequence

Type: integer

Порядок отображения.

height

Type: integer

Высота (см).

Min value: 0

length

Type: integer

Длина (см).

Min value: 0

weight

Type: integer

Вес (г).

Min value: 0

width

Type: integer

Ширина (см).

Min value: 0
Example
{
  "length": 20,
  "width": 15,
  "height": 10,
  "weight": 500,
  "display_sequence": 1
}

Variant

Name

Description

barcode

Type: string

Штрих-код.

Example: 1234567890123

brand

Type: string

Бренд товара.

Example: Apple

cargo_boxes

Type: VariantCargoBox[]

Вес и габариты с упаковкой.

Example
[
  {
    "length": 20,
    "width": 15,
    "height": 10,
    "weight": 500,
    "display_sequence": 1
  }
]

characteristics

Type: VariantCharacteristic[]

Характеристики товара.

Example
[
  {
    "characteristic_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "value": "Черный",
    "values": [
      "Желтый",
      "Красный"
    ]
  }
]

created_at

Type: string<date-time>

Дата создания.

Example: 2024-01-15T10:30:00Z

description

Type: string

Описание товара.

Example: Флагманский смартфон с титановым корпусом

id

Type: VariantID

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

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

kit_id

Type: integer

Уникальный идентификатор товара в системе, отображаемый в B2B кабинете.

media

Type: VariantMedia[]

Изображения и видео.

Example
[
  {
    "type": "IMAGE",
    "display_sequence": 1,
    "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
    "video_id": "abc123xyz"
  }
]

name

Type: string

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

Example: iPhone 15 Pro Черный

pricing

Type: VariantPricing

Цена товара.

Example
{
  "price": "1000",
  "manual_discount_price": "900",
  "promotion_price": "850",
  "final_price": "850"
}

product_card_id

Type: ProductCardID

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

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

product_id

Type: ProductID

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

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

requires_marking

Type: boolean

Признак обязательной маркировки товара в системе «Честный знак». Если параметр не передан, используется значение по умолчанию false. true — товар подлежит обязательной маркировке, false — не подлежит.

seo_description

Type: string

Описание страницы в поиске (Description).

Example: Купить iPhone 15 Pro Черный по выгодной цене.

seo_h1

Type: string

Заголовок на странице товара (H1).

Example: iPhone 15 Pro Черный.

seo_title

Type: string

Заголовок страницы в поиске (Title).

Example: iPhone 15 Pro Черный - купить в интернет-магазине.

sku

Type: string

Артикул товара.

Example: SKU-12345

slug

Type: string

URL-идентификатор товара.

Example: iphone-15-pro-black

sort_weight

Type: integer

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

Min value: 1

Max value: 1000

status

Type: VariantStatus

Статус товара:

  • PUBLISHED — опубликован, доступен для покупки.
  • HIDDEN — скрыт, не отображается в каталоге.
  • ARCHIVED — архивирован, недоступен.

Enum: PUBLISHED, HIDDEN, ARCHIVED

stocks

Type: VariantStock[]

Остатки на складах.

Example
[
  {
    "warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "quantity": 10,
    "reserved": 2
  }
]

updated_at

Type: string<date-time>

Дата последнего обновления.

Example: 2024-01-16T14:20:00Z

vat

Type: integer

НДС в процентах. Специальное значение -1 означает, что товар не облагается НДС.
Example
{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "kit_id": 0,
  "sku": "SKU-12345",
  "barcode": "1234567890123",
  "slug": "iphone-15-pro-black",
  "name": "iPhone 15 Pro Черный",
  "description": "Флагманский смартфон с титановым корпусом",
  "brand": "Apple",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-16T14:20:00Z",
  "status": "PUBLISHED",
  "product_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "product_card_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "characteristics": [
    {
      "characteristic_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "value": "Черный",
      "values": [
        "Желтый",
        "Красный"
      ]
    }
  ],
  "stocks": [
    {
      "warehouse_id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "quantity": 10,
      "reserved": 2
    }
  ],
  "media": [
    {
      "type": "IMAGE",
      "display_sequence": 1,
      "image_id": "019b30d4-3e28-7a98-ae46-cb66932d1936",
      "video_id": "abc123xyz"
    }
  ],
  "pricing": {
    "price": "1000",
    "manual_discount_price": "900",
    "promotion_price": "850",
    "final_price": "850"
  },
  "sort_weight": 100,
  "cargo_boxes": [
    {
      "length": 20,
      "width": 15,
      "height": 10,
      "weight": 500,
      "display_sequence": 1
    }
  ],
  "seo_title": "iPhone 15 Pro Черный - купить в интернет-магазине.",
  "seo_h1": "iPhone 15 Pro Черный.",
  "seo_description": "Купить iPhone 15 Pro Черный по выгодной цене.",
  "vat": 20,
  "requires_marking": false
}

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

No longer supported, please use an alternative and newer version.

Предыдущая
Удаление похожих карточек товара
Следующая
Создание нового товара