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

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

Request

GET

https://api.kit.yandex.net/v1/promocode_groups/{group_id}/codes

Query parameters

Name	Description
page	Type: integer Номер страницы. Default: `1` Min value: `1`
per_page	Type: integer Количество элементов на странице. Default: `25` Min value: `1` Max value: `100`
search	Type: string Поиск по коду (вхождение подстроки). Example: `WELCOME`
sort_by	Type: string Поле для сортировки. Default: `created_at` Enum: `code`, `created_at`, `usage_count`
sort_direction	Type: string Направление сортировки. Default: `asc` Enum: `asc`, `desc`

Responses

200 OK

Список кодов группы промокодов.

Body

application/json

{
  "codes": [
    {
      "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d0",
      "code": "WELCOME10",
      "usage_count": 3,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-06-01T12:00:00Z"
    }
  ],
  "total_count": 500
}

Name

Description

codes

Type: PromocodeGroupCode[]

Список кодов промокодов в группе.

Example

[
  {
    "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d0",
    "code": "WELCOME10",
    "usage_count": 3,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-06-01T12:00:00Z"
  }
]

total_count

Type: integer

Общее количество кодов в группе (без учета пагинации).

PromocodeGroupCodeID

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

Type: string<uuid>

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

PromocodeGroupCode

Код промокода внутри группы.

Name	Description
code	Type: string Строковое значение кода промокода. Example: `WELCOME10`
created_at	Type: string<date-time> Дата и время создания кода (RFC 3339). Example: `2024-01-01T00:00:00Z`
id	Type: PromocodeGroupCodeID Уникальный идентификатор кода промокода. Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d0`
updated_at	Type: string<date-time> Дата и время последнего изменения кода (RFC 3339). Example: `2024-06-01T12:00:00Z`
usage_count	Type: integer Количество использований данного кода.

Example

{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d0",
  "code": "WELCOME10",
  "usage_count": 3,
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

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`

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

Отвязка объектов от группы промокодов

Добавление кода в группу промокодов