Criar promoção de código promocional

Criar promoção de código promocionalServer-sideAdmin

post/v2/project/{project_id}/admin/promocode

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

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Example: 44056

Request Body schema: application/json

external_id

required

string

Default: "coupon_external_id"

ID de promoção exclusivo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, pontos, traços e sublinhados.

required

object

Default: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}

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.

property name*

additional property

string

Array of tipo = string (objects) or Array of tipo = data (objects) or Array of tipo = number (objects)

Condições que são comparadas aos valores de atributo do usuário. Devem estar reunidas todas as condições para que a ação entre em efeito.

One of:

Condições que são comparadas aos valores de atributo do usuário. Devem estar reunidas todas as condições para que a ação entre em efeito.

[ 1 .. 100 ] items

Array ([ 1 .. 100 ] items)

attribute

required

string [ 1 .. 255 ] characters ^[-_.\\d\\w]+$

Código de atributo do usuário.

operator

required

string

Tipo de operação realizada por condição. Para o tipo de atributo string.

Enum:	Description
eq	Iguais
ne	Não são iguais

value

required

string <= 255 characters

Valor da condição com o qual o valor do atributo do usuário será comparado. O tipo depende do tipo de atributo.

type

required

string

Tipo de atributo de usuário.

Value: "string"

can_be_missing

boolean

Indica que a condição é atendida mesmo se o atributo estiver ausente dos atributos do usuário. Passe true para mostrar o item aos usuários que não têm esse atributo. Os usuários que têm o atributo, mas o valor não corresponder ao especificado na condição, não verão o item. false — os usuários que têm o atributo, mas o valor não corresponder ao especificado na condição, ou o atributo estiver ausente, não verão o item.

Array of objects or null

Array

quantity	number Default: 1 Quantidade do item.
sku	string Default: "elven_shield" SKU do item.

date_end

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Data em que sua promoção será concluída. Pode ser null. Se date_end for null, a promoção terá um tempo ilimitado.

date_start

string or null <date-time>

Default: "2020-04-15T18:16:00+05:00"

Data em que sua promoção será iniciada.

object or null

percent

string or null

Default: "10.00"

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.

Array of objects or null

Lista de itens que são descontados por um código promocional.

Array

sku

required

string

Default: "elven_shield"

SKU do item.

required

object

percent

required

string

Default: "10.00"

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.

excluded_promotions

Array of integers

Lista de IDs de promoção a serem excluídos ao aplicar esta promoção.
Example: [12, 789]

Array of objects or 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 e descontos 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 como null.

Array

operator

required

string

Operador de comparação para definir a faixa de preço para aplicar a promoção.

Enum:	Description
eq	Iguais
ge	Maior ou igual
gt	Maior que
le	Menor ou igual
lt	Menos de
ne	Diferentes

value

required

string^\\d+(\\.\\d{1,4})?$

Valor para determinar a faixa de preço para aplicar a promoção.

Array of objects or 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 e descontos 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 como null.

Array

operator

required

string

Operador de comparação para definir a faixa de preço para aplicar a promoção.

Enum:	Description
eq	Iguais
ge	Maior ou igual
gt	Maior que
le	Menor ou igual
lt	Menos de
ne	Diferentes

value

required

string^\\d+(\\.\\d{1,4})?$

Valor para determinar a faixa de preço para aplicar a promoção.

redeem_code_limit

integer or null

Default: 10

Número de resgates por código.

redeem_total_limit

integer or null

Default: 10

Limita o número total de cupons.

redeem_user_limit

integer or null

Default: 10

Limita o número total de cupons resgatados por um único usuário.

Responses

201

O código promocional foi criado com sucesso.

401

Autenticação básica não aprovada ou errada. Verifique se você usou a autenticação básica ou as credenciais corretas.

422

Solicitação inválida.

Request samples

Response samples

application/json

{"external_id": "coupon_external_id"
}