# Применение промокода

Применяет промокод к корзине. При применении промокода стоимость корзины пересчитывается с учетом скидки (на всю корзину или отдельные товары), а также в нее могут быть добавлены бонусные товары. Скидка учитывается при оформлении заказа, а бонусные товары зачисляются пользователю после успешной оплаты. Пользователь может удалить промокод из корзины, отменив скидку и бонусные товары.

Endpoint: POST /v2/project/{project_id}/promocode/redeem
Version: 2.0.0
Security: AuthForCart

## Path parameters:

  - `project_id` (integer, required)
    ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com//projects/.
    Example: 44056

## Request fields (application/json):

  - `coupon_code` (string)
    Уникальный код промокода. Содержит буквы и цифры.
    Example: "SUMMER2021"

  - `cart` (object,null)

  - `cart.id` (string, required)
    ID корзины.

  - `selected_unit_items` (object)
    Игровой ключ для конкретной платформы, который выбрал пользователь в качестве бонуса. Передайте [полученный](/ru/api/liveops/promotions-coupons/get-coupon-rewards-by-code#promotions-coupons/get-coupon-rewards-by-code/t=response&c=200&path=bonus/item) bonus.item.sku в качестве ключа, а выбранный bonus.item.unit_items.sku в качестве его значения.

## Response 200 fields (application/json):

  - `cart_id` (string)
    ID корзины.
    Example: "cart_id"

  - `price` (object,null)
    Цена корзины.
    Example: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}

  - `price.amount` (string)
    Example: "6150.0000000000000000"

  - `price.amount_without_discount` (string)
    Example: "6150.0000000000000000"

  - `price.currency` (string)
    Example: "USD"

  - `is_free` (boolean)
    Является ли товар бесплатным.

  - `items` (array)
    Example: [{"attributes":[],"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":123,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[],"promotions":[{"name":"Bonus promotion","date_start":"2020-04-15T16:16:00+03:00","date_end":"2026-04-15T16:16:00+03:00","discount":{"percent":"50.00"},"bonus":[{"quantity":1,"name":"Xsolla Minigun","image_url":"https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png","sku":"com.xsolla.minigun_1","type":"virtual_good"}]}],"can_be_bought":true,"vp_rewards":[{"item_id":175232,"sku":"com.xsolla.value_point_1","amount":130,"name":"Value point","image_url":"https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg","is_clan":false},{"item_id":186321,"sku":"com.xsolla.clan_value_point_1","amount":50,"name":"Clan Reward VP 1","image_url":"https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg","is_clan":true}],"limits":{"per_user":{"available":3,"recurrent_schedule":{"interval_type":"weekly","reset_next_date":1746057600},"total":5}},"periods":[{"date_from":"2020-08-11T10:00:00+03:00","date_until":"2020-08-11T20:00:00+03:00"}]}]

  - `items.sku` (string)

  - `items.groups` (array)

  - `items.groups.external_id` (string)

  - `items.groups.name` (string)

  - `items.name` (string,null)

  - `items.type` (string)

  - `items.description` (string)

  - `items.image_url` (string)

  - `items.quantity` (integer)

  - `items.is_free` (boolean)
    Является ли товар бесплатным.

  - `items.promotions` (array)
    Примененные акции для отдельных товаров в корзине. Массив возвращается, если:

* Скидочная акция настроена для отдельного товара.

* Используется промокод с настройкой Скидка на выбранные товары.

Если акции на уровне отдельных товаров не применялись, возвращается пустой массив.

  - `items.promotions.name` (string)

  - `items.promotions.date_start` (string,null)

  - `items.promotions.date_end` (string,null)

  - `items.promotions.discount` (object,null)

  - `items.promotions.discount.percent` (string,null)

  - `items.promotions.discount.value` (string,null)

  - `items.promotions.bonus` (array)

  - `items.promotions.bonus.sku` (string)

  - `items.promotions.bonus.quantity` (integer)

  - `items.promotions.bonus.type` (string)
    Тип бонусного товара.
    Enum: "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft"

  - `items.promotions.bonus.name` (string)
    Название бонусного товара. Недоступно для типа бонусного товара physical_good.

  - `items.promotions.bonus.image_url` (string)
    URL-адрес изображения бонусного бандла. Недоступно для типа бонусного товара physical_good.

  - `items.promotions.bonus.bundle_type` (string)
    Тип товара бонусного бандла. Доступно только для бонусного товара типа bundle.
    Enum: "standard", "virtual_currency_package"

  - `items.promotions.limits` (object)

  - `items.promotions.limits.per_user` (object)

  - `items.promotions.limits.per_user.available` (integer)

  - `items.promotions.limits.per_user.total` (integer)

  - `items.can_be_bought` (boolean)
    Если true, пользователь может купить товар.

  - `items.vp_rewards` (array)
    Список призовых баллов для товара.

  - `items.vp_rewards.item_id` (integer)
    Внутренний уникальный ID виртуального предмета или валюты.

  - `items.vp_rewards.sku` (string)
    Уникальный ID призовых баллов.

  - `items.vp_rewards.amount` (integer)
    Количество призовых баллов.

  - `items.vp_rewards.name` (string)
    Название призовых баллов.

  - `items.vp_rewards.image_url` (string)
    URL-адрес изображения.

  - `items.vp_rewards.is_clan` (boolean)
    Может ли призовой балл использоваться в цепочках наград для клана.

  - `items.loyalty_rewards` (array)
    Баллы лояльности, которые пользователь получает в награду за покупку товара.

  - `items.loyalty_rewards.name` (string)
    Название баллов лояльности.

  - `items.loyalty_rewards.sku` (string)
    Артикул балла лояльности. Используйте это значение в параметре loyalty_point_sku в других запросах API, например при создании заказа, оплачиваемого баллами лояльности.

  - `items.loyalty_rewards.description` (string)
    Описание баллов лояльности.

  - `items.loyalty_rewards.image_url` (string,null)
    URL-адрес изображения.

  - `items.loyalty_rewards.amount` (integer)
    Количество баллов лояльности, которое пользователь получает за покупку товара.

  - `items.limits` (object,null)
    Ограничения на продажу товара.

  - `items.limits.per_user` (object,null)
    Ограничения на продажу товара для пользователя.

  - `items.limits.per_user.total` (integer)
    Максимальное количество товара, которое может приобрести один пользователь.
    Example: 5

  - `items.limits.per_user.available` (integer)
    Оставшееся количество товара, которое может приобрести текущий пользователь.
    Example: 3

  - `items.limits.per_user.recurrent_schedule` (any)

  - `items.limits.per_user.limit_exceeded_visibility` (string)
    Определяет видимость товара в каталоге после достижения лимита покупок до момента следующего обновления лимитов.

Применяется к товарам, для которых задано регулярное обновление лимитов в массиве recurrent_schedule.

Если обновление лимитов не задано, товар не отображается в каталоге после достижения лимита независимо от значения limit_exceeded_visibility.

Возможные значения:
- show — Товар возвращается в методах получения каталога товаров после достижения лимита покупок. В клиентских методах получения каталога после достижения лимита товар возвращается с флагом can_be_bought: false. Дата следующего сброса возвращается в reset_next_date.
- hide — Товар не возвращается в методах получения каталога товаров после достижения лимита покупок до момента сброса лимитов.
    Enum: "show", "hide"

  - `items.limits.per_item` (object,null)
    Ограничения на продажу для конкретного товара.

  - `items.limits.per_item.total` (integer)
    Максимальное количество товара, которое могут приобрести все пользователи.
    Example: 5

  - `items.limits.per_item.available` (integer)
    Оставшееся количество товара, которое могут приобрести все пользователи.
    Example: 3

  - `items.periods` (array,null)
    Период продажи товара.

  - `items.periods.date_from` (string)
    Дата, когда указанный товар будет доступен для продажи.
    Example: "2020-08-11T10:00:00+03:00"

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

  - `rewards` (object)

  - `rewards.bonus` (array)

  - `rewards.bonus.item` (object)

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

  - `rewards.bonus.item.name` (string)
    Название товара.
    Example: "Game name"

  - `rewards.bonus.item.type` (string)
    Тип товара. Возможные значения:virtual_good — виртуальные товары;virtual_currency — виртуальная валюта;bundle — бандл;unit — пакет игровых ключей.
    Example: "unit"

  - `rewards.bonus.item.description` (string)
    Описание товара.
    Example: "Game description"

  - `rewards.bonus.item.image_url` (string)
    URL-адрес изображения.
    Example: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"

  - `rewards.bonus.item.unit_items` (array)
    Массив с игровыми ключами для конкретных платформ. Используется только если тип товара — unit (bonus.item.type = 'unit'). Если пакет содержит ключи для нескольких платформ, пользователь может выбрать один из них в качестве бонуса.

  - `rewards.bonus.item.unit_items.sku` (string)
    Артикул пакета игровых ключей для конкретной платформы. Допустимые символы: a–z, A–Z, 0–9, точка (.), дефис (-), подчеркивание (_). Состоит из значений bonus.item.​sku и bonus.item.unit_items.drm_sku. Например, если bonus.item.​sku = 'cool_game' и bonus.item.unit_items.drm_sku = 'steam', значение будет cool_game_steam.
    Example: "cool_game_steam"

  - `rewards.bonus.item.unit_items.is_free` (boolean)

  - `rewards.bonus.item.unit_items.type` (string)
    Параметр для обозначения игровых ключей.
    Enum: "game_key"

  - `rewards.bonus.item.unit_items.name` (string)
    Название игры.
    Example: "Awesome Game"

  - `rewards.bonus.item.unit_items.drm_name` (string)
    Название платформы распространения игры.
    Example: "Steam"

  - `rewards.bonus.item.unit_items.drm_sku` (string)
    Уникальный ID платформы распространения игры. Используется как суффикс для обозначения ключей для конкретных платформ. Допустимые символы: a–z, A–Z, 0–9, точка (.), дефис (-), подчеркивание (_).
    Example: "steam"

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

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

  - `rewards.discount.percent` (string)
    Example: "10.00"

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

  - `rewards.discounted_items.sku` (string, required)
    Артикул товара.

  - `rewards.discounted_items.discount` (object, required)

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

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

  - `rewards.is_selectable` (boolean)
    Если true, пользователь должен выбрать бонус перед погашением промокода.

## Response 401 fields (application/json):

  - `statusCode` (integer)
    Example: 401

  - `errorCode` (integer)
    Example: 1501

  - `errorMessage` (string)
    Example: "[0401-1501]: Authorization failed: Provide authorization"

## Response 403 fields (application/json):

  - `statusCode` (integer)
    Example: 403

  - `errorCode` (integer)

  - `errorMessage` (string)
    Example: "Authorization header not sent."

  - `transactionId` (string)
    Example: "x-x-x-x-transactionId-mock-x-x-x"

## Response 404 fields (application/json):

  - `statusCode` (integer)
    Example: 404

  - `errorCode` (integer)
    Example: 4001

  - `errorMessage` (string)
    Example: "[0401-9807]: Enter valid promo code."

## Response 422 fields (application/json):

  - `statusCode` (integer)
    Example: 422

  - `errorCode` (integer)
    Example: 1102

  - `errorMessage` (string)
    Example: "[0401-1102]: Unprocessable Entity. The property `coupon_code` is required"

  - `transactionId` (string)
    Example: "x-x-x-x-transactionId-mock-x-x-x"