# Информация об акции с кодом

Получение акции по промокоду или коду купона.

Endpoint: GET /v3/project/{project_id}/admin/promotion/redeemable/code/{code}
Version: 2.0.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
    Example: 44056

  - `code` (string, required)
    Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
    Example: "WINTER2021"

## Response 200 fields (application/json):

  - `bonus` (array,null)

  - `bonus.quantity` (number)
    Количество товаров.

  - `bonus.sku` (string)
    Артикул товара.

  - `discount` (object,null)
    Только для промокодов.
    Example: {"discount":{"percent":"10.99"}}

  - `discount.percent` (string,null)
    Процент скидки. 
Цена корзины будет уменьшена с использованием значения, рассчитанного с использованием этого процента, а затем округлена до 2 знаков после запятой.
    Example: "10.00"

  - `discounted_items` (array,null)
    Список товаров, на которые действует скидка по промокоду. Только для промокодов.

  - `discounted_items.discount` (object, required)

  - `discounted_items.discount.percent` (string, required)
    Процент скидки. 

Цена товара в корзине будет уменьшена с использованием значения, 
рассчитанного с использованием этого процента, а затем округлена 
до 2 знаков после запятой.
    Example: "10.00"

  - `external_id` (string)
    Уникальный ID акции. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.
    Example: "coupon_external_id"

  - `is_enabled` (boolean)

  - `name` (object)
    Название акции. Данный параметр должен содержать пары ключ/значение, 
где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
    Example: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

  - `promotion_periods` (array)
    Периоды действия акции. Если указано больше одного периода, параметры date_from и date_until становятся обязательными.

  - `promotion_periods.date_from` (string, required)
    Дата начала действия указанной акции.
    Example: "2020-08-11T10:00:00+03:00"

  - `promotion_periods.date_until` (string,null)
    Дата окончания действия указанной акции. Если передано значение null, акция является бессрочной. Может быть null, только если указан один период действия.
    Example: "2020-08-11T20:00:00+03:00"

  - `redeem_code_limit` (integer,null)
    Количество погашений по коду.
    Example: 10

  - `redeem_total_limit` (integer,null)
    Ограничивает общее количество купонов.
    Example: 10

  - `redeem_user_limit` (integer,null)
    Ограничивает общее количество купонов, погашаемых одним пользователем.
    Example: 10

  - `total_limit_state` (object,null)
    Ограничения для каждого уникального кода купона.

  - `total_limit_state.available` (integer)
    Оставшееся количество использований купона.
    Example: 3

  - `total_limit_state.reserved` (integer)
    Зарезервированное количество купонов.
    Example: 3

  - `total_limit_state.used` (integer)
    Сколько раз использовался купон.
    Example: 5

## Response 401 fields (application/json):

  - `errorCode` (integer)
    Example: 1020

  - `errorMessage` (string)
    Example: "[0401-1020]: Error in Authentication method occurred"

  - `statusCode` (integer)
    Example: 401

## Response 404 fields (application/json):

  - `errorCode` (integer)
    Example: 9811

  - `errorMessage` (string)
    Example: "[0401-9811]: Code not found."

  - `statusCode` (integer)
    Example: 404

## Response 405 fields (application/json):

  - `errorCode` (integer)

  - `errorMessage` (string)
    Example: "Method is not allowed. Method must be one of: OPTIONS"

  - `statusCode` (integer)
    Example: 405