Xsolla-logo
ou
Conta de Distribuidor

Criar promoção de desconto para itemServer-sideAdmin

post/v3/project/{project_id}/admin/promotion/item

Cria uma promoção de desconto para um item.

As promoções oferecem um desconto (%) nos itens. O desconto será aplicado a todos os preços dos itens especificados.

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

Objeto com dados de promoção.

required
Array of objects
Array
sku
required
string
Default: "elven_sword"

SKU do item.

required
object
percent
required
string

Percentual de desconto. O preço do item será diminuído usando um valor calculado usando essa porcentagem e, em seguida, arredondado para 2 casas decimais.

required
object

Nome da promoção. Deve conter pares chave/valor, onde chave é a localidade com o formato "^[a-z]{2}-[A-Z]{2}$", e o valor é uma cadeia de caracteres.

property name*
additional property
string
Array of tipo = string (object) or tipo = number (object) or tipo = data (object) [ 1 .. 100 ] items

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.

Array ([ 1 .. 100 ] items)
One of:
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

Diferentes

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.

excluded_promotions
Array of integers

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

is_enabled
boolean

Se a promoção está habilitada ou não.

object

Limites da promoção.

per_user
integer or null

Limitação de promoção para um usuário separado.

object or null

Limite o período de atualização.

object

Período de atualização do limite do usuário.

day_of_month
integer or null [ 1 .. 31 ]

Dia do mês em que os limites são atualizados. Se não houver um dia selecionado do mês por ser mais curto, a atualização ocorrerá no último dia do mês. Não null apenas para o tipo de período de atualização de limite monthly.

day_of_week
integer or null [ 1 .. 7 ]

Dia da semana em que os limites se atualizam. Onde 1 é segunda-feira e 7 é domingo. Não null apenas para o tipo de período de atualização de limite weekly.

displayable_reset_next_date
string <date-time>

Data e hora em que os limites devem ser redefinidos (ISO 8601).

displayable_reset_start_date
string <date-time>

Data e hora da primeira atualização de limite (ISO 8601).

interval_type
string

Tipo de período de atualização recorrente.

Enum: "daily" "weekly" "monthly"
reset_next_date
integer

Data e hora em que os limites são atualizados (Unix Timestamp).

time
string <full-time>

Tempo de atualização do limite no fuso horário desejado (arredondamento para horas).

Array of objects or null

Matriz de objetos com condições que definem a faixa de preço para aplicar a promoção.
A promoção se aplica apenas a itens cujo preço atenda a todas as condições da matriz. Se você passar essa matriz, defina o valor do objeto 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

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

Array
date_from
required
string <date-time>

Data de início da promoção especificada.

date_until
string or null <date-time>

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.

Responses
201

Promoção criada 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
application/json
{
  • "attribute_conditions": [
    ],
  • "discount": {
    },
  • "is_enabled": true,
  • "items": [ ],
  • "name": {
    },
  • "promotion_periods": [
    ]
}
Response samples
application/json
{
  • "promotion_id": 2384756
}