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

Deprecated

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

Request

GET

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

Query parameters

Name

Description

status

Type: PromocodeStatus

Статус промокода.

Статус промокода:

  • ACTIVE — активный.
  • INACTIVE — неактивный.

Enum: ACTIVE, INACTIVE

page

Type: integer

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

Default: 1

Min value: 1

per_page

Type: integer

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

Default: 25

Min value: 1

Max value: 100

PromocodeStatus

Статус промокода:

  • ACTIVE — активный.
  • INACTIVE — неактивный.

Type: string

Enum: ACTIVE, INACTIVE

Responses

200 OK

Список промокодов.

Body

application/json
{
  "promocodes": [
    {
      "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
      "code": "HELLO5",
      "title": "Скидка 5% на все товары",
      "discount_value": {
        "value": "10.00",
        "type": "PERCENT"
      },
      "minimum_order_amount": "1000.00",
      "max_usage": 100,
      "max_discount_amount": "1000",
      "one_time_use": true,
      "first_order_only": true,
      "promocode_dates": {
        "start_date": "2025-01-01T00:00:00Z",
        "end_date": "2025-01-01T00:00:00Z"
      },
      "binding_mode": "ALL_VARIANTS",
      "status": "ACTIVE",
      "usage_count": 100,
      "created_at": "2020-01-01T00:00:00Z",
      "updated_at": "2020-01-01T00:00:00Z",
      "type": "ORDER",
      "show_in_pdp": true
    }
  ],
  "total_count": 100
}

Name

Description

promocodes

Type: Promocode[]

Example
[
  {
    "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
    "code": "HELLO5",
    "title": "Скидка 5% на все товары",
    "discount_value": {
      "value": "10.00",
      "type": "PERCENT"
    },
    "minimum_order_amount": "1000.00",
    "max_usage": 100,
    "max_discount_amount": "1000",
    "one_time_use": true,
    "first_order_only": true,
    "promocode_dates": {
      "start_date": "2025-01-01T00:00:00Z",
      "end_date": "2025-01-01T00:00:00Z"
    },
    "binding_mode": "ALL_VARIANTS",
    "status": "ACTIVE",
    "usage_count": 100,
    "created_at": "2020-01-01T00:00:00Z",
    "updated_at": "2020-01-01T00:00:00Z",
    "type": "ORDER",
    "show_in_pdp": true
  }
]

total_count

Type: integer

Общее количество промокодов.

PromocodeID

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

Type: string<uuid>

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

DiscountValue

Информация о значении скидки и о типе скидки.

Name

Description

type

Type: string

Тип скидки:

  • PERCENT — скидка в процентах от цены товара.
  • VALUE — скидка в абсолютном значении (в рублях).

Enum: PERCENT, VALUE

value

Type: string<decimal>

  • Для типа PERCENT — значение от 0 до 100 (например, 10.5).

  • Для типа VALUE — сумма в рублях (например, 500.00).

Example: 10.00
Example
{
  "value": "10.00",
  "type": "PERCENT"
}

PromocodeDates

Name

Description

start_date

Type: string<date-time>

Дата начала действия промокода.

Example: 2025-01-01T00:00:00Z

end_date

Type: string<date-time>

Дата окончания действия промокода. Если не указана, то промокод действует бесконечно.

Example: 2025-01-01T00:00:00Z
Example
{
  "start_date": "2025-01-01T00:00:00Z",
  "end_date": "2025-01-01T00:00:00Z"
}

PromocodeBindingMode

Режим применения промокода. Применим только для промокодов типа PRODUCTS:

  • ALL_VARIANTS — промокод применяется ко всем товарам магазина.
  • SELECTED_VARIANTS — промокод применяется к выбранным товарам.
  • SELECTED_CATEGORIES_COLLECTIONS — промокод применяется к товарам из выбранных категорий и коллекций.

Type: string

Enum: ALL_VARIANTS, SELECTED_VARIANTS, SELECTED_CATEGORIES_COLLECTIONS

PromocodeType

Тип промокода:

  • ORDER — промокод на заказ.
  • PRODUCTS — промокод на товары.

Type: string

Enum: ORDER, PRODUCTS

Promocode

Name

Description

code

Type: string

Код промокода.

Example: HELLO5

created_at

Type: string<date-time>

Дата создания промокода.

Example: 2020-01-01T00:00:00Z

discount_value

Type: DiscountValue

Информация о значении скидки и о типе скидки.

Example
{
  "value": "10.00",
  "type": "PERCENT"
}

first_order_only

Type: boolean

Можно ли использовать промокод только для первого заказа.

id

Type: PromocodeID

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

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

one_time_use

Type: boolean

Можно ли использовать промокод только один раз.

promocode_dates

Type: PromocodeDates

Example
{
  "start_date": "2025-01-01T00:00:00Z",
  "end_date": "2025-01-01T00:00:00Z"
}

status

Type: PromocodeStatus

Статус промокода:

  • ACTIVE — активный.
  • INACTIVE — неактивный.

Enum: ACTIVE, INACTIVE

title

Type: string

Название промокода.

Example: Скидка 5% на все товары

type

Type: PromocodeType

Тип промокода:

  • ORDER — промокод на заказ.
  • PRODUCTS — промокод на товары.

Enum: ORDER, PRODUCTS

updated_at

Type: string<date-time>

Дата обновления промокода.

Example: 2020-01-01T00:00:00Z

usage_count

Type: integer

Количество использований промокода.

binding_mode

Type: PromocodeBindingMode

Режим применения промокода. Применим только для промокодов типа PRODUCTS:

  • ALL_VARIANTS — промокод применяется ко всем товарам магазина.
  • SELECTED_VARIANTS — промокод применяется к выбранным товарам.
  • SELECTED_CATEGORIES_COLLECTIONS — промокод применяется к товарам из выбранных категорий и коллекций.

Enum: ALL_VARIANTS, SELECTED_VARIANTS, SELECTED_CATEGORIES_COLLECTIONS

max_discount_amount

Type: string<decimal>

Максимальная сумма скидки по промокоду.

Example: 1000

max_usage

Type: integer

Максимальное количество использований промокода.

minimum_order_amount

Type: string<decimal>

Минимальная сумма заказа для использования промокода.

Example: 1000.00

show_in_pdp

Type: boolean

Показывать ли промокод на странице товара. Применим только для промокодов типа PRODUCTS.
Example
{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "code": "HELLO5",
  "title": "Скидка 5% на все товары",
  "discount_value": {
    "value": "10.00",
    "type": "PERCENT"
  },
  "minimum_order_amount": "1000.00",
  "max_usage": 100,
  "max_discount_amount": "1000",
  "one_time_use": true,
  "first_order_only": true,
  "promocode_dates": {
    "start_date": "2025-01-01T00:00:00Z",
    "end_date": "2025-01-01T00:00:00Z"
  },
  "binding_mode": "ALL_VARIANTS",
  "status": "ACTIVE",
  "usage_count": 100,
  "created_at": "2020-01-01T00:00:00Z",
  "updated_at": "2020-01-01T00:00:00Z",
  "type": "ORDER",
  "show_in_pdp": true
}

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.

Предыдущая
Обновление промокода
Следующая
Создание промокода