# Criar promoção de código promocional

Cria uma promoção de código promocional.

Endpoint: POST /v3/project/{project_id}/admin/promocode
Version: 2.0.0
Security: basicAuth

## Path parameters:

  - `project_id` (integer, required)
    ID de projeto. Você pode encontrar esse parâmetro na sua Conta de Distribuidor, próximo ao nome do projeto e na barra de endereços do navegador ao trabalhar com um projeto. O URL tem o seguinte formato: https://publisher.xsolla.com//projects/.
    Example: 44056

## Request fields (application/json):

  - `external_id` (string, required)
    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.

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

  - `name` (object, required)
    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.

  - `bonus` (array,null)

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

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

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

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

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

  - `discount` (object,null)
    Example: {"percent":"10.10"}

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

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

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

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

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

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

  - `price_conditions.operator` (string, required)
    Operador de comparação para definir a faixa de preço para aplicar a promoção.

Possíveis valores:
- ge — Maior ou igual
- gt — Maior do que
- le — Menor ou igual
- lt — Menor do que
- eq — Equivalente
- ne — Não equivalente
    Enum: "ge", "gt", "le", "lt", "eq", "ne"

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

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

  - `item_price_conditions.operator` (string, required)
    Operador de comparação para definir a faixa de preço para aplicar a promoção.

Possíveis valores:
- ge — Maior ou igual
- gt — Maior do que
- le — Menor ou igual
- lt — Menor do que
- eq — Equivalente
- ne — Não equivalente
    Enum: "ge", "gt", "le", "lt", "eq", "ne"

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

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

## Response 201 fields (application/json):

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

## Response 401 fields (application/json):

  - `statusCode` (integer)
    Example: 401

  - `errorCode` (integer)
    Example: 1020

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

## Response 422 fields (application/json):

  - `statusCode` (integer)
    Example: 422

  - `errorCode` (integer)
    Example: 1102

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