Nombre de la promoción. Debe contener pares clave/valor
en los cuales la clave es una configuración regional con el formato "^[a-z]{2}-[A-Z]{2}$", el valor es una cadena (string).
property name*
additional property
string
Array of tipo = string (object) or tipo = number (object) or tipo = date (object) [ 1 .. 100 ] items
Condiciones para validar los atributos de usuario.
Determina la disponibilidad de la promoción en función de si los atributos de usuario cumplen todas las condiciones especificadas.
Array ([ 1 .. 100 ] items)
One of:
attribute
required
string [ 1 .. 255 ] characters ^[-_.\d\w]+$
Código de atributo de usuario.
operator
required
string
Tipo de operación realizada por condición. Para el tipo de atributo string.
Enum:
Description
eq
Igual que
ne
No es igual que
value
required
string <= 255 characters
Valor de la condición con el que se comparará el valor de atributo del usuario. El tipo depende del tipo de atributo.
type
required
string
Tipo de atributo de usuario.
Value:"string"
can_be_missing
boolean
Indica que se cumple la condición aunque falte el atributo en los atributos del usuario. Transmita true para mostrar el elemento a los usuarios que no tengan este atributo. Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, no verán el artículo. false - Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, o falte el atributo, no verán el artículo.
Array of objects or null
Array
quantity
number
Default: 1
Cantidad del artículo.
sku
string
Default: "elven_shield"
SKU del artículo.
Array of objects
Periodos de validez de la promoción. Si se especifican varios periodos, es necesario tanto date_from como date_until.
Array
date_from
required
string <date-time>
Fecha de inicio de la promoción especificada.
date_until
string or null <date-time>
Fecha de finalización de la promoción especificada. Si se establece como null, la promoción es indefinida. Puede ser null solamente si se especifica un único periodo de validez.
redeem_code_limit
integer or null
Default: 10
Número de canjes por cada código.
redeem_total_limit
integer or null
Default: 10
Limita el número total de cupones.
redeem_user_limit
integer or null
Default: 10
Limita el número total de cupones canjeados por un mismo usuario.
Responses
204
El cupón se actualizó correctamente.
401
Autenticación básica no superada o errónea. Asegúrese de haber utilizado la autenticación básica o las credenciales correctas.
404
Cupón no encontrado. Asegúrese de que el external_id es correcto.
422
Solicitud no válida.
Request samples
Payload
curl
JavaScript
Node.js
Python
C#
Go
Java
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
401
404
422
application/json
{
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",