Virtuellen Gegenstand erstellen

Xsolla Developers

oder

Zum Kundenportal

Virtuellen Gegenstand erstellenServer-sideAdmin

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

Erstellt einen virtuellen Gegenstand.

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Example: 44056

Request Body schema: application/json

Array of objects <= 20 items

Liste der Attribute.

Achtung: Sie können für den Artikel maximal 20 Attribute angeben. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.

Array (<= 20 items)

external_id

required

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

Eindeutige Attribut-ID. Die external_id darf nur lateinische Klein- und Großbuchstaben, Ziffern, Bindestriche und Unterstriche enthalten.

required

Array of objects

Achtung: Sie können für jedes Attribut maximal 6 Werte erstellen. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.

Array

required

object

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

Objekt mit lokalisierten Wertnamen. Schlüssel sind in ISO 3166-1 spezifiziert.

property name*

additional property

string

external_id

required

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

Eindeutige Wert-ID für ein Attribut. Die external_id darf nur lateinische Kleinbuchstaben, alphanumerische Zeichen, Binde- und Unterstriche enthalten.

object

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

Objekt mit lokalisierten Attributnamen. Schlüssel sind in ISO 3166-1 spezifiziert.

property name*

additional property

string

custom_attributes

object <json> <= 500 characters

Ein JSON-Objekt mit den Artikelattributen und ‑werten. Attribute ermöglichen es Ihnen, Artikeln weitere Informationen hinzuzufügen, z. B. das Mindestlevel des Spielers, um den Artikel verwenden zu können. Attribute bereichern die interne Logik Ihres Spiels und sind über spezielle GET-Methoden und Webhooks abrufbar.

(two-letter (object or null)) or (five-letter (object or null))

Objekt mit Lokalisierungen für Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

groups

Array of strings

Gruppen, zu denen der Artikel gehört.

Hinweis: Der String-Wert bezieht sich auf die Gruppe `external_id`.

image_url

string

Bild-URL.

object

Definiert die Inventarartikeloptionen.

object or null

Definiert die Eigenschaften aufbrauchbarer Artikel, wenn es sich um einen aufbrauchbaren Artikel handelt, oder null, wenn es sich um einen nicht aufbrauchbaren Artikel handelt.

usages_count

integer or null

Gesamtzahl der verbleibenden Verwendungen, wenn es sich um einen aufbrauchbaren Artikel handelt, oder null, wenn es sich um einen nicht aufbrauchbaren Artikel handelt.

object or null

Definiert die Ablaufeigenschaften, wenn es sich um einen zeitlich begrenzten Artikel handelt, oder null, wenn es sich um einen nicht zeitlich begrenzten Artikel handelt.

type	string Definiert die Art des Artikelablaufs. Enum: "minute" "hour" "day" "week" "month" "year"
value	integer Definiert den Wert für einen Ablaufzeitraum.

is_deleted

boolean

is_enabled

boolean

is_free

boolean

Default: false

Ist true eingestellt, ist der Artikel kostenlos.

is_show_in_store

boolean

object

Artikelbeschränkungen.

per_item

integer or null

Globale Artikelbeschränkung.

per_user

integer or null

Artikelbeschränkung für einen separaten Nutzer.

object or null

Aktualisierungszeitraum begrenzen.

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

One of:

Tägliche Aktualisierung der Nutzerlimits.

interval_type required	string Wiederkehrender Aktualisierungszeitraum. Value: "daily"
time required	string((0[0-9]\|1[0-9]\|2[0-3]):00:00)(\+\|-)(0[0-9]\|1... Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).

(two-letter (object or null)) or (five-letter (object or null))

Objekt mit Lokalisierungen für lange Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Varianten angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

Any of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

Array of objects

Zusätzliche Medieninhalte des Artikels wie Screenshots, Gameplay-Videos usw.

Array

type	string Medieninhaltstyp: `image`/`video`. Enum: "image" "video"
url	string Ressourcendatei.

(two-letter (object or null)) or (five-letter (object or null))

Objekt mit Lokalisierungen für Artikelnamen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

ar	string or null Arabisch
bg	string or null Bulgarisch
cn	string or null Chinesisch (vereinfacht)
cs	string or null Tschechisch
de	string or null Deutsch
en	string or null Englisch
es	string or null Spanisch (Spanien)
fr	string or null Französisch
he	string or null Hebräisch
id	string or null Indonesisch
it	string or null Italienisch
ja	string or null Japanisch
km	string or null Khmer
ko	string or null Koreanisch
lo	string or null Laotisch
my	string or null Birmanisch
ne	string or null Nepalesisch
ph	string or null Filipino
pl	string or null Polnisch
pt	string or null Portugiesisch
ro	string or null Rumänisch
ru	string or null Russisch
th	string or null Thai
tr	string or null Türkisch
tw	string or null Chinesisch (traditionell)
vi	string or null Vietnamesisch

order

integer

Definiert die Anordnungsreihenfolge.

Array of objects or null

Artikelangebotszeitraum.

Array

date_from	string <date-time> Datum, an dem der angegebene Artikel zum Verkauf angeboten wird.
date_until	string or null <date-time> Datum, an dem der angegebene Artikel nicht mehr zum Verkauf angeboten wird. Möglich ist: `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 Betrag.
currency required	string Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.
country_iso	string Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern finden Sie in der Dokumentation. Beispiel: `country=US`
is_default	boolean Default: false
is_enabled	boolean Default: true

Array of objects

Array

id	integer >= 1

sku

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

Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Array of objects

Array

amount required	integer
is_default required	boolean Default: false
is_enabled required	boolean Default: false Der Preis ist aktiviert.
sku	string Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Responses

201

Virtueller Gegenstand wurde erfolgreich erstellt.

422

Ungültige Anfrage.

Request samples

application/json

{"attributes": [{"external_id": "craft-materials",
"name": {"en": "Craft materials"
},
"values": [{"external_id": "steel",
"value": {"en-US": "5"
}
},
{"external_id": "leather",
"value": {"en-US": "1"
}
}
]
}
],
"custom_attributes": {"attr": "value",
"purchased": 0
},
"description": {"de": "Ein Schwert ist eine Nahkampfwaffe mit Klinge, die zum Schneiden oder Stechen bestimmt ist, länger als ein Messer oder Dolch ist und aus einer langen Klinge besteht, die an einem Griff befestigt ist.",
"en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt."
},
"groups": ["weapons"
],
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"limits": {"per_item": 100,
"per_user": 5
},
"name": {"de": "Schwert",
"en": "Sword"
},
"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
},
{"amount": 200,
"country_iso": "CZ",
"currency": "CZK",
"is_default": true,
"is_enabled": false
}
],
"sku": "com.xsolla.sword_1",
"vc_prices": [ ]
}

Response samples

application/json

{"sku": "com.xsolla.item_1"
}