# Obter lista de promoções de códigos promocionais

Obtém a lista de códigos promocionais de um projeto.

Endpoint: GET /v3/project/{project_id}/admin/promocode
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

## Query parameters:

  - `limit` (integer)
    Limite da quantidade de elementos na página.
    Example: 50

  - `offset` (integer)
    Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

## Response 200 fields (application/json):

  - `active_promotions_count` (integer)
    Número de promoções ativas.

  - `inactive_promotions_count` (integer)
    Número de promoções desativadas.

  - `items` (array)

  - `items.attribute_conditions` (array)
    Condições para validação de atributos do usuário.
Determine a disponibilidade da promoção com base em se os atributos do usuário correspondem a todas as condições especificadas.

  - `items.bonus` (array,null)

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

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

  - `items.discount` (object,null)
    Example: {"discount":{"percent":"10.99"}}

  - `items.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"

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

  - `items.excluded_promotions` (array)
    Lista de IDs de promoção a serem excluídos ao aplicar esta promoção. Example: [12, 789]
    Example: [12,789]

  - `items.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"

  - `items.is_enabled` (boolean)

  - `items.item_price_conditions` (array,null)
    Conjunto de objetos com condições que definem a faixa de preço para aplicar a promoção a determinados itens no carrinho.
 O preço de cada item no carrinho do usuário é comparado com a faixa de preço especificada na condição. [Bônus](/pt/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) e [descontos](/pt/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) são aplicados somente aos itens no carrinho cujo preço atende à condição.
 Se você passar esta matriz, defina o valor da matriz [discounted_items](/pt/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request) como null.

  - `items.item_price_conditions.operator` (string, required)
    Operador de comparação para definir a faixa de preço para aplicar a promoção.
    Enum: "ge", "gt", "le", "lt", "eq", "ne"

  - `items.item_price_conditions.value` (string, required)
    Valor para determinar a faixa de preço para aplicar a promoção.

  - `items.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"}

  - `items.price_conditions` (array,null)
    Matriz de objetos com condições que definem a faixa de preço para aplicar a promoção ao carrinho inteiro.
 O preço total de todos os itens no carrinho do usuário é comparado com a faixa de preço especificada na condição. [Bônus](/pt/api/shop-builder/operation/create-promo-code/#!path=bonus&t=request) e [descontos](/pt/api/shop-builder/operation/create-promo-code/#!path=discount&t=request) são aplicados a todos os itens no carrinho se o preço do carrinho atender à condição especificada.
 Se você passar esta matriz, defina o valor da matriz [discounted_items](/pt/api/shop-builder/operation/create-promo-code/#!path=discounted_items&t=request) como null.

  - `items.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.

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

  - `items.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"

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

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

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

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

  - `items.total_limit_state.available` (integer)
    O número restante de vezes que um código promocional pode ser usado.
    Example: 3

  - `items.total_limit_state.reserved` (integer)
    O número reservado de um código promocional.
    Example: 3

  - `items.total_limit_state.used` (integer)
    O número de vezes que um código promocional é usado.
    Example: 5

  - `total_promotions_count` (integer)
    Número total de promoções.

## Response 401 fields (application/json):

  - `errorCode` (integer)
    Example: 1020

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

  - `statusCode` (integer)
    Example: 401