# Obtenha promoção resgatável por código

Obtém a promoção por um código promocional ou código de cupom.

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

## 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

  - `code` (string, required)
    Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.
    Example: "WINTER2021"

## Response 200 fields (application/json):

  - `bonus` (array,null)

  - `bonus.quantity` (number)
    Quantidade do item.

  - `bonus.sku` (string)
    SKU do item.

  - `discount` (object,null)
    Apenas para códigos promocionais.
    Example: {"discount":{"percent":"10.99"}}

  - `discount.percent` (string,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.
    Example: "10.00"

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

  - `discounted_items.discount` (object, required)

  - `discounted_items.discount.percent` (string, required)
    Percentual de desconto.

O preço do item do carrinho será diminuído usando um valor
calculado usando essa porcentagem e, em seguida, arredondado
para 2 casas decimais.
    Example: "10.00"

  - `external_id` (string)
    ID de promoção exclusivo. O external_id só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.
    Example: "coupon_external_id"

  - `is_enabled` (boolean)

  - `name` (object)
    Nome da promoção. Deve conter pares chave/valor
onde a chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e valor sendo uma cadeia de caracteres.
    Example: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

  - `promotion_periods` (array)
    Períodos de validade da promoção. Se múltiplos períodos forem especificados, tanto date_from quanto date_until são necessários.

  - `promotion_periods.date_from` (string, required)
    Data de início da promoção especificada.
    Example: "2020-08-11T10:00:00+03:00"

  - `promotion_periods.date_until` (string,null)
    Data de término da promoção especificada. Se definido como null, a promoção é indefinida. Pode ser null apenas se um único período de validade for especificado.
    Example: "2020-08-11T20:00:00+03:00"

  - `redeem_code_limit` (integer,null)
    Número de resgates por código.
    Example: 10

  - `redeem_total_limit` (integer,null)
    Limita o número total de cupons.
    Example: 10

  - `redeem_user_limit` (integer,null)
    Limita o número total de cupons resgatados por um único usuário.
    Example: 10

  - `total_limit_state` (object,null)
    Limites para cada código de cupom exclusivo.

  - `total_limit_state.available` (integer)
    O número restante de vezes que um cupom pode ser usado.
    Example: 3

  - `total_limit_state.reserved` (integer)
    O número reservado de um cupom.
    Example: 3

  - `total_limit_state.used` (integer)
    O número de vezes que um cupom é usado.
    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