Xsolla-logo

Criar promoção de bônusServer-sideAdmin

post/v2/project/{project_id}/admin/promotion/bonus

Cria a promoção de bônus.

A promoção adiciona itens bônus gratuitos à compra feita por um usuário. A promoção pode ser aplicada a cada compra dentro de um projeto ou a uma compra que inclua itens específicos.

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
required
Array of objects or null

Conjunto de itens que devem ser incluídos na compra para aplicar uma promoção. Se esse parâmetro for null, uma promoção será aplicada a todas as compras dentro de um projeto.

Array
sku
string
Default: "elven_sword"

SKU do item.

required
Array of objects or null
Array
quantity
number
Default: 1

Quantidade do item.

sku
string
Default: "elven_shield"

SKU do item.

required
object

Nome da promoção. Deve conter pares chave/valor onde chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e o valor é 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)
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.

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 não terá limite de tempo.

date_start
string or null <date-time>
Default: "2020-04-15T18:16:00+05:00"

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

id
integer

ID de promoção. Identificador exclusivo da promoção dentro do projeto.

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.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)
One of:

Tipo diário de atualização de limites de usuário.

interval_type
required
string

Período de atualização recorrente.

Value: "daily"
time
required
string((0[0-9]|1[0-9]|2[0-3]):00:00)(\+|-)(0[0-9]|1...

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

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": [
    ],
  • "bonus": [
    ],
  • "condition": [
    ],
  • "date_end": "2020-04-25T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "name": {
    }
}
Response samples
application/json
{
  • "promotion_id": 2384756
}