Xsolla-logo

Criar promoção de cupomServer-sideAdmin

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

Cria uma promoção de cupom.

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.

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 cupom 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
application/json
{
  • "attribute_conditions": [
    ],
  • "bonus": [
    ],
  • "date_end": "2020-04-25T18:16:00+05:00",
  • "date_start": "2020-04-15T18:16:00+05:00",
  • "external_id": "coupon_external_id",
  • "name": {
    },
  • "redeem_code_limit": 1,
  • "redeem_total_limit": 100,
  • "redeem_user_limit": 1
}
Response samples
application/json
{
  • "external_id": "coupon_external_id"
}