# Resgatar código promocional

Resgata um código promocional de promoção.
Depois de resgatar um código promocional, o usuário receberá itens gratuitos e/ou o preço do carrinho e/ou itens específicos será diminuído.

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

## Path parameters:

  - `project_id` (integer, required)
    ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
    Example: 44056

## Request fields (application/json):

  - `cart` (object,null)

  - `cart.id` (string, required)
    ID do carrinho.

  - `coupon_code` (string)
    Código exclusivo do código promocional. Contém letras e números.
    Example: "SUMMER2021"

  - `selected_unit_items` (object)
    A recompensa selecionada por um usuário.
A chave de objeto é um SKU de uma unidade, e o valor é um SKU de um dos itens em uma unidade.
    Example: {"game_1":"game_1_steam","game_2":"game_2_playstation"}

## Response 200 fields (application/json):

  - `cart_id` (string)
    ID do carrinho.
    Example: "cart_id"

  - `is_free` (boolean)
    Se true, o item é gratuito.

  - `items` (array)
    Example: [{"attributes":[],"can_be_bought":{"$ref":"../schemas/Can_be_bought.yaml"},"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,"limits":{"$ref":"../schemas/Catalog_item_limits.yaml"},"name":"Xsolla Booster Mega","periods":{"$ref":"../schemas/item-periods.yaml"},"price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"promotions":{"$ref":"../schemas/Catalog_item_promotions.yaml"},"quantity":123,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[],"vp_rewards":{"$ref":"../schemas/reward-chain-client/client-item-value-point-reward.yaml"}}]

  - `items.can_be_bought` (boolean)
    Se true, o usuário pode comprar um item.
    Example: true

  - `items.description` (string)

  - `items.groups` (array)

  - `items.groups.external_id` (string)

  - `items.groups.name` (string)

  - `items.image_url` (string)

  - `items.limits` (object,null)
    Limites de itens.

  - `items.limits.per_item` (object,null)
    Limites de item para um item.

  - `items.limits.per_item.available` (integer)
    Quantidade restante de itens que todos os usuários podem comprar.
    Example: 3

  - `items.limits.per_item.total` (integer)
    Quantidade máxima de itens que todos os usuários podem comprar.
    Example: 5

  - `items.limits.per_user` (object,null)
    Limites de item para um usuário.

  - `items.limits.per_user.available` (integer)
    Quantidade restante de itens que o usuário atual pode comprar.
    Example: 3

  - `items.limits.per_user.limit_exceeded_visibility` (string)
    Determina a visibilidade do item no catálogo após o limite de compra ser atingido, até o próximo limite ser redefinido.

Aplica-se a itens para os quais redefinições recorrentes de limite estão configurados na matriz recurrent_schedule.

Se as redefinições do limite não forem configuradas, o item não aparece no catálogo após o limite de compra ser atingido, independentemente do valor de limit_exceeded_visibility.
    Enum: "show", "hide"

  - `items.limits.per_user.recurrent_schedule` (object)
    O item limita o período de atualização recorrente para um usuário.

  - `items.limits.per_user.recurrent_schedule.interval_type` (string)
    Tipo de período de atualização recorrente.
    Enum: "daily", "weekly", "monthly", "hourly"

  - `items.limits.per_user.recurrent_schedule.reset_next_date` (integer)
    Data e hora em que os limites são redefinidos (Unix Timestamp).
    Example: 1677553200

  - `items.limits.per_user.total` (integer)
    Quantidade máxima de itens que o usuário atual pode comprar.
    Example: 5

  - `items.periods` (array,null)
    Período de venda de itens.

  - `items.periods.date_from` (string)
    Data em que o item especificado estará disponível para venda.
    Example: "2020-08-11T10:00:00+03:00"

  - `items.periods.date_until` (string,null)
    Data em que o item especificado ficará indisponível para venda. Pode ser null.
    Example: "2020-08-11T20:00:00+03:00"

  - `items.promotions` (array)
    Promoções aplicadas a itens específicos no carrinho. A matriz é retornada nos seguintes casos:

* Uma promoção de desconto é configurada para um item específico.

* Um código promocional com a configuração Desconto em itens selecionados é aplicado.

Se nenhuma promoção no nível do item for aplicada, é retornada uma matriz vazia.

  - `items.promotions.bonus` (array)

  - `items.promotions.bonus.bundle_type` (string)
    Tipo de item de pacote de bônus. Disponível apenas para o tipo de item bônus bundle.
    Enum: "standard", "virtual_currency_package"

  - `items.promotions.bonus.image_url` (string)
    URL da imagem do item bônus. Indisponível para o tipo de item bônus physical_good.

  - `items.promotions.bonus.name` (string)
    Nome do item bônus. Indisponível para o tipo de item bônus physical_good.

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

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

  - `items.promotions.bonus.type` (string)
    Tipo de item bônus.
    Enum: "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft"

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

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

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

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

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

  - `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.type` (string)

  - `items.vp_rewards` (array)
    Recompensa do item de ponto de valor.

  - `items.vp_rewards.amount` (integer)
    Quantidade de pontos de valor.

  - `items.vp_rewards.image_url` (string)
    URL da imagem.
    Example: "https://image.example.com"

  - `items.vp_rewards.is_clan` (boolean)
    Se o ponto de valor é usado em cadeias de recompensa de clã ou não.
    Example: true

  - `items.vp_rewards.item_id` (integer)
    ID de item exclusivo interno.
    Example: 1

  - `items.vp_rewards.name` (string)
    Nome do ponto de valor.

  - `items.vp_rewards.sku` (string)
    ID de ponto de valor exclusivo.

  - `price` (object,null)
    Preço do carrinho.
    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"

  - `rewards` (object)

  - `rewards.discount` (object,null)
    Percentual de desconto.
O preço do carrinho será reduzido usando um valor calculado usando essa porcentagem e, em seguida, arredondado para 2 casas decimais.

  - `rewards.discounted_items` (array,null)
    Lista de itens que são descontados por um código promocional.

  - `rewards.discounted_items.sku` (string, required)
    SKU do item.

  - `rewards.is_selectable` (boolean)
    Se true, o usuário deve escolher o bônus antes de resgatar um código promocional.

## Response 401 fields (application/json):

  - `errorCode` (integer)
    Example: 1501

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

  - `statusCode` (integer)
    Example: 401

## Response 403 fields (application/json):

  - `errorCode` (integer)

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

  - `statusCode` (integer)
    Example: 403

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

## Response 404 fields (application/json):

  - `errorCode` (integer)
    Example: 4001

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

  - `statusCode` (integer)
    Example: 404

## Response 422 fields (application/json):

  - `errorCode` (integer)
    Example: 1102

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

  - `statusCode` (integer)
    Example: 422

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