Crear moneda virtual

Crear moneda virtualServer-sideAdmin

post/v2/project/{project_id}/admin/items/virtual_currency

Crea una moneda virtual.

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

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.

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

Array of objects <= 20 items

Lista de atributos.

Atención. No puede especificar más de 20 atributos para el artículo. Cualquier intento de superar el límite provocará un error.

Array (<= 20 items)

external_id

required

string [ 1 .. 255 ] characters ^[a-zA-Z0-9-_]+$

ID único del atributo. external_id solo puede contener caracteres alfanuméricos latinos en minúsculas, guiones y guiones bajos.

required

Array of objects

Atención. No puede crear más de 6 valores para cada atributo. Cualquier intento de exceder el límite resultará en un error.

Array

required

object

Default: {"de":"Strategie","en":"Strategy"}

Objeto con traducciones del nombre del valor. Las claves se especifican en la norma ISO 3166-1.

property name*

additional property

string

external_id

required

string [ 1 .. 255 ] characters ^[-_.\d\w]+$

ID del valor único para un atributo. external_id solo puede contener caracteres alfanuméricos latinos en minúsculas, guiones y guiones bajos.

object

Default: {"de":"Genre","en":"Genre"}

Objeto con traducciones para el nombre del atributo. Las claves se especifican en la norma ISO 3166-1.

property name*

additional property

string

custom_attributes

object <json> <= 500 characters

Un objeto JSON que contiene atributos y valores de artículos. Los artículos le permiten añadir más información a los artículos, tal como el nivel requerido del jugador para usar el artículo. Los atributos enriquecen la lógica interna del juego y son accesibles a través de métodos GET y webhooks específicos.

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

Array of objects

Default: []

Grupos a los que pertenece el artículo.

Array

external_id

string

object

Default: {"en":"Horror"}

Nombre del artículo. Debe contener pares clave/valor en los cuales clave es una configuración regional con formato "^[a-z]{2}", valor es una cadena (string).

additionalProperties

string

image_url

string

is_deleted

boolean

is_enabled

boolean

is_free

boolean

Default: false

Si es true, el artículo es gratuito.

is_hard

boolean

is_show_in_store

boolean

object

Límites del artículo.

per_item

integer or null

Limitación global de artículos.

per_user

integer or null

Limitación de artículos para un usuario independiente.

object or null

Periodo de actualización del límite.

interval_type = daily (object) or interval_type = weekly (object) or interval_type = monthly (object)

One of:

Tipo diario de actualización del límite del usuario.

interval_type required	string Periodo de actualización recurrente. Value: "daily"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Hora de actualización del límite en la zona horaria deseada (redondeo a horas).

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

Array of objects

Recursos adicionales del artículo como capturas de pantalla, vídeos de partidas del juego, etc.

Array

type	string Tipo de soporte multimedia: `image`/`video`. Enum: "image" "video"
url	string Archivo de recurso.

order

integer

Define el orden de disposición.

Array of objects or null

Periodo de venta del artículo.

Array

date_from	string <date-time> Fecha en la que el artículo especificado estará disponible para la venta.
date_until	string or null <date-time> Fecha en la que el artículo especificado dejará de estar disponible para la venta. Puede ser `null`.

object

release_date required	string or null <date-time>
is_enabled required	boolean
description	string or null

Array of objects

Array

amount required	number > 0 Importe.
currency required	string Divisa del precio del artículo. Código de tres letras según ISO 4217. Consulte la documentación para obtener información detallada sobre monedas soportadas por Xsolla.
country_iso	string or null País en el que está disponible este precio. Código de dos letras según la norma ISO 3166-1 alfa 2.
is_default	boolean Default: false
is_enabled	boolean Default: true

Array of objects

Array

id	integer >= 1

Array of objects

Array

amount required	integer
is_default required	boolean Default: false
is_enabled required	boolean Default: false El precio está habilitado.
sku	string 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.

Responses

201

El artículo virtual se creó correctamente.

422

Solicitud no válida.

Request samples

application/json

{"attributes": [{"external_id": "material",
"name": {"en-US": "Material"
},
"values": [{"external_id": "gold",
"value": {"en-US": "Gold"
}
}
]
}
],
"custom_attributes": {"attr": "value",
"purchased": 0
},
"description": {"de-DE": "Die Hauptwährung deines Königreichs",
"en-US": "The main currency of your kingdom"
},
"groups": ["gold"
],
"is_enabled": true,
"is_free": false,
"limits": {"per_item": 10000,
"per_user": 5
},
"name": {"de-DE": "Goldmünze",
"en-US": "Gold coin"
},
"order": 1,
"periods": [{"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [{"amount": 100,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"sku": "coin"
}

Response samples

application/json

{"sku": "new-sku"
}