Promoção de cupom de atualização

Promoção de cupom de atualizaçãoServer-sideAdmin

put/v3/project/{project_id}/admin/coupon/{external_id}

Atualiza 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
external_id required	integer ID externo de promoção. Identificador exclusivo da promoção dentro do projeto. Example: coupon_44056_1

Request Body schema: application/json

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

Array of objects or null

Array

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

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.

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

204

O cupom foi atualizado 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.

404

Cupom não encontrado. Verifique se o external_id está correto.

422

Solicitação inválida.

Request samples

application/json

{"attribute_conditions": [{"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [{"quantity": 1,
"sku": "com.xsolla.elven_sword_2"
}
],
"name": {"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"promotion_periods": [{"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1
}

Response samples

application/json

{"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"statusCode": 401
}