---
metadata:
  - name: generator
    content: Diplodoc Platform v5.61.0
alternate:
  - https://yandex.ru/dev/kit/ru/openapi/Promokody/GetPromocodeById.md
  - href: https://yandex.ru/dev/kit/ru/openapi/Promokody/GetPromocodeById.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/dev/kit/ru/llms.txt
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/kit/ru/llms.txt

<div class="openapi">

# Получение промокода по уникальному идентификатору

<!-- markdownlint-disable-file -->

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

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://api.kit.yandex.net/v1/promocodes/{id}
```

</div>

</div>

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

Промокод.

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "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
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `HELLO5`
{.table-cell}
||
||

_created_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

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

_Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00Z`
{.table-cell}
||
||

_discount_value_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DiscountValue](#entity-DiscountValue)

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "value": "10.00",
  "type": "PERCENT"
}
```

{% endcut %}
{.table-cell}
||
||

_first_order_only_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Можно ли использовать промокод только для первого заказа.
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PromocodeID](#entity-PromocodeID)

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

_Example:_{.json-schema-reset .json-schema-example} `019b21d9-c5d9-777d-80bd-d67c664bc6d9`
{.table-cell}
||
||

_one_time_use_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Можно ли использовать промокод только один раз.
{.table-cell}
||
||

_promocode_dates_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PromocodeDates](#entity-PromocodeDates)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "start_date": "2025-01-01T00:00:00Z",
  "end_date": "2025-01-01T00:00:00Z"
}
```

{% endcut %}
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PromocodeStatus](#entity-PromocodeStatus)

Статус промокода:
- `ACTIVE` — активный.
- `INACTIVE` — неактивный.

_Enum:_{.json-schema-reset .json-schema-value} `ACTIVE`, `INACTIVE`
{.table-cell}
||
||

_title_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `Скидка 5% на все товары`
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [PromocodeType](#entity-PromocodeType)

Тип промокода:
- `ORDER` — промокод на заказ.
- `PRODUCTS` — промокод на товары.

_Enum:_{.json-schema-reset .json-schema-value} `ORDER`, `PRODUCTS`
{.table-cell}
||
||

_updated_at_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

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

_Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00Z`
{.table-cell}
||
||

_usage_count_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Количество использований промокода.
{.table-cell}
||
||

_binding_mode_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [PromocodeBindingMode](#entity-PromocodeBindingMode)

Режим применения промокода. Применим только для промокодов типа `PRODUCTS`:
- `ALL_VARIANTS` — промокод применяется ко всем товарам магазина.
- `SELECTED_VARIANTS` — промокод применяется к выбранным товарам.
- `SELECTED_CATEGORIES_COLLECTIONS` — промокод применяется к товарам из выбранных категорий и коллекций.

_Enum:_{.json-schema-reset .json-schema-value} `ALL_VARIANTS`, `SELECTED_VARIANTS`, `SELECTED_CATEGORIES_COLLECTIONS`
{.table-cell}
||
||

_max_discount_amount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;decimal&gt;

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

_Example:_{.json-schema-reset .json-schema-example} `1000`
{.table-cell}
||
||

_max_usage_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer

Максимальное количество использований промокода.
{.table-cell}
||
||

_minimum_order_amount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;decimal&gt;

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

_Example:_{.json-schema-reset .json-schema-example} `1000.00`
{.table-cell}
||
||

_show_in_pdp_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean

Показывать ли промокод на странице товара. Применим только для промокодов типа `PRODUCTS`.
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### PromocodeID {#entity-PromocodeID}

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

**Type**: string&lt;uuid&gt;

_Example:_{.json-schema-reset .json-schema-example} `019b21d9-c5d9-777d-80bd-d67c664bc6d9`

</div>

<div class="openapi-entity">

### DiscountValue {#entity-DiscountValue}

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

#|
|| **Name** | **Description** ||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Enum:_{.json-schema-reset .json-schema-value} `PERCENT`, `VALUE`
{.table-cell}
||
||

_value_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;decimal&gt;

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

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

_Example:_{.json-schema-reset .json-schema-example} `10.00`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "value": "10.00",
  "type": "PERCENT"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PromocodeDates {#entity-PromocodeDates}

#|
|| **Name** | **Description** ||
||

_start_date_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string&lt;date-time&gt;

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

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
||

_end_date_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

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

_Example:_{.json-schema-reset .json-schema-example} `2025-01-01T00:00:00Z`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "start_date": "2025-01-01T00:00:00Z",
  "end_date": "2025-01-01T00:00:00Z"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### PromocodeBindingMode {#entity-PromocodeBindingMode}

Режим применения промокода. Применим только для промокодов типа `PRODUCTS`:
- `ALL_VARIANTS` — промокод применяется ко всем товарам магазина.
- `SELECTED_VARIANTS` — промокод применяется к выбранным товарам.
- `SELECTED_CATEGORIES_COLLECTIONS` — промокод применяется к товарам из выбранных категорий и коллекций.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `ALL_VARIANTS`, `SELECTED_VARIANTS`, `SELECTED_CATEGORIES_COLLECTIONS`

</div>

<div class="openapi-entity">

### PromocodeStatus {#entity-PromocodeStatus}

Статус промокода:
- `ACTIVE` — активный.
- `INACTIVE` — неактивный.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `ACTIVE`, `INACTIVE`

</div>

<div class="openapi-entity">

### PromocodeType {#entity-PromocodeType}

Тип промокода:
- `ORDER` — промокод на заказ.
- `PRODUCTS` — промокод на товары.

**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `ORDER`, `PRODUCTS`

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `VALIDATION_ERROR`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Invalid input`
{.table-cell}
||
||

_trace_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `00000000000000000000000000000000`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__401">

## 401 Unauthorized

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `VALIDATION_ERROR`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Invalid input`
{.table-cell}
||
||

_trace_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `00000000000000000000000000000000`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__404">

## 404 Not Found

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `VALIDATION_ERROR`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Invalid input`
{.table-cell}
||
||

_trace_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `00000000000000000000000000000000`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `VALIDATION_ERROR`
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Invalid input`
{.table-cell}
||
||

_trace_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `00000000000000000000000000000000`
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.