Create reward chain

Create reward chainServer-sideAdmin

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

Creates reward chain.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

ID del proyecto. Encontrará este parámetro en su cuenta Publisher junto al nombre del proyecto.

Example: 44056

Request Body schema: application/json

One of:

Una cadena de recompensas.

required

object

Objeto con traducciones para el nombre del artículo. Código de idioma de dos letras minúsculas.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

required

object

sku

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$

ID único del artículo. El código de un artículo (SKU) solo puede contener caracteres alfanuméricos latinos en minúsculas, puntos, guiones y guiones bajos.

date_start

required

string <date-time>

Fecha de inicio de su cadena de recompensas.

required

Array of objects

Array

required

object

Objeto con traducciones para el nombre del artículo. Código de idioma de dos letras minúsculas.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

required

object

amount

required

integer

Precio del paso en puntos de valor.

required

Array of objects

Array

sku required	string [ 1 .. 255 ] characters ^[a-zA-Z0-9_\\-–.]*$ ID único del artículo. El código de un artículo (SKU) solo puede contener caracteres alfanuméricos latinos en minúsculas, puntos, guiones y guiones bajos.
quantity required	integer Item quantity.

image_url

string or null

URL de la imagen.

is_enabled

required

boolean

date_end

string or null <date-time>

Fecha en la que finaliza la promoción de su cadena de recompensas. Puede ser null. Si date_end es null, la cadena de recompensas será ilimitada en el tiempo.

object

Objeto con traducciones para la descripción del artículo. Código de idioma de dos letras minúsculas.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

image_url

string or null

URL de la imagen.

object

Objeto con traducciones para la descripción larga del artículo. Código de idioma de dos letras minúsculas.

ar	string or null
bg	string or null
cn	string or null
cs	string or null
de	string or null
en	string or null
es	string or null
fr	string or null
he	string or null
it	string or null
ja	string or null
ko	string or null
pl	string or null
pt	string or null
ro	string or null
ru	string or null
th	string or null
tr	string or null
tw	string or null
vi	string or null

order

integer

Define el orden de disposición.

(interval_type = semanal (object or null)) or (interval_type = mensual (object or null))

Periodo de reinicio recurrente de la cadena de recompensas.

One of:

Tipo semanal de actualización de la cadena de recompensas.

interval_type required	string Frecuencia del reinicio recurrente de la cadena de recompensas. Value: "weekly"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Hora a la que se restablece la cadena de recompensas en la zona horaria deseada (redondeo a horas). Por ejemplo, la hora establecida para el reinicio de la cadena de recompensas es la 01:00 para la zona horaria de Kuala Lumpur (GMT+8). En este caso, el valor del parámetro `time` es `01:00:00+08:00`.
day_of_week required	integer [ 1 .. 7 ] Día de la semana en que se reinicia la cadena de recompensas; en cuyo sistema el "1" es lunes y el "7" es domingo.

Responses

201

Reward chain was successfully created.

401

Autenticación básica no superada o errónea. Asegúrese de haber utilizado la autenticación básica o las credenciales correctas.

422

Invalid request.

Request samples

application/json

{"clan_type": "guild",
"date_end": "2021-04-15T18:16:00+05:00",
"date_start": "2020-04-15T18:16:00+05:00",
"description": {"en": "Clan reward chain description."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {"en": "Clan reward chain long description."
},
"name": {"en": "Clan reward chain"
},
"order": 1,
"popup_header": {"en": "How to unlock rewards"
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"popup_instruction": {"en": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"recurrent_schedule": {"day_of_week": 1,
"interval_type": "weekly",
"time": "01:00:00+08:00"
},
"steps": [{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "First step of the reward chain"
},
"price": {"amount": 10
},
"reward": [{"quantity": 5,
"sku": "item_sku_1"
},
{"quantity": 1,
"sku": "item_sku_2"
}
]
},
{"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {"en": "Second step of the reward chain"
},
"price": {"amount": 15
},
"reward": [{"quantity": 5,
"sku": "item_sku_3"
},
{"quantity": 1,
"sku": "item_sku_4"
}
]
}
],
"value_point": {"sku": "clan_value_point_sku_1"
}
}

Response samples

application/json

{"reward_chain_id": 10
}