` is the user token. The token identifies the user and provides access to personalized data.\nAlternatively, you can use a [token for opening the payment UI](/de/api/pay-station/token/create-token).\n\n2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/de/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n - `x-unauthorized-id` with a request ID\n - `x-user` with the user's email address encoded in Base64\n\n## Useful links\n\n- [API calls by interaction model](https://developers.xsolla.com/de/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/de/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/de/api/catalog/)\n- [API keys](https://developers.xsolla.com/de/api/catalog/)\n- [Webhooks](https://developers.xsolla.com/de/api/catalog/)\n\n# Core entity structure\n\nItems of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.\n\nNote
Some calls may include additional fields but they don't change the basic structure.
\n\n**Identification**\n\n- `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/)\n- `project_id` — project ID in Publisher Account\n- `sku` — item SKU, unique within the project\n\n**Store display**\n\n- `name` — item name\n- `description` — item description\n- `image_url` — image URL\n- `is_enabled` — item availability\n- `is_show_in_store` — whether the item is displayed in the catalog\n\nFor more information about managing item availability in the catalog, see the [documentation](/de/items-catalog/catalog-features/items-availability/).\n\n**Organization**\n\n- `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`)\n- `groups` — groups the item belongs to\n- `order` — display order in the catalog\n\n**Sale conditions**\n\n- `prices` — prices in real or virtual currency\n- `limits` — purchase limits\n- `periods` — availability periods\n- `regions` — regional restrictions\n\n**Example of core entity structure:**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n\n# Basic purchase flow\n\nThe Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into **Admin** and **Catalog** subsections, which use different [authentication schemes](/de/api/catalog/section/authentication).\n\nThe following example shows a basic flow for setting up and operating a store, from item creation to purchase.\n\n## Create items and groups (Admin)\n\nCreate an item catalog for your store, such as virtual items, bundles, or virtual currency.\n\nExample API calls:\n- [Create virtual item](/de/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/de/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/de/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Set up promotions, chains, and limits (Admin)\n\nConfigure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.\n\nExample API calls:\n- [Create bonus promotion](/de/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/de/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/de/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Get item information (Client)\n\nConfigure item display in your application.\n\n\n
Notice\n Do not use API calls from the Admin subsection to build a user catalog. These API calls have
rate limits and aren't intended for user traffic.\n
\n\nExample API calls:\n- [Get virtual items list](/de/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/de/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/de/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/de/api/catalog/common-catalog/get-sellable-items)\n\n\n Note
\n By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter \"show_inactive_time_limited_items\": 1 in the catalog request.\n
\n\n## Sell items\n\nYou can sell items using the following methods:\n- Fast purchase — sell one SKU multiple times.\n- Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.\n\nIf an item is purchased using virtual currency instead of real money, use the [Create order with specified item purchased by virtual currency](/de/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required, as the charge is processed when the API call is executed.\n\nFor free item purchase, use the [Create order with specified free item](/de/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/de/api/catalog/free-item/create-free-order) API call. The payment UI is not required — the order is immediately set to the done status.\n\n### Fast purchase\n\nUse the client-side API call to [create an order with a specified item](/de/api/catalog/payment-client-side/create-order-with-item). The call returns a token used to open the payment UI.\n\n\n Note
\n Discount information is available to the user only in the payment UI. Promo codes are not supported.\n
\n\n### Cart purchase\n\nCart setup and purchase can be performed on the client or on the server side.\n\n**Set up and purchase a cart on the client**\n\nImplement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/de/api/shop-builder/operation/cart-fill/) API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).\n2. Update the cart contents based on user actions:\n - To add an item or change item quantity, use the [Update cart item by cart ID](/de/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/de/api/shop-builder/operation/delete-item-by-cart-id/) API call.\n\n\n Note
\n To get the current status of the cart, use the Get current user's cart API call.\n
\n\n3. Use the [Create order with all items from current cart](/de/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n**Set up and purchase a cart on the server**\n\nThis setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/de/api/catalog/cart-server-side) API call. The call returns current information about the selected items (prices before and after discounts, bonus items).\n2. Use the [Create order with all items from current cart](/de/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n## Open payment UI\n\nUse the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the [documentation](/de/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui).\n\n| Action | Endpoint |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} |\n| Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n\n
Note\n Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use
test bank cards.\n\n After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in [Publisher Account > Company settings > Users](https://publisher.xsolla.com/0/settings/users).\n\n Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in [Publisher Account](https://publisher.xsolla.com/), go to **Agreements & Taxes > Agreements**, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.\n
\n - In client-side API calls,\n the country is determined by the IP address of the request.
\n - In server-side API calls,\n the country is determined by the value of the
user.country.value parameter or by the user's IP address\n from the X-User-Ip header. If both are passed, the user.country.value parameter takes precedence. \n
\n\n\n
Note\n Only
IPv4 addresses are supported for country determination.\n Passing an
IPv6 address may result in incorrect country\n and currency detection. If you use the server-side API call and cannot provide the user's IPv4 address,\n pass the country in the
user.country.value parameter.\n
\n Hinweis
\n Verwenden Sie keine API-Aufrufe aus dem Unterabschnitt Verwaltung,0 um einen Shopkatalog zu erstellen.\n
\n\n
\n\n\n
Hinweis\n Der API-Aufruf
Liste virtueller Gegenstände abrufen gibt detaillierte Artikeldaten zurück (einschließlich Preise und Attribute) und unterstützt Paginierung. Mit dem Aufruf können Sie Katalogseiten im Storefront anzeigen.\n
\n Der API-Aufruf
Liste aller virtuellen Gegenstände abrufen gibt Artikel-SKU, Namen, Beschreibung sowie Gruppen-ID und Namen ohne Paginierung zurück. Verwenden Sie den Aufruf für die clientseitige Suche oder Indexierung.\n
\n\nWird ein Artikel mit virtueller Währung gekauft, müssen Sie den API-Aufruf [Bestellung mit einem angegebenen, in virtueller Währung gekauften Artikel anlegen](/de/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) verwenden. Das Zahlungsportal muss nicht aufgerufen werden – die Zahlungsabwicklung erfolgt bei Ausführung des API-Aufrufs.\n\nKaufvorgang mit virtueller Währung (Beispiel):\n\n"
},
{
"name": "virtual-items-currency-admin",
"x-displayName": "Administrator"
},
{
"name": "virtual-items-currency-catalog",
"x-displayName": "Katalog"
},
{
"name": "virtual-payment",
"x-displayName": "Virtuelle Bezahlung"
},
{
"name": "game-keys-overview",
"x-displayName": "Übersicht",
"description": "Spielschlüssel sind einmalig verwendbare, eindeutige alphanumerische Codes, mit denen Nutzer Zugriff auf ein Spiel oder einen DLC erhalten. Sie können Spielschlüssel über einen [Direktlink](/de/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_direct_link), über den [Shop](/de/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_game_keys_selling_via_store_ui) oder über ein [Widget](/de/sell-games/set-up-selling-game-keys/#guides_game_sales_selling_items_develop_buttons) verkaufen. Außerdem können Sie [regionale Beschränkungen konfigurieren](/de/items-catalog/catalog-features/regional-restrictions/) und so den Verkauf von Spielschlüsseln auf bestimmte Ländern beschränken. Ausführliche Informationen finden Sie im Abschnitt [Spielschlüsselpakete](https://developers.xsolla.com/de/items-catalog/items-type/set-up-modules/).\n\nFür den Verkauf von Spielschlüsseln ist keine Benutzerauthentifizierung erforderlich – die Schlüssel werden an die E-Mail-Adresse gesendet, die der Nutzer beim Bezahlvorgang angegeben hat. Sie können jedoch die Authentifizierung konfigurieren und dadurch zusätzliche Szenarien umsetzen: [Personalisierung](/de/liveops/liveops-management/personalization-tutorial/), [Kaufbeschränkungen](/de/items-catalog/catalog-features/items-catalog-number-limits/) oder [Berechtigungssystem](/de/sell-games/how-to/entitlement-system/). Ausführliche Informationen finden Sie im Abschnitt [So richten Sie die Authentifizierung beim Verkauf von Spielschlüsseln ein](/de/sell-games/how-to/set-up-authentication/).\n\nAblauf beim Verkauf von Spielschlüsseln:\n\n1. Erstellen Sie ein Spiel mit dem API-Aufruf [Spiel erstellen](/de/api/catalog/game-keys-admin/admin-create-game).\n2. Konfigurieren Sie regionale Beschränkungen.\n3. Laden Sie Spielschlüssel mithilfe des API-Aufrufs [Codes hochladen](/de/api/catalog/game-keys-admin/admin-upload-codes-by-sku) in ein Spielschlüsselpaket hoch, um sie zum Kauf bereitzustellen.\n4. Zeigen Sie den Spielekatalog mitsamt den Preisen für die Region des Nutzers mithilfe des API-Aufrufs [Spieleliste abrufen](/de/api/catalog/game-keys-catalog/get-games-list) an.\n5. Legen Sie eine Bestellung an. Verwenden Sie bei einem Schnellkauf den API-Aufruf [Bestellung mit allen Artikeln aus dem aktuellen Warenkorb anlegen](/de/api/catalog/payment-client-side/create-order-with-item) und übermitteln Sie dabei die SKU des Spielschlüssels. In der Antwort wird ein Token zum Öffnen des Zahlungsportals zurückgegeben.\n6. Implementieren Sie das Öffnen des Zahlungsportals, damit die Bestellung bezahlt werden kann.\n\nDamit Sie zeitnah Benachrichtigungen über erfolgreiche Zahlungen erhalten und die Artikel den Nutzern übertragen können, sollten Sie das Bestellstatus-Tracking einrichten, beispielsweise mithilfe von [Webhooks](/de/webhooks/section/osnovnye-polozheniya). Die Schlüssel werden an die E-Mail-Adresse gesendet, die der Nutzer beim Bezahlvorgang angegeben hat, und der Bestellstatus wechselt in `done`.\n\n"
},
{
"name": "game-keys-catalog",
"x-displayName": "Katalog"
},
{
"name": "game-keys-entitlement",
"x-displayName": "Berechtigung"
},
{
"name": "game-keys-admin",
"x-displayName": "Administrator"
},
{
"name": "bundles-overview",
"x-displayName": "Übersicht",
"description": "Bundles sind eine Zusammenstellung von Artikeln, die als eine Einheit verkauft werden. Ein Bundle kann virtuelle Gegenstände, virtuelle Währung, virtuelle Währungspakete, Spielschlüssel und andere Bundles enthalten. So lassen sich Starterpakete, saisonale Angebote und Sonderaktionen zusammenstellen und anbieten.\n\nVerwenden Sie die folgenden Gruppen von API-Aufrufen, um mit Bundles zu arbeiten:\n\n* Mit den API-Aufrufen aus dem Unterabschnitt Verwaltung können Sie Bundles erstellen, aktualisieren, löschen und deren Sichtbarkeit steuern.\n* Mit den API-Aufrufen aus dem Unterabschnitt Katalog können Sie Bundles abrufen.\n\nKauflimits lassen sich beim Erstellen oder Aktualisieren eines Bundles über das `limits`-Objekt konfigurieren. Weitere Informationen finden Sie in der Übersicht unter [Limits](/de/api/catalog/limits-overview). Sie können zudem [regionale Beschränkungen](https://developers.xsolla.com/de/items-catalog/catalog-features/regional-restrictions/) festlegen und so den Verkauf von Artikeln auf bestimmte Länder beschränken.\n\n\n
Hinweis\n Ausführliche Informationen zur Konfiguration von Bundles finden Sie im Abschnitt
Bundles.\n
\n\nBundle verwalten (Szenario):\n\n1. Erstellen Sie ein Bundle mithilfe des API-Aufrufs [Bundle erstellen](/de/api/catalog/bundles-admin/admin-create-bundle). Verwenden Sie den API-Aufruf [Bundle abrufen](/de/api/catalog/bundles-admin/admin-get-bundle), um das erstellte Bundle zu überprüfen. Mit dem API-Aufruf [Liste der Bundles abrufen](/de/api/catalog/bundles-admin/admin-get-bundle-list) können Sie alle Bundles im Projekt abrufen.\n2. Verwenden Sie bei Bedarf den API-Aufruf [Bundle aktualisieren](/de/api/catalog/bundles-admin/admin-update-bundle), um den Bundle-Inhalt oder die ‑Einstellungen zu ändern.\n3. Implementieren Sie die Logik, gemäß der Bundles in Ihrem Storefront angezeigt werden, mithilfe des API-Aufrufs [Liste der Bundles abrufen](/de/api/catalog/bundles-catalog/get-bundle-list), [Angegebenes Bundle abrufen](/de/api/catalog/bundles-catalog/get-bundle) oder [Liste der Bundles anhand der angegebenen Gruppe abrufen](/de/api/catalog/bundles-catalog/get-bundle-list-in-group).\n4. Legen Sie eine Berstellung mit einem der API-Aufrufe aus dem Abschnitt [Warenkorb und Zahlung](/de/api/catalog/cart-and-payment-overview) an. Bei einem Schnellkauf können Sie beispielsweise den API-Aufruf [Bestellung mit angegebenem Artikel anlegen](/de/api/catalog/payment-client-side/create-order-with-item) verwenden und dabei die Bundle-SKU übermitteln. In der Antwort wird ein Token zum Öffnen des Zahlungsportals zurückgegeben.\n5. Implementieren Sie das Öffnen des Zahlungsportals, damit die Bestellung bezahlt werden kann.\n6. Richten Sie das Bestellstatus-Tracking ein, beispielsweise mithilfe von [Webhooks](https://developers.xsolla.com/de/webhooks/overview), um zeitnah Daten zu erfolgreich bezahlten Artikeln zu erhalten und diese dem Nutzer zu übertragen.\n\n"
},
{
"name": "bundles-admin",
"x-displayName": "Administrator"
},
{
"name": "bundles-catalog",
"x-displayName": "Katalog"
},
{
"name": "cart-and-payment-overview",
"x-displayName": "Übersicht",
"description": "Der Warenkorb ermöglicht es, mehrere Artikel in einer einzelnen Bestellung zusammenzufassen. Ein Nutzer kann Artikel jeglichen Typs in beliebiger Menge gegen echte Währung kaufen sowie [Promocodes](https://developers.xsolla.com/de/api/liveops/promotions-promo-codes) einlösen.\n\nDer Warenkorb wird aufseiten von Xsolla gespeichert. Ob der Warenkorb sitzungsübergreifend gespeichert wird, hängt davon ab, ob der Nutzer autorisiert ist:\n * Bei autorisierten Nutzern ist der Warenkorb mit dem jeweiligen Nutzer verknüpft und wird sitzungsübergreifend gespeichert, solange Anfragen im Namen desselben Nutzers gesendet werden.\n\n * Bei [nicht autorisierten Nutzern](/de/api/catalog/section/authentication/authentication-with-guest-access-support) hängt es davon ab, ob der Header `x-unauthorized-id` übermittelt wird. Um den Warenkorb eines nicht autorisierten Nutzers sitzungsübergreifend zu speichern, müssen Sie dieselbe `x-unauthorized-id` in jeder Anfrage übermitteln. Diese Option ist nur beim Verkauf von Spielschlüsseln verfügbar.\n\nSie können den Warenkorb auf zwei Arten identifizieren: automatisch anhand des [JWT des Nutzers](https://developers.xsolla.com/de/api/catalog/section/authentication/authentication-using-user's-jwt) oder anhand der Warenkorb-ID (`cart_id`).\n\nDer Warenkorb lässt sich sowohl clientseitig als auch serverseitig verwalten.\n\nServerseitig können Sie den Warenkorb mit Artikeln befüllen, z. B. beim Wiederherstellen einer Sitzung eines Nutzers. Clientseitig stehen Ihnen folgende Aktionen zur Verfügung:\n\n* den aktuellen Warenkorb des Nutzers oder einen Warenkorb anhand einer ID abrufen\n* den Warenkorb befüllen\n* Artikel im Warenkorb aktualisieren\n* Artikel aus dem Warenkorb löschen\n\nUm Artikel aus dem Warenkorb zu kaufen, werden client- und serverseitige Aufrufe zur Bestellanlegung verwendet.\n\nDie Lebensdauer des Warenkorbs beträgt standardmäßig 72 Stunden. Ändert sich der Inhalt (z. B. wenn ein neuer Artikel in den Warenkorb gelegt wird) verlängert sich die Lebensdauer.\n\nNach erfolgreicher Zahlung wird der Warenkorb nicht automatisch geleert. Um den Warenkorb zu leeren, müsse Sie die folgenden clientseitigen API-Aufrufe verwenden:\n * [Alle Warenkorbartikel anhand der Warenkorb-ID löschen](/de/api/catalog/cart-client-side/cart-clear-by-id).\n\n * [Alle Warenkorbartikel aus aktuellem Warenkorb löschen](/de/api/catalog/cart-client-side/cart-clear).\n\n * [Warenkorbartikel anhand der Warenkorb-ID löschen](/de/api/catalog/cart-client-side/delete-item-by-cart-id) und [Warenkorbartikel aus aktuellem Warenkorb löschen](/de/api/catalog/cart-client-side/delete-item) – dder Warenkorb wird geleert, sobald Sie den letzten Artikel daraus löschen.\n\nAnwendungsszenario für den Warenkorb:\n\n1. Implementieren Sie eine Shopoberfläche, auf der der Nutzer Artikel auswählen kann.\n\n2. Wenn der Nutzer Artikel im Shop auswählt, müssen Sie diese in den Warenkorb legen, z. B. mithilfe des Aufrufs [Artikel in den Warenkorb legen](https://developers.xsolla.com/de/api/catalog/cart-client-side/cart-fill). Im Array \"items\" müssen Sie die SKUs und die gewünschte Stückzahl des jeweiligen Artikels übermitteln.\n\n3. Implementieren Sie die Warenkorbansicht. Wenn der Nutzer zum Warenkorb navigiert, müssen Sie den Warenkorbinhalt mithilfe des Aufrufs [Warenkorb des aktuellen Benutzers abrufen](https://developers.xsolla.com/de/api/catalog/cart-client-side/get-user-cart) anzeigen. In der Antwort werden Informationen zum finalen Preis der Artikel (einschließlich Rabatten und angewendeten Werbeaktionen) zurückgegeben.\n\n4. Implementieren Sie das Öffnen des Zahlungsportals, damit die Bestellung bezahlt werden kann. Sie können beispielsweise den Aufruf [Bestellung mit allen Artikeln aus einem angegebenen Warenkorb anlegen](https://developers.xsolla.com/de/api/catalog/payment-client-side/create-order-by-cart-id) verwenden. In der Antwort ist ein Token zum Öffnen des Zahlungsportals enthalten.\n\n5. Richten Sie das Bestellstatus-Tracking ein, beispielsweise mithilfe von [Webhooks](https://developers.xsolla.com/de/webhooks/), um zeitnah Daten zu erfolgreich bezahlten Artikeln zu erhalten und diese dem Nutzer zu übertragen.\n\n\n
Hinweis
\n
Wie Sie den Verkauf von Artikeln im Spiel und online implementieren, erfahren Sie im Integrationsleitfaden.
\n
\n \n \n | Status | \n Beschreibung | \n Hinweise | \n
\n \n \n \n new | \n Die Bestellung wurde angelegt. Das System wartet auf die Zahlungsbestätigung. | \n Erläuterungen zum Transaktionsstatus finden Sie in der Pay-Station-API-Dokumentation. | \n
\n \n paid | \n Bestellung wurde bezahlt (die Transaktion wurde in den Status done versetzt), und der Artikel kann dem Nutzer gewährt werden. | \n Die Bestellung verbleibt im Status new, bis die Zahlung bestätigt wurd. | \n
\n \n done | \n Artikel wurde dem Nutzer gewährt. | \n — | \n
\n \n canceled | \n Die Zahlung wurder erstattet. | \n Die Bestellung wechselt in diesen Status, sobald sich der Transaktionsstatus in refunded ändert. | \n
\n \n expired | \n Wird eine neue Bestellung für einen begrenzten Artikel, einen Promocode oder eine Werbeaktion angelegt, wird jede bisherige, noch nicht bezahlte Bestellung, in der dieser Artikel enthalten ist, in den Status expired versetzt. | \n Sollte ein Nutzer versuchen, eine abgelaufene Bestellung zu bezahlen, wird im Zahlungsportal der Fehlercode 2002 angezeigt, und die Zahlung schlägt fehl. | \n
\n \n
\n\n\n\n\n
Hinweis
\n
Wenn die Bestellung während des Bezahlvorgangs in den Status expired wechselt, die Zahlung jedoch erfolgreich ist, ändert sich der Status der Bestellung von expired in paid. Dies gilt nur, wenn das Kauflimit für den bestellten Artikel bei der Zahlung nicht überschritten wird.
\n
\n
Hinweis\n Ausführliche Informationen zur Konfiguration von Limits im Katalog finden Sie im Abschnitt
Kauflimits für Artikel.\n
\n Hinweis
\nXsolla prüft, ob das Land des Nutzers in der für den Artikel festgelegten Region enthalten ist. Ist das Land nicht in der Region enthalten, kann die Bestellung nicht angelegt werden.\n
\n\n
\n\n5. Implementieren Sie das Öffnen des Zahlungsportals, damit die Bestellung bezahlt werden kann.\n\n"
},
{
"name": "attribute-admin",
"x-displayName": "Administrator"
},
{
"name": "item-groups-admin",
"x-displayName": "Administrator"
},
{
"name": "item-groups-catalog",
"x-displayName": "Katalog"
},
{
"name": "common-webhooks",
"x-displayName": "Webhooks"
}
],
"paths": {
"/v2/project/{project_id}/admin/items/virtual_items": {
"get": {
"summary": "Liste virtueller Gegenstände abrufen",
"description": "Ruft die Liste der virtuellen Gegenstände innerhalb eines Projekts zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Virtuellen Gegenstand erstellen",
"description": "Erstellt einen virtuellen Gegenstand.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n Hinweis
\n Das Anfragerumpfschema enthält optionale Parameter für komplexe Anwendungsfälle wie etwa die Einrichtung regionaler Preise, Kauflimits und zeitlich begrenzter Verfügbarkeit. Um einen einfachen Artikel zu erstellen, müssen Sie lediglich die Parameter sku, name und description angeben. Um Preise in echter Währung festzulegen, müssen Sie den Parameter prices angeben. Für virtuelle Währung verwenden Sie den Parameter vc_prices. Um den Artikel kostenlos anzubieten, müssen Sie is_free: true festlegen.\n
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": {
"get": {
"summary": "Liste der virtuellen Gegenstände anhand der angegebenen externen Gruppen-ID abrufen",
"description": "Ruft die Liste der virtuellen Gegenstände innerhalb einer Gruppe zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": {
"get": {
"summary": "Liste der virtuellen Gegenstände anhand der angegebenen Gruppen-ID abrufen",
"description": "Ruft die Liste der virtuellen Gegenstände innerhalb einer Gruppe zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-items-list-by-group-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "Virtuellen Gegenstand abrufen",
"description": "Ruft den virtuellen Gegenstand innerhalb eines Projekts zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"put": {
"summary": "Virtuellen Gegenstand aktualisieren",
"description": "Aktualisiert einen virtuellen Gegenstand.",
"operationId": "admin-update-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"description": "\n Hinweis
\n Das Anfragerumpfschema umfasst sowohl erforderliche als auch optionale Parameter für komplexe Anwendungsfälle wie etwa die Einrichtung regionaler Preise, Kauflimits und zeitlich begrenzter Verfügbarkeit.\n
\n\n
\n\n\n Hinweis
\n Übermitteln Sie alle Artikelparameter, auch diejenigen, die nicht aktualisiert werden müssen. In der Anfrage weggelassene Parameter werden entfernt.\n
\n\n
",
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item"
},
"responses": {
"204": {
"description": "Virtueller Gegenstand wurde erfolgreich aktualisiert.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Virtuellen Gegenstand löschen",
"description": "Löscht einen virtuellen Gegenstand.",
"operationId": "admin-delete-virtual-item",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Virtueller Gegenstand wurde erfolgreich gelöscht.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency": {
"get": {
"summary": "Liste virtueller Währungen abrufen",
"description": "Ruft die Liste der virtuellen Währungen innerhalb eines Projekts zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currencies-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Virtuelle Währung erstellen",
"operationId": "admin-create-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"description": "Erstellt eine virtuelle Währung.",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": {
"get": {
"summary": "Virtuelle Währung abrufen",
"description": "Ruft die virtuelle Wärhung innerhalb eines Projekts zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-virtual-currency",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"virtual-items-currency-admin"
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Virtual-Items-Currency_404-item"
}
}
},
"put": {
"summary": "Virtuelle Währung aktualisieren",
"description": "Aktualisiert eine virtuelle Währung.",
"operationId": "admin-update-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency"
},
"responses": {
"204": {
"description": "Virtuelle Währung wurde erfolgreich aktualisiert.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Virtuelle Währung löschen",
"description": "Löscht eine virtuelle Währung.",
"operationId": "admin-delete-virtual-currency",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/virtual_currency_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Virtuelle Währung wurde erfolgreich gelöscht.",
"content": {}
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package": {
"get": {
"summary": "Liste der virtuellen Währungspakete abrufen (Verwaltung)",
"description": "Ruft die Liste der virtuellen Währungspakte innerhalb eines Projekts zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"operationId": "admin-get-virtual-currency-packages-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-packages"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Virtuelles Währungspaket erstellen",
"description": "Erstellt ein virtuelles Währungspaket.",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"201": {
"$ref": "#/components/responses/Virtual-Items-Currency_201-created"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": {
"put": {
"summary": "Virtuelles Währungspaket aktualisieren",
"description": "Aktualisiert ein virtuelles Währungspaket.",
"operationId": "admin-update-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package"
},
"responses": {
"204": {
"description": "Virtueller Gegenstand wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request"
}
}
},
"delete": {
"summary": "Virtuelles Währungspaket löschen",
"description": "Löscht ein virtuelles Währungspaket.",
"operationId": "admin-delete-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"204": {
"description": "Virtuelles Währungspaket wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "Virtuelles Währungspaket abrufen",
"description": "Ruft das virtuelle Wärhungspaket innerhalb eines Projekts zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-virtual-currency-package",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"virtual-items-currency-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-package"
},
"401": {
"$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items": {
"get": {
"summary": "Liste virtueller Gegenstände abrufen",
"description": "Ruft eine List von virtuellen Gegenständen zum Erstellen eines Katalogs ab.\n\n\n Hinweis
\n Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel\n pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit\n und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
Siehe auch: API-Aufruf Alle virtuellen Gegenstände abrufen für die clientseitige Suche oder Indexierung.",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
},
{
"$ref": "#/components/parameters/show_inactive_time_limited_items-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": {
"get": {
"summary": "Virtuellen Gegenstand anhand der SKU abrufen",
"description": "Ruft einen virtuellen Gegenstand anhand der SKU ab, um einen Katalog zu erstellen.\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n Hinweis
\n Gibt nur Artikel-SKU, Name, Gruppen und Beschreibung zurück.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
Siehe auch: API-Aufruf Liste virtueller Gegenstände abrufen für paginierten Abruf detaillierter Artikeldaten.",
"security": [
{
"XsollaLoginUserJWT": []
}
],
"operationId": "get-all-virtual-items",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"virtual-items-currency-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list"
}
}
}
},
"/v2/project/{project_id}/items/virtual_currency": {
"get": {
"summary": "Liste virtueller Währungen abrufen",
"description": "Ruft eine List von virtuellen Währungen zum Erstellen eines Katalogs ab.\n\n\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
HinweisDie API-Aufrufe für den Artikelkatalog können auch ohne Autorisierung verwendet werden. Um jedoch einen
einen personalisierten Katalog, abzurufen, müssen Sie den Benutzer-JWT im Authorization-Header übermitteln.
",
"operationId": "get-item-groups",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"security": [],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/with_geo-query-param"
}
],
"tags": [
"item-groups-catalog"
],
"responses": {
"200": {
"$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups": {
"get": {
"summary": "Liste der Artikelgruppen abrufen",
"description": "Ruft die vollständige Liste der Artikelgruppen innerhalb eines Projekts ohne Paginierung ab. Für Verwaltungszwecke.\n\nHinweisVerwenden Sie diesen Endpunkt nicht zum Erstellen eines Shopkatalogs. Verwenden Sie stattdessen den clientseitigen Endpunkt
Liste der Artikelgruppen abrufen.
",
"operationId": "admin-get-item-group-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Artikelgruppe erstellen",
"description": "Erstellt eine Artikelgruppe innerhalb eines Projekts.\nVerwenden Sie den clientseitigen Endpunkt Liste der Artikelgruppen abrufen, um Artikelgruppen für die Erstellung eines Katalogs abzurufen.",
"operationId": "admin-create-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_create"
},
"responses": {
"201": {
"$ref": "#/components/responses/ItemGroup_201-admin-create-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
}
},
"/v2/project/{project_id}/admin/items/groups/{external_id}": {
"get": {
"summary": "Artikelgruppe anhand der externen ID abrufen",
"description": "Ruft eine Artikelgruppe anhand ihrer externen ID für Verwaltungszwecke ab.\n\nHinweisVerwenden Sie diesen Endpunkt nicht zum Erstellen eines Shopkatalogs. Verwenden Sie stattdessen den clientseitigen Endpunkt
Liste der Artikelgruppen abrufen.
",
"operationId": "admin-get-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
},
"put": {
"summary": "Artikelgruppe aktualisieren",
"description": "Aktualisiert eine Artikelgruppe anhand ihrer externen ID.",
"operationId": "admin-update-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_update"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-update-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-create-update"
}
}
},
"delete": {
"summary": "Artikelgruppe löschen",
"description": "Löscht eine Artikelgruppe anhand ihrer externen ID.",
"operationId": "admin-delete-item-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-delete-group"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-delete"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups": {
"get": {
"summary": "Liste der Artikelgruppen nach Artikeltyp filtern",
"description": "Retrieves item group list with filtering by item type. Only items of the specified type are counted for the group. This is similar to the [Get item group list](/de/api/catalog/item-groups-admin/admin-get-item-group-list) endpoint, with additional filtering of items by type when counting them.",
"operationId": "admin-get-item-group-list-by-item-type",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_type-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": {
"get": {
"summary": "Artikelgruppe anhand der externen ID abrufen, gefiltert nach Artikeltyp",
"description": "Retrieves an item group by external ID. Only items of the specified type are counted for the group. This is similar to the [Get item group by external ID](/de/api/catalog/item-groups-admin/admin-get-item-group) endpoint, with additional filtering of items by type when counting them.",
"operationId": "admin-get-item-group-by-item-type",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_type-group-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/ItemGroup_200-admin-get-group-by-item-type"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-group-not-found"
}
}
}
},
"/v2/project/{project_id}/admin/group/order": {
"put": {
"summary": "Artikelgruppen neu anordnen",
"description": "Legt die Anzeigereihenfolge für Artikelgruppen innerhalb eines Projekts fest. Übermitteln Sie ein Array von Gruppen mit deren neuen Reihenfolgewerten.",
"operationId": "admin-reorder-item-groups",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-groups"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-groups-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/{external_id}/order/item": {
"put": {
"summary": "Artikel innerhalb einer Gruppe neu anordnen (nach externer ID)",
"description": "Legt die Anzeigereihenfolge von Artikeln innerhalb einer Gruppe fest, die durch ihre externe ID identifiziert wird. Übermitteln Sie ein Array von Artikeln mit deren neuen Reihenfolgewerten.",
"operationId": "admin-reorder-items-in-group",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-external-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/admin/group/id/{id}/order/item": {
"put": {
"summary": "Artikel innerhalb einer Gruppe neu anordnen (nach ID)",
"description": "Legt die Anzeigereihenfolge von Artikeln innerhalb einer Gruppe fest, die durch ihre interne numerische ID identifiziert wird. Übermitteln Sie ein Array von Artikeln mit deren neuen Reihenfolgewerten.",
"operationId": "admin-reorder-items-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/id-group-path-param"
}
],
"tags": [
"item-groups-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/ItemGroup_item_order"
},
"responses": {
"204": {
"$ref": "#/components/responses/ItemGroup_204-admin-reorder-items"
},
"401": {
"$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/ItemGroup_404-reorder-items-by-id-not-found"
},
"422": {
"$ref": "#/components/responses/ItemGroup_422-ordering"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": {
"post": {
"summary": "Bestellung mit einem angegebenen, in virtueller Währung gekauften Artikel anlegen",
"description": "Legt Bestellungen von mit virtueller Währung erworbenen Artikeln an.
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
Hinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-game-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-games-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/sku/{item_sku}": {
"get": {
"summary": "Spiel abrufen (Verwaltung)",
"description": "Ruft ein Spiel zur Verwaltung ab.\nDas Spiel besteht aus Spielschlüsseln, die von einem Nutzer gekauft werden können.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spiel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "Spiel anhand der SKU aktualisieren",
"description": "Aktualisiert ein Spiel im Projekt anhand der SKU.",
"operationId": "admin-update-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "Spiel wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spiel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "Spiel anhand der SKU löschen",
"description": "Löscht ein Spiel im Projekt anhand der SKU.",
"operationId": "admin-delete-game-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Das Spiel wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/id/{item_id}": {
"get": {
"summary": "Spiel anhand von ID abrufen (Verwaltung)",
"description": "Ruft ein Spiel zur Verwaltung ab.\nDas Spiel besteht aus Spielschlüsseln, die von einem Nutzer gekauft werden können.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/promo_code-query-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spiel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
}
}
},
"put": {
"summary": "Spiel anhand der ID aktualisieren",
"description": "Aktualisiert ein Spiel im Projekt anhand der ID.",
"operationId": "admin-update-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Game-Keys_create-update-game-model"
},
"responses": {
"201": {
"description": "Spiel wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spiel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 1 not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with id = 1 not found"
}
}
}
}
}
},
"422": {
"$ref": "#/components/responses/Game-Keys_422-invalid-request"
}
}
},
"delete": {
"summary": "Spiel anhand der ID löschen",
"description": "Löscht ein Spiel im Projekt anhand der ID.",
"operationId": "admin-delete-game-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Das Spiel wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": {
"post": {
"summary": "Codes hochladen",
"description": "Lädt Codes anhand der Spielschlüssel-SKU hoch.",
"operationId": "admin-upload-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "Regions-ID."
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
},
"required": true
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spielschlüssel oder Region nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": {
"post": {
"summary": "Codes anhand von ID hochladen",
"description": "Lädt Codes anhand der Spielschlüssel-ID hoch.",
"operationId": "admin-upload-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "File with codes."
},
"region_id": {
"type": "integer",
"description": "Regions-ID."
}
},
"required": [
"file"
],
"example": {
"file": "keys.txt",
"region_id": 1
}
}
}
}
},
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spielschlüssel oder Region nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": {
"get": {
"summary": "Sitzungsdaten zum Laden von Codes abrufen",
"description": "Ruft Sitzungsdaten zum Laden von Codes abrufen ab.",
"operationId": "admin-get-codes-session",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"name": "session_id",
"in": "path",
"required": true,
"description": "Sitzungs-ID.",
"schema": {
"type": "string",
"default": "fc7105b6e8ee01339582970b37697242"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-session-information"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Sitzungsdaten zum Laden von Codes nicht gefunden."
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": {
"get": {
"summary": "Codes abrufen",
"description": "Ruft eine bestimmte Anzahl von Codes anhand der Spielschlüssel-SKU ab.",
"operationId": "admin-get-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spielschlüssel oder Region nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": {
"get": {
"summary": "Codes anhand der ID abrufen",
"description": "Ruft eine bestimmte Anzahl von Codes anhand der Spielschlüssel-ID ab.",
"operationId": "admin-get-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/quantity-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spielschlüssel oder Region nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": {
"delete": {
"summary": "Codes löschen",
"description": "Löscht alle Codes anhand der Spielschlüssel-SKU.",
"operationId": "admin-delete-codes-by-sku",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spielschlüssel oder Region nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": {
"delete": {
"summary": "Codes anhand der ID löschen",
"description": "Löscht alle Codes anhand der Spielschlüssel-ID.",
"operationId": "admin-delete-codes-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"tags": [
"game-keys-admin"
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_id-path-param"
},
{
"$ref": "#/components/parameters/user_email-query-param"
},
{
"$ref": "#/components/parameters/reason-query-param"
},
{
"$ref": "#/components/parameters/region_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-get-codes"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
},
"404": {
"description": "Spielschlüssel oder Region nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found"
}
}
}
}
}
}
}
}
},
"/v2/project/{project_id}/entitlement": {
"get": {
"tags": [
"game-keys-entitlement"
],
"operationId": "get-user-games",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/sandbox-query-param"
},
{
"$ref": "#/components/parameters/additional_fields-entitlement-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Game-Keys_200-user-entitlement-list"
},
"401": {
"$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth"
}
},
"summary": "Liste der Spiele im Besitz des Nutzers abrufen",
"description": "Ruft eine Liste der Spiele ab, die der Nutzer besitzt. Als Antwort enthält man ein Array von Spielen, die ein bestimmter Nutzer besitzt.\n\n\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n Hinweis
\n Sie können Codes nur für die DRM-freie Plattform einlösen.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
Achtung
Es können nur Spielcodes oder Spiele für DRM-freie Plattformen gewährt werden.
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"code": {
"type": [
"string",
"null"
],
"example": "AAAA-BBBB-CCCC-DDDD",
"description": "Game code of the game."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be granted. If the parameter is set to `sandbox`, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be granted to the user in the live mode."
},
"user_country": {
"type": [
"string",
"null"
],
"example": "US",
"description": "User's country."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"code": "AAAA-BBBB-CCCC-DDDD",
"mode": "default",
"user_country": "US"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/entitlement/revoke": {
"post": {
"tags": [
"game-keys-entitlement"
],
"operationId": "revoke-entitlement-admin",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"204": {
"description": "Widerruf erfolgreich."
},
"403": {
"$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent"
},
"422": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 5103
},
"errorMessage": {
"type": "string",
"example": "[0401-5103]: Selected drm is not drmfree."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"type": "object"
},
"examples": {
"DRM is not DRM free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
}
}
}
}
}
},
"summary": "Berechtigung entziehen (Verwaltung)",
"description": "Entzieht dem Nutzer eine Berechtigung.\n\nAchtung
Es können nur Spielcodes oder Spiele für DRM-freie Plattformen entzogen werden.
",
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user_external_id",
"game",
"drm",
"mode"
],
"properties": {
"user_external_id": {
"type": "string",
"example": "user-external-id",
"description": "Unique user identifier."
},
"game": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
}
},
"example": {
"game": {
"sku": "com.xsolla.game_1"
}
},
"description": "Object with game properties."
},
"drm": {
"type": "object",
"required": [
"sku"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
}
},
"example": {
"drm": {
"sku": "com.xsolla.key_1"
}
},
"description": "Object with DRM properties."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "What type of entitlements should be revoked. If the parameter is set to `sandbox`, the entitlement will be revoked from the user in the sandbox mode. If the parameter is set to `default`, the entitlement will be revoked from the user in the live mode."
}
},
"example": {
"user_external_id": "user-external-id",
"game": {
"sku": "com.xsolla.game_1"
},
"drm": {
"sku": "com.xsolla.key_1"
},
"mode": "default"
}
}
}
},
"required": true
}
}
},
"/v2/project/{project_id}/admin/items/bundle": {
"get": {
"summary": "Liste der Bundles abrufen",
"description": "Ruft die Liste der Bundles innerhalb eines Projekts zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-bundle-list",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"post": {
"summary": "Bundle erstellen",
"description": "Erstellt ein Bundle – eine Zusammenstellung von Artikeln, die als eine Einheit verkauft werden. Ein Bundle kann virtuelle Gegenstände, virtuelle Währungspakete, Spielschlüssel und andere Bundles enthalten. Weitere Informationen finden Sie im Abschnitt [Bundles](https://developers.xsolla.com/de/items-catalog/items-type/bundles/).\n\nHinweis
Alle Artikel im Array content müssen zuvor in Ihrem Projekt erstellt worden sein. Das System gibt eine Fehlermeldung aus, wenn die angegebene SKU nicht existiert.
",
"security": [
{
"basicAuth": []
}
],
"operationId": "admin-create-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"201": {
"$ref": "#/components/responses/Bundles_201-admin-create-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": {
"get": {
"summary": "Liste der Bundles anhand der angegebenen Gruppen-ID abrufen",
"description": "Ruft die Liste der Bundles innerhalb einer Gruppe zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-bundle-list-in-group-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/group_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": {
"get": {
"summary": "Liste der Bundles anhand der angegebenen externen Gruppen-ID abrufen",
"description": "Ruft die Liste der Bundles innerhalb einer Gruppe zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-bundle-list-in-group-by-external-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-group-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}": {
"put": {
"summary": "Bundle aktualisieren",
"description": "Aktualisiert ein Bundle . Dieser Aufruf ersetzt das Bundle vollständig – übermitteln Sie alle Pflichtfelder im Anfragerumpf, nicht nur die Felder, die Sie ändern möchten. Weitere Informationen finden Sie im Abschnitt [Bundles](https://developers.xsolla.com/de/items-catalog/items-type/bundles/).\n\nHinweis
Alle Artikel im Array content müssen zuvor in Ihrem Projekt erstellt worden sein. Das System gibt eine Fehlermeldung aus, wenn die angegebene SKU nicht existiert.
",
"operationId": "admin-update-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"requestBody": {
"$ref": "#/components/requestBodies/Bundles_bundle"
},
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-update-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Bundles_422-invalid-request"
}
}
},
"delete": {
"summary": "Bundle löschen",
"description": "Löscht ein Bundle.",
"operationId": "admin-delete-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-delete-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
},
"get": {
"summary": "Bundle abrufen",
"description": "Ruft das Bundle innerhalb eines Projekts zur Verwaltung ab.\n\nHinweis
Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
",
"operationId": "admin-get-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"200": {
"$ref": "#/components/responses/Bundles_200-admin-get-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": {
"put": {
"summary": "Bundle im Katalog anzeigen",
"description": "Zeigt ein Bundle in einem Katalog an.",
"operationId": "admin-show-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-show-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": {
"put": {
"summary": "Bundle im Katalog ausblenden",
"description": "Blendet ein Bundle in einem Katalog aus.",
"operationId": "admin-hide-bundle",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"tags": [
"bundles-admin"
],
"responses": {
"204": {
"$ref": "#/components/responses/Bundles_204-admin-hide-bundle"
},
"401": {
"$ref": "#/components/responses/Bundles_401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/items/bundle": {
"get": {
"summary": "Liste der Bundles abrufen",
"description": "Ruft eine Liste von Bundles ab, um einen Katalog zu erstellen.\n\n\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
Hinweis Weil diese Methode auf die IP zurückgreift, um das Land des Nutzers zu ermitteln und eine Währung für die Bestellung auszuwählen, ist es wichtig, diese Methode nur clientseitig und nicht serverseitig einzusetzen. Die serverseitige Verwendung dieser Methode kann dazu führen, dass eine falsche Währung ermittelt wird, was sich wiederum auf die in der
Pay Station angezeigten Zahlungsmethoden auswirkt.
",
"operationId": "create-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/cart": {
"post": {
"summary": "Bestellung mit allen Artikeln aus dem aktuellen Warenkorb anlegen",
"description": "Wird für die Client-zu-Server-Integration verwendet. Legt eine Bestellung mit allen Artikeln aus dem Warenkorb an und generiert einen Zahlungstoken. Der angelegten Bestellung wird der Bestellstatus `new` zugeordnet.\n\nAnhand der Client-IP wird das Land des Nutzers ermittelt und anschließend die entsprechende Währung und die verfügbaren Zahlungsmethoden für die Bestellung herangezogen.\n\nNutzen Sie den folgenden Link, um das Zahlungsportal in einem neuen Fenster aufzurufen: `https://secure.xsolla.com/paystation4/?token={token}`, wobei `{token}` der erhaltene Token ist.\n\nFür Testzwecke steht Ihnen die folgende URL zur Verfügung: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\nHinweis Weil diese Methode auf die IP zurückgreift, um das Land des Nutzers zu ermitteln und eine Währung für die Bestellung auszuwählen, ist es wichtig, diese Methode nur clientseitig und nicht serverseitig einzusetzen. Die serverseitige Verwendung dieser Methode kann dazu führen, dass eine falsche Währung ermittelt wird, was sich wiederum auf die in der
Pay Station angezeigten Zahlungsmethoden auswirkt.
",
"operationId": "create-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/payment/item/{item_sku}": {
"post": {
"summary": "Bestellung mit angegebenem Artikel anlegen",
"description": "Wird für die Client-zu-Server-Integration verwendet. Legt eine Bestellung mit dem angegebenen Artikel an und generiert einen Zahlungstoken. Der angelegten Bestellung wird der Bestellstatus `new` zugeordnet.\n\nAnhand der Client-IP wird das Land des Nutzers ermittelt und anschließend die entsprechende Währung und die verfügbaren Zahlungsmethoden für die Bestellung herangezogen.\n\nNutzen Sie den folgenden Link, um das Zahlungsportal in einem neuen Fenster aufzurufen: `https://secure.xsolla.com/paystation4/?token={token}`, wobei `{token}` der erhaltene Token ist.\n\nFür Testzwecke steht Ihnen die folgende URL zur Verfügung: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\nHinweis Weil diese Methode auf die IP zurückgreift, um das Land des Nutzers zu ermitteln und eine Währung für die Bestellung auszuwählen, ist es wichtig, diese Methode nur clientseitig und nicht serverseitig einzusetzen. Die serverseitige Verwendung dieser Methode kann dazu führen, dass eine falsche Währung ermittelt wird, was sich wiederum auf die in der
Pay Station angezeigten Zahlungsmethoden auswirkt.
\n\n
\n\n\n Hinweis
\n Dieser API-Aufruf verwendet einen Benutzer-JWT zur Autorisierung.
\n Fügen Sie den Token im Authorization-Header im folgenden Format ein: Bearer <user_JWT>. Weitere Informationen zum Benutzer-JWT finden Sie im Block Sicherheit dieses Aufrufs.\n
",
"operationId": "create-order-with-item",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"tags": [
"payment-client-side"
],
"security": [
{
"XsollaLoginUserJWT": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-create-order-with-item-not-found-errors"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-create-order-with-item-invalid"
}
}
}
},
"/v2/project/{project_id}/free/cart": {
"post": {
"summary": "Bestellung mit einem kostenlosen Warenkorb anlegen",
"description": "Legt eine Bestellung mit allen Artikeln aus dem kostenlosen Warenkorb an. Der angelegten Bestellung wird der Bestellstatus `done` zugewiesen.",
"operationId": "create-free-order",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/cart/{cart_id}": {
"post": {
"summary": "Bestellung mit einem bestimmten kostenlosen Warenkorb anlegen",
"description": "Legt eine Bestellung mit allen Artikeln aus dem jeweiligen kostenlosen Warenkorb an. Der angelegten Bestellung wird der Bestellstatus `done` zugewiesen.",
"operationId": "create-free-order-by-cart-id",
"x-badges": [
{
"name": "Client-side",
"color": "#80eaff"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
}
],
"tags": [
"free-item"
],
"security": [
{
"AuthForCart": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Free_200-order-created"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/free/item/{item_sku}": {
"post": {
"summary": "Bestellung mit angegebenem kostenlosen Artikel anlegen",
"description": "Legt eine Bestellung mit einem angegebenen kostenlosen Artikel an. Der angelegten Bestellung wird der Bestellstatus `done` zugewiesen.
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
Hinweis\n
\n Der Paramter
user.country.value dient dazu, eine Währung für die Bestellung auszuwählen. Ist das Land des Nutzers unbekannt,\nist auch die Angabe der IP-Adresse des Nutzers im Header
X-User-Ip möglich.
Damit die Methode ordnungsgemäß funktioniert, ist eine dieser beiden Optionen erforderlich.
Die ausgewählte Währung wird für die Zahlungsmethoden in
Pay Station genutzt.\n
",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"tags": [
"payment-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-create-payment-token"
},
"responses": {
"201": {
"$ref": "#/components/responses/Cart-Payment_201-admin-create-payment-token"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-admin-create-payment-token"
}
}
}
},
"/v2/admin/project/{project_id}/cart/fill": {
"put": {
"summary": "Artikel in den Warenkorb legen",
"description": "Legt Artikel in den aktuellen Warenkorb. Wenn der Warenkorb bereits einen Artikel mit derselben SKU enthält, wird der vorhandene Artikel durch den übergebenen Wert ersetzt.",
"operationId": "admin-cart-fill",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/admin/project/{project_id}/cart/{cart_id}/fill": {
"put": {
"summary": "Warenkorb anhand der Warenkorb-ID mit Artikeln zusammenstellen",
"description": "Legt Artikel nach Warenkorb-ID in den Warenkorb. Wenn der Warenkorb bereits einen Artikel mit derselben SKU enthält, wird der vorhandene Artikel durch den übergebenen Wert ersetzt.",
"operationId": "admin-fill-cart-by-id",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/cart_id-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/x-user-for-header"
},
{
"$ref": "#/components/parameters/x-user-id-header"
}
],
"tags": [
"cart-server-side"
],
"security": [
{
"basicAuth": []
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model"
},
"401": {
"$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Cart-Payment_404-user"
},
"422": {
"$ref": "#/components/responses/Cart-Payment_422-invalid-cart"
}
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-all-user-items-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Alle Kauflimits für den angegebenen Benutzer aktualisieren",
"description": "Aktualisiert alle für den angegebenen Nutzer geltenden Artikelkauflimits, damit er diese Artikel wieder kaufen kann.\n\nDie entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Artikeltypmoduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"description": "Das Limit wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"User not found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User"
}
}
}
}
}
},
"422": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "reset-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Kauflimit aktualisieren",
"description": "Aktualisiert das Kauflimit für einen Artikel, damit ein Nutzer ihn erneut kaufen kann. Ist dem Parameter *user* der Wert `null` zugewiesen, wird das Limit für alle Nutzer aktualisiert.\n\nDie entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Artikeltypmoduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"description": "Das Limit wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits-flexible"
}
}
},
"/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"summary": "Anzahl der für einen bestimmten Benutzer verfügbaren Artikel abrufen",
"description": "Ruft die verbleibende Anzahl von Artikeln ab, die der angegebene Nutzer innerhalb des geltenden Limits noch erhalten kann.\n\nDie entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Artikeltypmoduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
}
},
"post": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Anzahl der für einen bestimmten Benutzer verfügbaren Artikel erhöhen",
"description": "Erhöht die verbleibende Anzahl von Artikeln, die der angegebene Nutzer innerhalb des geltenden Limits noch erhalten kann.\n\nDie entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Artikeltypmoduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
},
"put": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Anzahl der für einen bestimmten Benutzer verfügbaren Artikel festlegen",
"description": "Legt fest, wie viele Artikel der angegebene Nutzer innerhalb des geltenden Limits kaufen kann, nachdem das Limit erhöht oder verringert wurde.\n\nDie entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Artikeltypmoduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-flexible"
}
},
"delete": {
"tags": [
"user-limits-admin"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-user-item-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Anzahl der für einen bestimmten Benutzer verfügbaren Artikel reduzieren",
"description": "Verringert die verbleibende Anzahl von Artikeln, die der angegebene Nutzer innerhalb des geltenden Limits noch erhalten kann.\n\nDie entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Artikeltypmoduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)",
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-item-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
}
}
}
},
"422": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Item does not have configured user limits": {
"$ref": "#/components/examples/422-item-without-user-limit"
},
"Available item limit is out of range": {
"$ref": "#/components/examples/422-item-out-of-range-available-user-limit"
}
}
}
}
}
},
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
}
}
},
"/v1/projects/{project_id}/import/from_external_file": {
"post": {
"tags": [
"connector-admin"
],
"operationId": "import-items-from-external-file",
"summary": "Artikel aus JSON-Datei importieren",
"description": "Importiert Artikel aus einer JSON-Datei über die angegebene URL in den Shop. Weitere Informationen zum Import aus einer JSON-Datei finden Sie in der [Dokumentation](https://developers.xsolla.com/de/doc/shop-builder/how-to/json-import/).",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"201": {
"description": "Die Datei wurde erfolgreich importiert und wird nun verarbeitet.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"import_id": {
"type": "string",
"example": "af9f3638a16e11ef880da2cd677d2d24",
"description": "Import operation ID. If you encounter difficulties importing the JSON file, report this ID to your Customer Success Manager or send an email to csm@xsolla.com."
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/connector-422-validation-failed"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/connector-import-items-body"
}
}
},
"/v1/admin/projects/{project_id}/connectors/import_items/import/status": {
"get": {
"tags": [
"connector-admin"
],
"operationId": "get-items-import-status",
"summary": "Status des Artikelimports abrufen",
"description": "Ruft Informationen darüber ab, wie weit der Import von Artikeln in das Projekt fortgeschritten ist. Der API-Aufruf ruft Daten zum letzten Import ab, der über die API oder das Kundenportal durchgeführt wurde.",
"servers": [
{
"url": "https://connector.xsolla.com"
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-items-import-status-model"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
]
}
},
"/v2/project/{project_id}/admin/webhook/version": {
"put": {
"tags": [
"common-webhooks"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "update-webhook-version",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"summary": "Webhook-Version aktualisieren",
"description": "Aktualisiert die Webhook-Version für das Projekt. In Version 2 sind zusätzliche Parameter im `items`-Array enthalten.\n\nWeitere Informationen zu Webhooks finden Sie unter [Bestellstatus-Tracking einrichten](https://developers.xsolla.com/de/doc/shop-builder/integration-guide/set-up-webhooks/).",
"responses": {
"204": {
"description": "Webhook-Version wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"422": {
"description": "Fehler bei der Anfragevalidierung.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request-extended"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"errorMessageExtended": [
{
"property": "version",
"message": "Must have a minimum value of 1"
}
],
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "integer",
"description": "Webhook version. Version 1 is used by default. In version 2, the `items` array includes the following parameters: `is_free`, `is_bonus`, and `is_bundle_content` parameters.",
"enum": [
1,
2
],
"example": 2
}
},
"required": [
"version"
]
},
"example": {
"version": 2
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": {
"get": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "get-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Informationen zum Artikelvorbestelllimit abrufen",
"description": "Rufen Sie das Vorbestelllimit des Artikels ab.\n\nDie entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Moduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliasse für diesen Endpunkt:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"200": {
"description": "Informationen zum Artikelvorbestelllimit wurden erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1
},
"sku": {
"type": "string",
"example": "com.xsolla.item_1"
},
"is_pre_order_limit_enabled": {
"type": "boolean",
"example": true
},
"available": {
"type": "integer",
"example": 431
},
"reserved": {
"type": "integer",
"example": 13
},
"sold": {
"type": "integer",
"example": 556
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.item_1",
"is_pre_order_limit_enabled": true,
"available": 431,
"reserved": 13,
"sold": 556
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden."
}
}
},
"post": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "add-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Artikelvorbestelllimit um Mengenangabe ergänzen",
"description": "Ergänzen Sie das Vorbestelllimit des Artikels um eine Mengenangabe.\n\nDie entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Moduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliasse für diesen Endpunkt:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"201": {
"description": "Das Mengenlimit wurde erfolgreich ergänzt."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to add."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "set-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Mengenangabe für das Vorbestelllimit des Artikels festlegen",
"description": "Legen Sie eine Mengenangabe für das Vorbestelllimit des Artikels fest.\n\nDie entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Moduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliasse für diesen Endpunkt:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "Das Mengenlimit wurde erfolgreich festgelegt."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to set."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
},
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Mengenangabe für das Vorbestelllimit des Artikels entfernen",
"description": "Entfernen Sie eine Mengenangabe für das Vorbestelllimit des Artikels.\n\nDie entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Moduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliasse für diesen Endpunkt:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "Das Mengenlimit wurde erfolgreich entfernt."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"description": "Quantity to remove."
}
},
"required": [
"quantity"
]
},
"example": {
"quantity": 100000
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": {
"put": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "toggle-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Vorbestelllimit des Artikels aktivieren/deaktivieren",
"description": "Aktiviert/deaktiviert das Vorbestelllimit des Artikels.\n\nDie entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Moduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliasse für diesen Endpunkt:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "Das Limit wurde deaktiviert/aktiviert."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden."
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"is_pre_order_limit_enabled": {
"type": "boolean"
}
},
"required": [
"is_pre_order_limit_enabled"
]
},
"example": {
"is_pre_order_limit_enabled": true
}
}
}
}
}
},
"/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": {
"delete": {
"tags": [
"common-pre-orders"
],
"security": [
{
"basicAuth": []
}
],
"operationId": "remove-all-pre-order-limit",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"summary": "Alle Mengenangaben für das Vorbestelllimit des Artikels entfernen",
"description": "Entfernen Sie alle Mengenangaben für das Vorbestelllimit des Artikels.\n\nDie entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" des gewünschten Moduls:\n* [Spielschlüssel](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-game/)\n* [Virtuelle Gegenstände und Währung](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [Bundles](https://developers.xsolla.com/de/api/shop-builder/operation/admin-get-bundle-list/)\n\nAliasse für diesen Endpunkt:\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}",
"responses": {
"204": {
"description": "Das Limit wurde erfolgreich entfernt."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"description": "Artikel nicht gefunden."
}
}
}
},
"/v2/merchant/{merchant_id}/projects": {
"get": {
"tags": [
"common-merchant"
],
"operationId": "get-projects",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"security": [
{
"basicMerchantAuth": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/merchant_id-path-param"
}
],
"summary": "Projekte abrufen",
"description": "Ruft die Liste der Projekte des Händlers ab.\n\n\n
Bemerkung
Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.
\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
\nAchtung
\nBei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.\n
\n\n
\n\n\n
Hinweis\n Dieser API-Aufruf gibt generische Katalogdaten zurück, wenn er ohne Autorisierung verwendet wird. Verwenden Sie die Autorisierung, um
personalisierte Nutzerdaten abzurufen, wie z. B. mit dem Artikel verknüpfte Limits und Werbeaktionen. Dazu müssen Sie den Benutzer-JWT im
Authorization-Header übermitteln. Weitere Informationen zum Benutzer-JWT finden Sie im Block
Sicherheit für diesen Aufruf.\n
Hinweis
Wenn Sie ein Artikelattribut löschen, gehen alle zugehörigen Daten und Verbindungen zu anderen Artikeln verloren.
",
"operationId": "delete-attribute",
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"security": [
{
"basicAuth": []
}
],
"responses": {
"204": {
"description": "Attribut wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value": {
"post": {
"summary": "Attributwert erstellen",
"description": "Erstellt einen Attributwert.\n\nAchtung
Bei allen Projekten ist die Anzahl der Attributwerte begrenzt. Der Standard- und Höchstwert beträgt 20 Werte pro Attribut.
",
"operationId": "admin-create-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-attribute-value"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "Alle Werte des Attributs löschen",
"description": "Löscht alle Werte des Attributs.\n\nHinweisWenn Sie den Wert eines Attributs löschen, gehen alle Verbindungen zwischen dem Attribut und den Artikeln verloren. Verwenden Sie zum Ändern des Attributwerts eines Artikels den API-Aufruf
Attributwert aktualisieren, anstatt den Wert zu löschen und einen neuen zu erstellen.
",
"operationId": "admin-delete-all-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Attributwerte wurden erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
},
"/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": {
"put": {
"summary": "Attributwert aktualisieren",
"description": "Aktualisiert einen Attributwert.",
"operationId": "admin-update-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-update-attribute-value"
},
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Attributwert wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
},
"404": {
"$ref": "#/components/responses/404-attribute-value-not-found"
},
"422": {
"$ref": "#/components/responses/422-create-update-attribute-value"
}
}
},
"delete": {
"summary": "Attributwert löschen",
"description": "Löscht einen Attributwert.\n\nHinweisWenn Sie den Wert eines Attributs löschen, gehen alle Verbindungen zwischen dem Attribut und den Artikeln verloren. Verwenden Sie zum Ändern des Attributwerts eines Artikels den API-Aufruf
Attributwert aktualisieren, anstatt den Wert zu löschen und einen neuen zu erstellen.
",
"operationId": "admin-delete-attribute-value",
"security": [
{
"basicAuth": []
}
],
"x-badges": [
{
"name": "Server-side",
"color": "#95ff80"
},
{
"name": "Admin",
"color": "#d7dee0"
}
],
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_external_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-attr-path-param"
}
],
"tags": [
"attribute-admin"
],
"responses": {
"204": {
"description": "Attributwert wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
}
}
}
},
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"description": "Serverseitige Aufrufe verwenden das Authentifizierungsschema `basicAuth`. Alle Anfragen an die API müssen den Header `Authorization: Basic ` enthalten, wobei `your_authorization_basic_key` das gemäß dem Base64-Standard kodierte `project_id:api_key`-Paar ist.\n\nSie können bei Bedarf `merchant_id` anstelle von `project_id` verwenden. Dies hat keine Auswirkungen auf die Funktionalität.\n\nWechseln Sie ins [Kundenportal](https://publisher.xsolla.com/), um die Werte der Parameter zu erhalten:\n\n* `merchant_id` wird angezeigt:\n * unter **Firmeneinstellungen > Firma**.\n * in der URL in der Adressleiste des Browsers auf einer beliebigen Seite im Kundenportal. Die URL hat das folgende Format: `https://publisher.xsolla.com/`.\n* `api_key` wird im Kundenportal nur einmal angezeigt, nämlich dann, wenn er erstellt wird. Sie sind selbst dafür verantwortlich, den Schlüssel in Ihrem System zu speichern. Einen API-Schlüssel können Sie an den folgenden Orten erstellen:\n * unter [Firmeneinstellungen > API-Schlüssel](https://publisher.xsolla.com/0/settings/api_key)\n * unter [Projekteinstellungen > API-Schlüssel](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**Hinweis**\n\nFalls bei einem erforderlichen API-Aufruf der Pfadparameter `project_id` fehlt, müssen Sie einen API-Schlüssel verwenden, der für alle Projekte der Firma gültig ist.\n\n* `project_id` wird angezeigt:\n * neben dem Projektnamen im Kundenportal.\n * in der URL in der Adressleiste des Browsers, wenn Sie im Kundenportal ein Projekt geöffnet haben. Die URL hat das folgende Format: `https://publisher.xsolla.com//projects/`.\n\nWeitere Informationen zur Handhabung von API-Schlüsseln finden Sie in der [API-Referenz](https://developers.xsolla.com/de/api/getting-started/#api_keys_overview).",
"scheme": "basic"
},
"XsollaLoginUserJWT": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "Clientseitige Aufrufe verwenden das Authentifizierungsschema `XsollaLoginUserJWT`. In der Anfrage muss der JWT des Nutzers im `Authorization`-Header im folgenden Format enthalten sein: Bearer ``. Der Token identifiziert den Nutzer und gewährt Zugriff auf personalisierte Daten. Weitere Informationen zur Erstellung eines Tokens finden Sie in der [Dokumentation zur Xsolla-Login-API](/de/api/login/authentication-schemes#getting-user-token).\n\nAlternativ können Sie einen [Token zum Öffnen des Zahlungsportals verwenden](/de/api/pay-station/token/create-token)."
},
"AuthForCart": {
"type": "http",
"scheme": "bearer",
"description": "Das Authentifizierungsschema `AuthForCart` wird für Warenkorbkäufe verwendet und unterstützt zwei Modi:\n\n1. Authentifizierung mit einem Benutzer-JWT. Der Token wird im Authorization-Header im folgenden Format übermittelt: `Authorization: Bearer `, wobei `` der Benutzertoken ist. Der Token dient dazu, den Nutzer zu identifizieren und ihm Zugriff auf personalisierte Daten zu ermöglichen.\n\nAlternativ können Sie einen [Token zum Öffnen des Zahlungsportals verwenden](/de/api/pay-station/token/create-token).\n\n2. Vereinfachter Modus ohne `Authorization`-Header. Dieser Modus kommt nur bei nicht authentifizierten Nutzern zum Einsatz und kann nur für den [Verkauf von Spielschlüsseln](/de/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users) verwendet werden. Anstelle eines Tokens muss die Anfrage die folgenden Header enthalten:\n* `x-unauthorized-id` samt Anfrage-ID\n* `x-user` samt Base64-kodierter E-Mail-Adresse des Nutzers."
},
"basicMerchantAuth": {
"type": "http",
"description": "Serverseitige Aufrufe verwenden das Authentifizierungsschema `basicMerchantAuth`. Alle Anfragen an die API müssen den Header `Authorization: Basic ` enthalten, wobei `your_authorization_basic_key` das gemäß dem Base64-Standard kodierte `merchant_id:api_key`-Paar ist.\n\nWechseln Sie ins [Kundenportal](https://publisher.xsolla.com/), um die Werte der Parameter zu erhalten:\n\n* `merchant_id` wird angezeigt:\n * unter **Firmeneinstellungen > Firma**\n * in der URL in der Adressleiste des Browsers auf einer beliebigen Seite im Kundenportal. Die URL hat das folgende Format: `https://publisher.xsolla.com/`\n* `api_key` wird im Kundenportal nur einmal angezeigt, nämlich dann, wenn er erstellt wird. Sie sind selbst dafür verantwortlich, den Schlüssel in Ihrem System zu speichern. Einen neuen Schlüssel können Sie unter [Firmeneinstellungen > API-Schlüssel](https://publisher.xsolla.com/0/settings/api_key) erstellen.\n\nWeitere Informationen zur Handhabung von API-Schlüsseln finden Sie in der [API-Referenz](https://developers.xsolla.com/de/api/getting-started/#api_keys_overview).",
"scheme": "basic"
}
},
"parameters": {
"project_id-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "Projekt-ID. Dieser Parameter wird im [Kundenportal](https://publisher.xsolla.com/0/projects/0/) neben dem Projektnamen angezeigt sowie in der Adressleiste des Browsers, wenn Sie im Kundenportal ein Projekt geöffnet haben. Die URL hat das folgende Format: `https://publisher.xsolla.com//projects/`.",
"schema": {
"type": "integer",
"example": 44056
}
},
"limit-query-param": {
"name": "limit",
"in": "query",
"example": 50,
"required": false,
"description": "Begrenzung der Elementanzahl auf der Seite.",
"schema": {
"type": "integer",
"example": 50,
"minimum": 1
}
},
"offset-query-param": {
"name": "offset",
"in": "query",
"required": false,
"example": 0,
"description": "Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).",
"schema": {
"type": "integer",
"example": 0,
"minimum": 0
}
},
"external_id-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "Bei der Erstellung angegebene [Externe Artikelgruppen-ID](/de/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id).",
"schema": {
"type": "string",
"example": "weapons"
}
},
"group_id-path-param": {
"name": "group_id",
"in": "path",
"required": true,
"description": "Gruppen-ID.",
"schema": {
"type": "integer",
"example": 10
}
},
"item_sku-path-param": {
"name": "item_sku",
"in": "path",
"required": true,
"description": "Artikel-SKU.",
"schema": {
"type": "string",
"example": "booster_mega_1"
}
},
"virtual_currency_sku-path-param": {
"name": "virtual_currency_sku",
"in": "path",
"required": true,
"description": "SKU der virtuellen Währung.",
"schema": {
"type": "string",
"example": "crystal"
}
},
"locale-query-param": {
"name": "locale",
"in": "query",
"required": false,
"description": "Antwortsprache. Sprachencode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1 (zum Beispiel `en`). Fünfstellige Gebietsschemacodes (zum Beispiel `en-US`) werden in Lokalisierungsfeldern wie `name` und `description` unterstützt, jedoch in den Antworten in zweistellige Codes umgewandelt. Die vollständige Liste der unterstützten Sprachen finden Sie in der [Dokumentation](https://developers.xsolla.com/de/doc/shop-builder/references/supported-languages/).",
"schema": {
"type": "string",
"default": "en"
}
},
"additional_fields-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "Zusätzliche Felder, die in die Antwort aufgenommen werden sollen. Standardmäßig werden diese Felder nicht zurückgegeben. Übermitteln Sie die erforderlichen Werte, um sie einzubeziehen.",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"media_list",
"order",
"long_description",
"custom_attributes",
"item_order_in_group"
]
}
}
},
"country-query-param": {
"name": "country",
"in": "query",
"required": false,
"description": "Zweistelliger Ländercode in Großbuchstaben gemäß [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Weitere Informationen zu [den von Xsolla unterstützten Ländern](https://developers.xsolla.com/de/doc/shop-builder/references/supported-countries/) und dazu, [wie das Land ermittelt wird](https://developers.xsolla.com/de/doc/shop-builder/features/pricing-policy/#pricing_policy_country_determination), finden Sie in der Dokumentation.",
"schema": {
"type": "string",
"example": "US"
}
},
"promo_code-query-param": {
"name": "promo_code",
"in": "query",
"required": false,
"description": "Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.",
"schema": {
"type": "string",
"example": "WINTER2021",
"minLength": 1,
"maxLength": 128
}
},
"show_inactive_time_limited_items-query-param": {
"name": "show_inactive_time_limited_items",
"in": "query",
"required": false,
"description": "Zeigt zeitlich begrenzte Artikel an, die nicht erhältlich sind. Der Gültigkeitszeitraum dieser Artikel hat noch nicht begonnen oder ist bereits vorüber.",
"schema": {
"type": "integer",
"example": 1,
"default": 0
}
},
"virtual_currency_package_sku-path-param": {
"name": "virtual_currency_package_sku",
"in": "path",
"required": true,
"description": "SKU des virtuellen Währungspakets.",
"schema": {
"type": "string",
"example": "crystal-pack"
}
},
"with_geo-query-param": {
"name": "with_geo",
"in": "query",
"required": false,
"description": "Ob die Angaben zum Gebietsscheme und zum Land des Nutzers in den Antwort-Headern zurückgegeben werden sollen. Wenn dieser Wert auf `true` gesetzt ist, enthält die Antwort die Header `X-User-Locale-Code` und `X-User-Country-Code`.",
"schema": {
"type": "boolean",
"default": false
}
},
"item_type-group-path-param": {
"name": "item_type",
"in": "path",
"required": true,
"description": "Zum Filtern von Gruppen verwendeter Artikeltyp. Legt fest, welche Artikel in `items_count` enthalten sind. Werte mit `/` (z. B. `virtual_currency/package` oder `game/key`), müssen URL-kodiert sein (z. B. `virtual_currency%2Fpackage`).",
"schema": {
"type": "string",
"enum": [
"virtual_items",
"virtual_currency",
"virtual_currency/package",
"game/key",
"bundle",
"game",
"value_points",
"subscription_plans"
],
"example": "virtual_items"
}
},
"id-group-path-param": {
"name": "id",
"in": "path",
"required": true,
"description": "Von Xsolla zugewiesene Artikelgruppen-ID.",
"schema": {
"type": "integer",
"example": 1
}
},
"platform-query-param": {
"name": "platform",
"in": "query",
"required": false,
"description": "Publishing-Plattform, auf der der Nutzer spielt: `xsolla` (Standard), `playstation_network`, `xbox_live`, `pc_standalone`, `nintendo_shop`, `google_play`, `app_store_ios`, `android_standalone`, `ios_standalone`, `android_other`, `ios_other`, `pc_other`.",
"schema": {
"type": "string",
"enum": [
"playstation_network",
"xbox_live",
"xsolla",
"pc_standalone",
"nintendo_shop",
"google_play",
"app_store_ios",
"android_standalone",
"ios_standalone",
"android_other",
"ios_other",
"pc_other"
],
"default": "xsolla"
}
},
"item_id-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "Artikel-ID.",
"schema": {
"type": "string",
"example": "656"
}
},
"user_email-query-param": {
"name": "user_email",
"in": "query",
"required": true,
"description": "E-Mail-Adresse des Nutzers.",
"schema": {
"type": "string",
"example": "email@email.com"
}
},
"quantity-query-param": {
"name": "quantity",
"in": "query",
"required": true,
"description": "Codemenge.",
"schema": {
"type": "integer",
"example": 100
}
},
"reason-query-param": {
"name": "reason",
"in": "query",
"required": true,
"description": "Grund für den Empfang von Codes.",
"schema": {
"type": "string",
"example": "Very important"
}
},
"region_id-query-param": {
"name": "region_id",
"in": "query",
"required": false,
"description": "Regions-ID.",
"schema": {
"type": "integer",
"default": 1
}
},
"sandbox-query-param": {
"name": "sandbox",
"in": "query",
"required": false,
"description": "Welche Arten von Berechtigungen zurückgegeben werden sollen. Ist der Parameter auf 1 gesetzt, werden nur die Berechtigungen zurückgegeben, die der Nutzer in der Testumgebung erhalten hat. Falls der Parameter nicht übermittelt wird oder auf 0 gesetzt ist, werden nur die Berechtigungen zurückgegeben, die der Nutzer im Live-Modus erhalten hat.",
"schema": {
"type": "integer",
"default": 0
}
},
"additional_fields-entitlement-query-param": {
"name": "additional_fields[]",
"in": "query",
"required": false,
"description": "Die Liste der zusätzlichen Felder. Diese Felder sind in der Antwort enthalten, sofern Sie diese in der Anfrage senden. Verfügbare Felder: `attributes`.",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
"sku-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "Bundle-SKU.",
"schema": {
"type": "string",
"example": "kg_1"
}
},
"cart_id-path-param": {
"name": "cart_id",
"in": "path",
"required": true,
"description": "Warenkorb-ID.",
"schema": {
"type": "string",
"example": "custom_id"
}
},
"currency-query-param": {
"name": "currency",
"in": "query",
"required": false,
"description": "Die im Warenkorb angezeigte Währung des Artikelpreises. Dreistelliger Währungscode pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/).",
"schema": {
"type": "string",
"default": "USD"
}
},
"order_id-path-param": {
"name": "order_id",
"in": "path",
"required": true,
"description": "Bestell-ID.",
"schema": {
"type": "string",
"example": "656"
}
},
"x-user-for-header": {
"in": "header",
"name": "x-user-for",
"example": "ACCESS_TOKEN/LOGIN_JWT",
"schema": {
"type": "string"
},
"required": false,
"description": "Die Benutzerkennung kann mithilfe des Xsolla-Login-Benutzer-JWT oder des [Bezahlstation-Zugriffstokens](https://developers.xsolla.com/de/pay-station-api/current/token/create-token) übermittelt werden."
},
"x-user-id-header": {
"in": "header",
"name": "x-user-id",
"example": "UNIQUE_ID",
"schema": {
"maxLength": 32,
"type": "string"
},
"required": false,
"description": "Sie können Ihre eigene Benutzer-ID verwenden, wenn Sie einen Warenkorb mit Spielen verkaufen."
},
"user_external_id-query-param": {
"name": "user_external_id",
"in": "query",
"required": true,
"description": "Externe Benutzer-ID",
"schema": {
"type": "string",
"example": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
},
"merchant_id-path-param": {
"name": "merchant_id",
"in": "path",
"required": true,
"description": "Händler-ID.",
"schema": {
"type": "integer",
"example": 121212
}
},
"project_id_59080-path-param": {
"name": "project_id",
"in": "path",
"required": true,
"description": "Projekt-ID. Dieser Parameter wird im [Kundenportal](https://publisher.xsolla.com/) neben dem Projektnamen angezeigt.",
"schema": {
"type": "integer",
"example": 59080
}
},
"item_id_59080-path-param": {
"name": "item_id",
"in": "path",
"required": true,
"description": "Artikel-ID.",
"schema": {
"type": "string",
"example": "259774"
}
},
"item_sku_59080-path-param": {
"name": "sku",
"in": "path",
"required": true,
"description": "Artikel-SKU.",
"schema": {
"type": "string",
"example": "electric_shield"
}
},
"external_id_59080-group-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "Externe ID der Gruppe.",
"schema": {
"type": "string",
"default": "armour"
}
},
"region_id-path-param": {
"name": "region_id",
"in": "path",
"required": true,
"description": "Regions-ID. Eindeutige Regionskennung innerhalb des Projekts.",
"schema": {
"type": "integer",
"example": 42
}
},
"external_id-attr-path-param": {
"name": "external_id",
"in": "path",
"required": true,
"description": "Externe ID des Attributs.",
"schema": {
"type": "string",
"example": "attribute_id"
}
},
"value_external_id-path-param": {
"name": "value_external_id",
"in": "path",
"required": true,
"description": "Externe ID des Attributwerts.",
"schema": {
"type": "string",
"pattern": "^[-_\\.\\d\\w]+$",
"example": "value_id"
}
}
},
"schemas": {
"Virtual-Items-Currency_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "booster_mega_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "Eindeutige Attribut-ID. Die `external_id` darf nur lateinische Klein- und Großbuchstaben, Ziffern, Bindestriche und Unterstriche enthalten."
},
"admin-attribute-name": {
"type": "object",
"description": "Objekt mit lokalisierten Attributnamen. Schlüssel sind in ISO 3166-1 spezifiziert.",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Genre",
"de": "Genre"
},
"default": {
"en": "Genre",
"de": "Genre"
}
},
"value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "Eindeutige Wert-ID für ein Attribut. Die `external_id` darf nur lateinische Kleinbuchstaben, alphanumerische Zeichen, Binde- und Unterstriche enthalten."
},
"value-name": {
"type": "object",
"description": "Objekt mit lokalisierten Wertnamen. Schlüssel sind in ISO 3166-1 spezifiziert.",
"additionalProperties": {
"type": "string"
},
"example": {
"en": "Strategy",
"de": "Strategie"
},
"default": {
"en": "Strategy",
"de": "Strategie"
}
},
"attribute-value": {
"type": "object",
"required": [
"value",
"external_id"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_external_id",
"name": {
"en": "Value 1",
"de": "Wert 1"
}
}
},
"attribute": {
"type": "object",
"required": [
"external_id",
"values"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
},
"example": {
"external_id": "attribute_external_id",
"name": {
"en": "Attribute name",
"de": "Attributname"
},
"values": [
{
"external_id": "value_1",
"name": {
"en": "value 1",
"de": "wert 1"
}
},
{
"external_id": "value_2",
"name": {
"en": "value 2",
"de": "wert 2"
}
}
]
}
},
"Virtual-Items-Currency_schemas-admin-attributes": {
"type": "array",
"description": "Liste der Attribute.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Virtual-Items-Currency_admin-attributes": {
"allOf": [
{
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes"
},
{
"description": "Liste der Attribute."
}
]
},
"two-letter-locale": {
"type": [
"object",
"null"
],
"description": "Sprachencodes bestehend aus zwei Kleinbuchstaben.",
"title": "zweistellig",
"properties": {
"en": {
"type": [
"string",
"null"
],
"description": "Englisch"
},
"ar": {
"type": [
"string",
"null"
],
"description": "Arabisch"
},
"bg": {
"type": [
"string",
"null"
],
"description": "Bulgarisch"
},
"cn": {
"type": [
"string",
"null"
],
"description": "Chinesisch (vereinfacht)"
},
"cs": {
"type": [
"string",
"null"
],
"description": "Tschechisch"
},
"de": {
"type": [
"string",
"null"
],
"description": "Deutsch"
},
"es": {
"type": [
"string",
"null"
],
"description": "Spanisch (Spanien)"
},
"fr": {
"type": [
"string",
"null"
],
"description": "Französisch"
},
"he": {
"type": [
"string",
"null"
],
"description": "Hebräisch"
},
"it": {
"type": [
"string",
"null"
],
"description": "Italienisch"
},
"ja": {
"type": [
"string",
"null"
],
"description": "Japanisch"
},
"ko": {
"type": [
"string",
"null"
],
"description": "Koreanisch"
},
"pl": {
"type": [
"string",
"null"
],
"description": "Polnisch"
},
"pt": {
"type": [
"string",
"null"
],
"description": "Portugiesisch"
},
"ro": {
"type": [
"string",
"null"
],
"description": "Rumänisch"
},
"ru": {
"type": [
"string",
"null"
],
"description": "Russisch"
},
"th": {
"type": [
"string",
"null"
],
"description": "Thai"
},
"tr": {
"type": [
"string",
"null"
],
"description": "Türkisch"
},
"tw": {
"type": [
"string",
"null"
],
"description": "Chinesisch (traditionell)"
},
"vi": {
"type": [
"string",
"null"
],
"description": "Vietnamesisch"
},
"km": {
"type": [
"string",
"null"
],
"description": "Khmer"
},
"id": {
"type": [
"string",
"null"
],
"description": "Indonesisch"
},
"lo": {
"type": [
"string",
"null"
],
"description": "Laotisch"
},
"my": {
"type": [
"string",
"null"
],
"description": "Birmanisch"
},
"ph": {
"type": [
"string",
"null"
],
"description": "Filipino"
},
"ne": {
"type": [
"string",
"null"
],
"description": "Nepalesisch"
}
}
},
"five-letter-locale": {
"type": [
"object",
"null"
],
"description": "Fünfstellige Gebietsschemacodes.",
"title": "fünfstellig",
"properties": {
"en-US": {
"type": [
"string",
"null"
],
"description": "Englisch"
},
"ar-AE": {
"type": [
"string",
"null"
],
"description": "Arabisch"
},
"bg-BG": {
"type": [
"string",
"null"
],
"description": "Bulgarisch"
},
"zh-CN": {
"type": [
"string",
"null"
],
"description": "Chinesisch (vereinfacht)"
},
"cs-CZ": {
"type": [
"string",
"null"
],
"description": "Tschechisch"
},
"de-DE": {
"type": [
"string",
"null"
],
"description": "Deutsch"
},
"es-ES": {
"type": [
"string",
"null"
],
"description": "Spanisch (Spanien)"
},
"fr-FR": {
"type": [
"string",
"null"
],
"description": "Französisch"
},
"he-IL": {
"type": [
"string",
"null"
],
"description": "Hebräisch"
},
"it-IT": {
"type": [
"string",
"null"
],
"description": "Italienisch"
},
"ja-JP": {
"type": [
"string",
"null"
],
"description": "Japanisch"
},
"ko-KR": {
"type": [
"string",
"null"
],
"description": "Koreanisch"
},
"pl-PL": {
"type": [
"string",
"null"
],
"description": "Polnisch"
},
"pt-BR": {
"type": [
"string",
"null"
],
"description": "Portugiesisch (Brasilien)"
},
"ro-RO": {
"type": [
"string",
"null"
],
"description": "Rumänisch"
},
"ru-RU": {
"type": [
"string",
"null"
],
"description": "Russisch"
},
"th-TH": {
"type": [
"string",
"null"
],
"description": "Thai"
},
"tr-TR": {
"type": [
"string",
"null"
],
"description": "Türkisch"
},
"zh-TW": {
"type": [
"string",
"null"
],
"description": "Chinesisch (traditionell)"
},
"vi-VN": {
"type": [
"string",
"null"
],
"description": "Vietnamesisch"
},
"km-KH": {
"type": [
"string",
"null"
],
"description": "Khmer"
},
"id-ID": {
"type": [
"string",
"null"
],
"description": "Indonesisch"
},
"lo-LA": {
"type": [
"string",
"null"
],
"description": "Laotisch"
},
"my-MM": {
"type": [
"string",
"null"
],
"description": "Birmanisch"
},
"ph-PH": {
"type": [
"string",
"null"
],
"description": "Filipino"
},
"ne-NP": {
"type": [
"string",
"null"
],
"description": "Nepalesisch"
}
}
},
"name-localization-object": {
"type": [
"object",
"null"
],
"description": "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](/de/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"description-localization-object": {
"type": [
"object",
"null"
],
"description": "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](/de/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"long-description-localization-object": {
"type": [
"object",
"null"
],
"description": "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](/de/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"Virtual-Items-Currency_admin-groups-response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "Gruppen, zu denen der Artikel gehört.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "Name des Artikels. Sollte Schlüssel-Wert-Paare enthalten,\nwobei der Schlüssel ein Gebietsschema im Format \"^[a–z]{2}\" und der Wert ein String ist.",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Virtual-Items-Currency_admin-media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Zusätzliche Medieninhalte des Artikels wie Screenshots, Gameplay-Videos usw.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Medieninhaltstyp: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Ressourcendatei."
}
}
}
},
"Virtual-Items-Currency_type": {
"type": "string",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"Virtual-Items_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"amount": {
"description": "Betrag.",
"type": "number",
"exclusiveMinimum": 0
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
},
"country_iso": {
"type": "string",
"description": "Zweistelliger Ländercode in Großbuchstaben gemäß [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Weitere Informationen zu den [von Xsolla unterstützten Ländern](https://developers.xsolla.com/de/doc/shop-builder/references/supported-countries/) finden Sie in der Dokumentation.
Beispiel: `country=US`",
"example": "US"
},
"is_default": {
"type": "boolean",
"default": false
},
"is_enabled": {
"type": "boolean",
"default": true
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true
}
}
},
"Virtual-Items-Currency_schemas-sku": {
"type": "string",
"example": "bundle_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"Virtual-Items-Currency_admin-get-vc_prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"sku",
"amount"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"description": "Betrag.",
"type": "number",
"exclusiveMinimum": 0
},
"is_default": {
"type": "boolean",
"default": false
}
},
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true
}
}
},
"Virtual-Items-Currency_admin-image_url": {
"type": "string",
"description": "Bild-URL. Damit das Bild im Zahlungsportal korrekt angezeigt und schnell geladen wird, beachten Sie bitte unsere Richtlinien für Bilder und URLs:- Unterstützte Formate: WebP (empfohlen), PNG, JPG.
- Dateigröße: ≤ 50 kB (für WebP) oder ≤ 150 kB (für PNG und JPG).
- Bildgröße: 280 x 280 px.
- Farbraum: sRGB.
- Protokoll: HTTPS mit langlebigem Caching für versionierte URLs.
"
},
"value-is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Ob der Artikel kostenlos ist."
},
"value-is_paid_randomized_reward": {
"type": "boolean",
"example": false,
"default": false,
"description": "Ob der Artikel eine kostenpflichtige zufällige Belohnung ist, z. B. eine Lootbox."
},
"Virtual-Items-Currency_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "Reihenfolge, in der die Artikel im Katalog angezeigt werden. Je höher der Wert, desto weiter unten erscheint der Artikel in der Liste.\nBei gleichen Werten werden die Artikel nach Erstellungsdatum sortiert, wobei neuere Artikel weiter oben angezeigt werden."
},
"Virtual-Items-Currency_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Ob der Artikel verfügbar ist. Falls `false` festgelegt ist, kann der Artikel weder im Shop erworben noch als Teil eines Bundles oder im Rahmen einer Marketingkampagne bezogen werden. Ausführliche Informationen zur Verfügbarkeit von Artikeln finden Sie in unserer [Dokumentation](https://developers.xsolla.com/de/items-catalog/catalog-features/items-availability/)."
},
"Virtual-Items-Currency_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "Ob der Artikel im Katalog angezeigt wird. Wenn `false` und `is_enabled: true` festgelegt ist, ist der Artikel im Katalog nicht sichtbar, kann jedoch als Teil eines Bundles oder im Rahmen von Marketingkampagnen bezogen werden. Ausführliche Informationen zur Verfügbarkeit von Artikeln finden Sie in unserer [Dokumentation](https://developers.xsolla.com/de/items-catalog/catalog-features/items-availability/)."
},
"Virtual-Items-Currency_admin-regions": {
"description": "Array der Regionen, in denen der Artikel erhältlich ist. Ist das Array leer oder wird es nicht übermittelt, ist der Artikel in allen Regionen erhältlich.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1,
"description": "Regions-ID innerhalb des Projekts.\n\nAusführliche Informationen finden Sie in der [Dokumentation zu den regionalen Verkaufsbeschränkungen](https://developers.xsolla.com/de/items-catalog/catalog-features/regional-restrictions/) sowie in den [API-Aufrufen zur Regionsverwaltung](https://developers.xsolla.com/de/api/catalog/common-regions)."
}
}
}
},
"limit_exceeded_visibility": {
"type": "string",
"example": "show",
"enum": [
"show",
"hide"
],
"description": "Steuert die Sichtbarkeit des Artikels im Katalog nach Erreichen des Kauflimits, und zwar bis das Limit das nächste Mal zurückgesetzt wird.\n\nGilt für Artikel, bei denen im Array `recurrent_schedule` Limits konfiguriert sind, die regelmäßig zurückgesetzt werden.\n\nWenn festgelegt ist, dass das Kauflimit nicht zurückgesetzt wird, wird der Artikel nach Erreichen des Kauflimits nicht mehr im Katalog angezeigt, unabhängig davon, welcher Wert für `limit_exceeded_visibility` festgelegt ist.\n\nMögliche Wert:\n- `show` – Der Artikel wird in API-Aufrufen zur Katalogabfrage zurückgegeben, auch wenn das Kauflimit bereits erreicht wurde.\nBei clientseitigen API-Aufrufen zur Katalogabfrage wird der Artikel nach Erreichen des Limits mit dem Flag `can_be_bought: false` zurückgegeben.\nDas Datum, an dem das Limit das nächste Mal zurückgesetzt wird, wird im Parameter `reset_next_date` zurückgegeben.\n- `hide` – nachdem das Kauflimit erreicht wurde, wird der Artikel bei API-Aufrufen zur Katalogabfrage nicht mehr zurückgegeben, bis das Limit zurückgesetzt wird.",
"default": "show"
},
"admin_recurrent_schedule_response": {
"type": [
"object",
"null"
],
"description": "Aktualisierungszeitraum begrenzen.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Aktualisierungszeitraum für das Nutzerlimit.",
"oneOf": [
{
"type": "object",
"title": "interval_type = daily",
"description": "Tägliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Typ des wiederkehrenden Aktualisierungszeitraums.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Datum und Uhrzeit der Limitaktualisierung (Unix-Zeitstempel).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Datum und Uhrzeit der ersten Limitaktualisierung (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Datum und Uhrzeit, zu der die Limits zurückgesetzt werden sollen (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = weekly",
"description": "Wöchentliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Typ des wiederkehrenden Aktualisierungszeitraums.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": [
"integer",
"null"
],
"description": "Wochentag, an dem die Limits aktualisiert werden. 1 seht für Montag, und 7 steht für Sonntag. `null` ist bei Limitaktualisierungszeiträumen vom Typ `weekly` unzulässig.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Datum und Uhrzeit der Limitaktualisierung (Unix-Zeitstempel).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Datum und Uhrzeit der ersten Limitaktualisierung (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Datum und Uhrzeit, zu der die Limits zurückgesetzt werden sollen (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Monatliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Typ des wiederkehrenden Aktualisierungszeitraums.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": [
"integer",
"null"
],
"description": "Tag im Monat, an dem die Limits aktualisiert werden. Hat der Monat weniger Tage als der ausgewählte Tag, erfolgt die Aktualisierung am letzten Tag des Monats. `null` ist bei Limitaktualisierungszeiträumen vom Typ `monthly` unzulässig.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).",
"format": "full-time",
"example": "11:00:00+03:00"
},
"reset_next_date": {
"type": "integer",
"description": "Datum und Uhrzeit der Limitaktualisierung (Unix-Zeitstempel).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Datum und Uhrzeit der ersten Limitaktualisierung (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Datum und Uhrzeit, zu der die Limits zurückgesetzt werden sollen (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Die Nutzerlimits werden gemäß dem in Stunden angegebenen Zeitintervall zurückgesetzt.",
"properties": {
"interval_type": {
"type": "string",
"description": "Typ des wiederkehrenden Aktualisierungszeitraums.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"description": "Zeitintervall in Stunden, nach dessen Ablauf das Limit zurückgesetzt wird.
Der Countdown beginnt in dem Moment, in dem der Artikel zum ersten Mal im Shop angezeigt wird, wie im Parameter date_from angegeben.
Sind beispielsweise `date_from = \"2025-11-15T18:15:00+05:00\"` und `hours_interval = 2` angegeben, wird das Kauflimit für diesen Artikel alle zwei Stunden ab dem `\"2025-11-15T20:15:00+05:00\"` zurückgesetzt.",
"minimum": 1,
"maximum": 10000
},
"reset_next_date": {
"type": "integer",
"description": "Datum und Uhrzeit der Limitaktualisierung (Unix-Zeitstempel).",
"example": 1677553200
},
"displayable_reset_start_date": {
"description": "Datum und Uhrzeit der ersten Limitaktualisierung (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
},
"displayable_reset_next_date": {
"description": "Datum und Uhrzeit, zu der die Limits zurückgesetzt werden sollen (ISO 8601).",
"type": "string",
"format": "date-time",
"example": "2023-02-28T11:00:00+08:00"
}
}
}
]
}
}
},
"admin-item-limit-response": {
"type": [
"object",
"null"
],
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Artikelbeschränkung für einen separaten Nutzer.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die ein einzelner Nutzer kaufen kann."
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Globale Artikelbeschränkung.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die alle Nutzer kaufen können."
},
"available": {
"type": "integer",
"description": "Verbleibende Anzahl von Artikeln, die alle Nutzer kaufen können."
},
"reserved": {
"type": "integer"
},
"sold": {
"type": "integer"
}
}
},
"recurrent_schedule": {
"$ref": "#/components/schemas/admin_recurrent_schedule_response"
}
}
},
"item-periods-response": {
"type": "array",
"description": "Artikelangebotszeitraum.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Datum, an dem der angegebene Artikel zum Verkauf angeboten wird."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Datum, an dem der angegebene Artikel nicht mehr zum Verkauf angeboten wird. Möglich ist: `null`."
}
}
}
},
"item-custom-attributes-response": {
"type": "object",
"description": "Ein JSON-Objekt mit Artikelattributen und ‑werten.",
"format": "json"
},
"Virtual-Items-Currency_admin-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"Virtual-Items-Currency_schemas-admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "Bild-URL. Damit das Bild im Zahlungsportal korrekt angezeigt und schnell geladen wird, beachten Sie bitte unsere Richtlinien für Bilder und URLs:- Unterstützte Formate: WebP (empfohlen), PNG, JPG.
- Dateigröße: ≤ 50 kB (für WebP) oder ≤ 150 kB (für PNG und JPG).
- Bildgröße: 280 x 280 px.
- Farbraum: sRGB.
- Protokoll: HTTPS mit langlebigem Caching für versionierte URLs.
"
},
"Virtual-Items-Currency_admin-groups-create": {
"type": "array",
"description": "Liste der [externen Gruppen-IDs](/de/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response), zu denen der Artikel gehört.\n\nBeispiel: [\"horror\", \"action\"]",
"items": {
"type": "string",
"properties": {
"external_id": {
"type": "string",
"example": "accessory"
},
"name": {
"type": "string",
"example": "Accessory"
}
}
}
},
"admin-post-put-attribute-item": {
"type": "object",
"required": [
"external_id",
"values"
],
"maxItems": 6,
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
},
"values": {
"type": "array",
"description": "Achtung: Sie können für jedes Attribut maximal 6 Werte erstellen. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.
",
"items": {
"$ref": "#/components/schemas/attribute-value"
},
"example": [
{
"external_id": "strategy",
"value": {
"en": "Strategy",
"de": "Strategie"
}
},
{
"external_id": "action",
"value": {
"en": "Action",
"de": "Aktion"
}
}
]
}
}
},
"Virtual-Items-Currency_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Liste der Attribute.\n\nAchtung: Sie können für den Artikel maximal 20 Attribute angeben. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Virtual-Items-Currency_admin-create-vc_prices": {
"description": "Array der Preisangaben in virtueller Währung.",
"type": [
"array",
"null"
],
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku"
},
"amount": {
"type": "integer",
"description": "Artikelpreis in virtueller Währung."
},
"is_default": {
"type": "boolean",
"default": false,
"description": "Ob es sich um den Standardpreis in virtueller Währung handelt."
},
"is_enabled": {
"type": "boolean",
"default": true,
"description": "Ob dieser Preis für die Anzeige im Katalog und für den Kauf des Artikels verwendet wird. Falls `false` festgelegt ist, wird der Preis nicht verwendet."
}
},
"required": [
"amount",
"sku",
"is_default",
"is_enabled"
],
"example": {
"sku": "com.xsolla.gold_1",
"amount": 10,
"is_default": true,
"is_enabled": true
}
}
},
"limit_per_user": {
"description": "Artikelbeschränkung für einen separaten Nutzer.",
"anyOf": [
{
"type": "null",
"description": "Kein nutzerspezifisches Limit für den Artikelkauf."
},
{
"type": "integer",
"description": "Höchstzahl von Artikeln, die ein einzelner Nutzer kaufen kann.",
"example": 5
},
{
"type": "object",
"description": "Detaillierte Konfiguration des Kauflimits.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die ein einzelner Nutzer kaufen kann.",
"example": 5
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
}
]
},
"limit_per_item": {
"type": [
"integer",
"null"
],
"description": "Globale Artikelbeschränkung.",
"example": 10
},
"per_user_daily": {
"type": "object",
"title": "interval_type = daily",
"description": "Tägliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Wiederkehrender Aktualisierungszeitraum.",
"enum": [
"daily"
]
},
"time": {
"type": "string",
"description": "Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "02:00:00+03:00"
}
},
"required": [
"interval_type",
"time"
]
},
"per_user_weekly": {
"type": "object",
"title": "interval_type = weekly",
"description": "Wöchentliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Wiederkehrender Aktualisierungszeitraum.",
"enum": [
"weekly"
]
},
"day_of_week": {
"type": "integer",
"description": "Wochentag, an dem die Limits aktualisiert werden. 1 seht für Montag, und 7 steht für Sonntag.",
"minimum": 1,
"maximum": 7
},
"time": {
"type": "string",
"description": "Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "11:00:00+03:00"
}
}
},
"per_user_monthly": {
"type": "object",
"title": "interval_type = monthly",
"description": "Monatliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Wiederkehrender Aktualisierungszeitraum.",
"enum": [
"monthly"
]
},
"day_of_month": {
"type": "integer",
"description": "Tag im Monat, an dem die Limits aktualisiert werden. Hat der Monat weniger Tage als der ausgewählte Tag, erfolgt die Aktualisierung am letzten Tag des Monats.",
"minimum": 1,
"maximum": 31
},
"time": {
"type": "string",
"description": "Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).",
"pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])",
"example": "23:00:00+03:00"
}
},
"required": [
"interval_type",
"time",
"day_of_month"
]
},
"interval_type_hourly": {
"type": "string",
"description": "Wiederkehrender Aktualisierungszeitraum.",
"enum": [
"hourly"
]
},
"hours_interval": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"per_user_hourly_vi": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Zeitintervall in Stunden, nach dessen Ablauf das Limit zurückgesetzt wird.
Der Countdown beginnt gemäß dem Parameter date_from.
Sind beispielsweise `date_start = \"2025-11-15T18:15:00+05:00\"` und `hours_interval = 2`angegeben, wird das Kauflimit für diesen Artikel alle zwei Stunden ab dem `\"2025-11-15T20:15:00+05:00\"` zurückgesetzt."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_item_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Aktualisierungszeitraum begrenzen.",
"properties": {
"per_user": {
"description": "Das Kauflimit wird gemäß dem in Stunden angegebenen Zeitintervall zurückgesetzt.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vi"
}
]
}
}
},
"Virtual-Item-item-limit": {
"type": "object",
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_item_recurrent_schedule"
}
}
},
"item-periods": {
"type": [
"array",
"null"
],
"description": "Artikelangebotszeitraum.",
"items": {
"type": "object",
"properties": {
"date_from": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Datum, an dem der angegebene Artikel zum Verkauf angeboten wird."
},
"date_until": {
"type": [
"string",
"null"
],
"format": "date-time",
"example": "2020-08-11T20:00:00+03:00",
"description": "Datum, an dem der angegebene Artikel nicht mehr zum Verkauf angeboten wird. Möglich ist: `null`."
}
}
}
},
"item-custom-attributes": {
"type": "object",
"description": "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.",
"format": "json",
"maxLength": 500
},
"Virtual-Items-Currency_admin-create-virtual-item": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Item-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Virtual-Items-Currency_admin-prices": {
"type": "array",
"items": {
"type": "object",
"required": [
"amount",
"currency"
],
"properties": {
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
},
"amount": {
"type": "number",
"exclusiveMinimum": 0,
"example": 10.5,
"description": "Artikelpreis in echter Währung."
},
"is_default": {
"type": "boolean",
"default": false,
"description": "Ob es sich um den Standardpreis in realer Währung handelt. Ausführliche Informationen zu den Preiseinstellungen finden Sie in unserer [Dokumentation](https://developers.xsolla.com/de/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination)."
},
"is_enabled": {
"type": "boolean",
"default": true,
"example": true,
"description": "Ob dieser Preis für die Anzeige im Katalog und für den Kauf des Artikels verwendet wird. Falls `false` festgelegt ist, wird der Preis nicht verwendet und stattdessen ein anderer Preis angewendet. Ausführliche Informationen zu den Preiseinstellungen finden Sie in unserer [Dokumentation](https://developers.xsolla.com/de/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination)."
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Land, in dem dieser Preis gilt. Code bestehend aus zwei Buchstaben gemäß [ISO 3166-1 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
},
"example": {
"currency": "USD",
"amount": 10.5,
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
}
}
},
"per_user_hourly_vc": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Zeitintervall in Stunden, nach dessen Ablauf das Limit zurückgesetzt wird.
Der Countdown beginnt gemäß dem Parameter date_from.
Sind beispielsweise `date_start = \"2025-11-15T18:15:00+05:00\"` und `hours_interval = 2`angegeben, wird das Kauflimit für diesen Artikel alle zwei Stunden ab dem `\"2025-11-15T20:15:00+05:00\"` zurückgesetzt."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Aktualisierungszeitraum begrenzen.",
"properties": {
"per_user": {
"description": "Das Kauflimit wird gemäß dem in Stunden angegebenen Zeitintervall zurückgesetzt.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vc"
}
]
}
}
},
"Virtual-Currency-item-limit": {
"type": "object",
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"type": "object",
"required": [
"sku",
"name"
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Virtual-Items-Currency_admin-virtual-currency-package": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"bundle_type": {
"type": "string",
"default": "virtual_currency_package",
"example": "virtual_currency_package"
},
"content": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"type": {
"$ref": "#/components/schemas/Virtual-Items-Currency_type"
},
"quantity": {
"type": "integer"
}
}
}
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"per_user_hourly_vcp": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Intervall in Stunden, nach dem das Limit zurückgesetzt wird.
Der Countdown beginnt gemäß dem Parameter date_from.
Sind beispielsweise `date_start = \"2025-11-15T18:15:00+05:00\"` und `hours_interval = 2`angegeben, wird das Kauflimit für diesen Artikel alle zwei Stunden ab dem `\"2025-11-15T20:15:00+05:00\"` zurückgesetzt."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"virtual_currency_package_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Aktualisierungszeitraum begrenzen.",
"properties": {
"per_user": {
"description": "Das Kauflimit wird gemäß dem in Stunden angegebenen Zeitintervall zurückgesetzt.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_vcp"
}
]
}
}
},
"Virtual-Currency-Package-item-limit": {
"type": "object",
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule"
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"type": "object",
"required": [
"sku",
"name",
"description",
"content"
],
"anyOf": [
{
"required": [
"prices"
]
},
{
"required": [
"vc_prices"
]
}
],
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url"
},
"media_list": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list"
},
"groups": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes"
},
"prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices"
},
"vc_prices": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices"
},
"is_enabled": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"order": {
"$ref": "#/components/schemas/Virtual-Items-Currency_order"
},
"content": {
"type": "array",
"minLength": 1,
"maxLength": 1,
"description": "Nur 1 Position des virtuellen Währungspakets sollte virtuelle Währung sein.",
"items": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Virtual-Items-Currency_sku"
},
"quantity": {
"type": "integer"
}
}
}
},
"regions": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/Virtual-Currency-Package-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
}
},
"Pagination_has-more": {
"type": "boolean",
"example": true,
"description": "Dient als Indikator dafür, dass weitere Seiten vorhanden sind."
},
"items_client_groups_response": {
"type": "array",
"example": [
{
"external_id": "exclusive",
"name": "Exclusive"
}
],
"default": [],
"description": "Gruppen, zu denen der Artikel gehört.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "Bei der Erstellung angegebene [Externe Artikelgruppen-ID](/de/api/catalog/item-groups-admin/admin-create-item-group#item-groups-admin/admin-create-item-group/t=request&path=external_id).",
"example": "exclusive"
},
"name": {
"type": "string",
"description": "Name der Gruppe.",
"example": "Exclusive"
},
"item_order_in_group": {
"type": "integer",
"description": "Die Position des Artikels innerhalb der Gruppe, die dazu dient, die Anzeigereihenfolge festzulegen.\nSie wird nur dann zurückgegeben, wenn sie über den Abfrageparameter `additional_fields[]` angefordert wird.",
"example": 1
}
}
}
},
"Virtual-Items-Currency_client-attributes": {
"type": "array",
"description": "Liste der Attribute und ihrer Werte, die dem Artikel zugeordnet sind. Kann für die Katalogfilterung verwendet werden.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "object",
"description": "Name des Attributs.",
"example": "Genre",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Wert des Attributs.",
"example": "Strategy"
}
}
}
}
}
}
},
"client_virtual_prices_response": {
"type": "array",
"description": "Virtuelle Preise.",
"items": {
"type": "object",
"description": "Virtueller Preis.",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Artikelpreis in virtueller Währung."
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "Der Artikelpreis in virtueller Währung ohne Rabatt. Immer gleich `amount`, da Rabatte nicht auf Preise in virtueller Währung angewendet werden."
},
"sku": {
"type": "string",
"example": "vc_gold",
"description": "SKU der virtuellen Währung."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Ob es sich um den Standardpreis in virtueller Währung handelt."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "http://image.png",
"description": "Bild-URL der virtuellen Währung."
},
"name": {
"type": "string",
"example": "Gold",
"description": "Name der virtuellen Währung."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Artikeltyp. Für die virtuelle Währung ist es `virtual_currency`."
},
"description": {
"type": [
"string",
"null"
],
"example": "In-game currency used to purchase weapons and upgrades",
"description": "Beschreibung der virtuellen Währung."
}
}
}
},
"Can_be_bought": {
"type": "boolean",
"example": true,
"description": "Sofern `true`, kann der Nutzer einen Artikel kaufen."
},
"Catalog_item_promotions": {
"type": "array",
"description": "Auf bestimmte Artikel im Warenkorb angewandte Werbeaktionen. Das array wird in den folgenden Fällen zurückgegeben:\n\n* Für einen bestimmten Artikel ist eine Rabattaktion konfiguriert.\n\n* Ein Promocode mit der Einstellung **Rabatt auf ausgewählte Artikel** ist angewandt.\n\nWerden keine Werbeaktionen auf Artikelebene angewandt, wird ein leeres Array zurückgegeben.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "Typ des Bonusartikels.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "Name des Bonusartikels. Nicht verfügbar für Bonusartikel vom Typ `physical_good`."
},
"image_url": {
"type": "string",
"description": "Bild-URL des Bonusartikels. Nicht verfügbar für Bonusartikel vom Typ `physical_good`."
},
"bundle_type": {
"type": "string",
"description": "Typ des im Bundle enthaltenen Bonusartikels. Nur verfügbar für Bonusartikel vom Typ `bundle`.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"catalog_recurrent_schedule_client_response": {
"type": [
"object",
"null"
],
"description": "Wiederkehrender Artikellimit-Aktualisierungszeitraums für einen Nutzer.",
"oneOf": [
{
"type": "object",
"title": "interval_type = daily",
"description": "Tägliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Typ des wiederkehrenden Aktualisierungszeitraums.",
"enum": [
"daily"
]
},
"reset_next_date": {
"type": "integer",
"description": "Datum und Uhrzeit, zu dem die Limits zurückgesetzt werden (Unix-Zeitstempel).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = weekly",
"description": "Wöchentliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Typ des wiederkehrenden Aktualisierungszeitraums.",
"enum": [
"weekly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Datum und Uhrzeit, zu dem die Limits zurückgesetzt werden (Unix-Zeitstempel).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = monthly",
"description": "Monatliche Aktualisierung der Nutzerlimits.",
"properties": {
"interval_type": {
"type": "string",
"description": "Typ des wiederkehrenden Aktualisierungszeitraums.",
"enum": [
"monthly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Datum und Uhrzeit, zu dem die Limits zurückgesetzt werden (Unix-Zeitstempel).",
"example": 1677553200
}
}
},
{
"type": "object",
"title": "interval_type = hourly",
"description": "Die Nutzerlimits werden gemäß dem in Stunden angegebenen Zeitintervall zurückgesetzt.",
"properties": {
"interval_type": {
"type": "string",
"description": "Typ des wiederkehrenden Aktualisierungszeitraums.",
"enum": [
"hourly"
]
},
"reset_next_date": {
"type": "integer",
"description": "Datum und Uhrzeit, zu dem die Limits zurückgesetzt werden (Unix-Zeitstempel).",
"example": 1677553200
}
}
}
]
},
"client-item-limit-response": {
"type": [
"object",
"null"
],
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Artikelbeschränkung für einen separaten Nutzer.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die ein einzelner Nutzer kaufen kann."
},
"available": {
"type": "integer",
"description": "Verbleibende Anzahl von Artikeln, die der aktuelle Nutzer kaufen kann."
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Globale Artikelbeschränkung.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die alle Nutzer kaufen können."
},
"available": {
"type": "integer",
"description": "Verbleibende Anzahl von Artikeln, die alle Nutzer kaufen können."
}
}
}
}
},
"item_id": {
"type": "integer",
"example": 1,
"description": "Interne eindeutige Artikel-ID."
},
"value-point-sku": {
"type": "string",
"description": "Eindeutige ID des Wertpunkts."
},
"value-point-amount": {
"type": "integer",
"description": "Anzahl der Wertpunkte."
},
"value-point-name": {
"type": "string",
"description": "Wertpunktname."
},
"Common_admin-image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "Bild-URL."
},
"is_clan": {
"type": "boolean",
"description": "Ob der Wertpunkt in Clan-Belohnungsketten verwendet wird.",
"example": true
},
"client-item-value-point-reward": {
"type": "array",
"description": "Liste Wertpunktbelohnungen für den Artikel.",
"items": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"sku": {
"$ref": "#/components/schemas/value-point-sku"
},
"amount": {
"$ref": "#/components/schemas/value-point-amount"
},
"name": {
"$ref": "#/components/schemas/value-point-name"
},
"image_url": {
"$ref": "#/components/schemas/Common_admin-image_url"
},
"is_clan": {
"$ref": "#/components/schemas/is_clan"
}
}
}
},
"Virtual-Items-Currency_item": {
"type": "object",
"properties": {
"item_id": {
"type": "number",
"description": "Artikel-ID."
},
"sku": {
"type": "string",
"example": "big_rocket",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "object",
"example": "Big Rocket",
"description": "Artikelname.",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "object",
"example": "Big Rocket - description",
"description": "Artikelbeschreibung.",
"additionalProperties": {
"type": [
"string",
"null"
]
}
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "Bild-URL."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Art des virtuellen Gegenstands.\n\nMögliche Werte:\n- `consumable` – ein Gegenstand, der nach dem Gebrauch aus dem Inventar verschwindet (z. B. Munition).\n- `non_consumable` – ein Gegenstand, der unbegrenzt lange im Inventar verbleibt.\n- `non_renewing_subscription` – ein zeitlich begrenzter Artikel, der den Zugang zu Services oder Inhalten für einen begrenzten Zeitraum gewährt.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/client-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_item-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Catalog_item_limits": {
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Artikelbeschränkungen für einen Nutzer.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die ein einzelner Nutzer kaufen kann.",
"example": 5
},
"available": {
"type": "integer",
"description": "Verbleibende Anzahl von Artikeln, die der aktuelle Nutzer kaufen kann.",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Artikelbeschränkungen für einen Artikel.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die alle Nutzer kaufen können.",
"example": 5
},
"available": {
"type": "integer",
"description": "Verbleibende Anzahl von Artikeln, die alle Nutzer kaufen können.",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"Virtual-Items-Currency_virtual-currency": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "Von Xsolla zugewiesene eindeutige Artikel-ID."
},
"sku": {
"type": "string",
"example": "crystal",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Crystals",
"description": "Artikelname."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "Bild-URL."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": [
"object",
"null"
],
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response",
"example": [
{
"amount": 100,
"sku": "com.xsolla.crystals_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png"
}
]
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_virtual-currency-list": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_virtual-currency-package": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "Von Xsolla zugewiesene eindeutige Artikel-ID."
},
"sku": {
"type": "string",
"example": "crystal-pack",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Crystal Pack",
"description": "Artikelname."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "bundle",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`."
},
"bundle_type": {
"type": "string",
"example": "virtual_currency_package",
"description": "Bundle-Typ. Immer `virtual_currency_package` für virtuelle Währungspakete."
},
"description": {
"type": "string",
"example": "Crystal Pack Description",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/items/crystal-pack.png",
"description": "Bild-URL."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Artikelpreis ohne Rabatt."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"type": "array",
"example": [
{
"description": "Crystal - short description",
"image_url": "https://cdn.xsolla.net/items/crystal-pack.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100
}
],
"description": "Inhalt des virtuellen Währungspakets.",
"items": {
"type": "object",
"description": "Virtuelle Währung in einem Paket.",
"properties": {
"item_id": {
"type": "integer",
"description": "Von Xsolla zugewiesene eindeutige Artikel-ID."
},
"sku": {
"type": "string",
"example": "com.xsolla.crystal_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Crystals",
"description": "Artikelname."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Artikeltyp. Für die virtuelle Währung ist es `virtual_currency`."
},
"description": {
"type": "string",
"example": "Crystals - description",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/items/crystal-pack.png",
"description": "Bild-URL."
},
"quantity": {
"type": "integer",
"example": 250,
"description": "Menge der virtuellen Währung im Paket."
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"Virtual-Items-Currency_virtual-currency-packages": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"group-name-localization-object": {
"type": [
"object",
"null"
],
"description": "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](/de/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"group-description-localization-object": {
"type": [
"object",
"null"
],
"description": "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](/de/doc/shop-builder/references/supported-languages/).",
"anyOf": [
{
"$ref": "#/components/schemas/two-letter-locale"
},
{
"$ref": "#/components/schemas/five-letter-locale"
}
]
},
"group-image-url": {
"type": [
"string",
"null"
],
"description": "URL des Bildes der Artikelgruppe.",
"example": "https://example.com/weapons.png"
},
"group-display-order": {
"type": "integer",
"description": "Reihenfolge, in der die Artikelgruppe im Katalog angezeigt wird. Je höher der Wert, desto weiter unten erscheint die Gruppe in der Liste. Bei gleichen Werten werden die Gruppen nach Erstellungsdatum sortiert, wobei neuere Gruppen weiter oben angezeigt werden.",
"default": 1,
"example": 1
},
"group-is-enabled": {
"type": "boolean",
"description": "Ob die Artikelgruppe im Katalog aktiviert ist.",
"example": true,
"default": true
},
"admin-group-response-base": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Von Xsolla zugewiesene Artikelgruppen-ID.",
"example": 1
},
"external_id": {
"type": "string",
"description": "Bei der Erstellung angegebene externe Artikelgruppen-ID.",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/group-image-url"
},
"order": {
"$ref": "#/components/schemas/group-display-order"
},
"is_enabled": {
"$ref": "#/components/schemas/group-is-enabled"
},
"items_count": {
"type": "integer",
"description": "Gesamtzahl der Artikel in der Gruppe.",
"example": 5
}
},
"required": [
"id",
"external_id",
"name",
"is_enabled"
]
},
"error-response-base": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-Antwortstatus."
},
"errorCode": {
"type": "integer",
"description": "Fehlercode."
},
"errorMessage": {
"type": "string",
"description": "Kurze Fehlerbeschreibung."
},
"transactionId": {
"type": "string",
"description": "Anfrage-ID. Die ID, die zum Tracking und zur Zuordnung von Protokolleinträgen im Zusammenhang mit dieser bestimmten Anfrage oder diesem Vorgang verwendet wird. Die ID ist hilfreich bei der Fehlersuche, der Fehlerbehebung und zu Auditzwecken."
}
}
},
"admin-group-create-request": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "Externe ID der Artikelgruppe. Darf nur alphanumerische Zeichen, Bindestriche und Unterstriche enthalten.",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
],
"default": true
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "Artikelgruppendaten.",
"required": [
"external_id",
"name"
]
},
"error-message-extended-validation": {
"type": "array",
"description": "Details zu Validierungsfehlern. Enthält ein Array mit Fehlern auf Property-Ebene, in denen beschrieben ist, bei welchen Feldern die Validierung fehlgeschlagen ist und aus welchem Grund.",
"items": {
"type": "object",
"properties": {
"property": {
"type": "string",
"description": "Name des Feldes, bei dem die Validierung fehlgeschlagen ist.",
"example": "external_id"
},
"message": {
"type": "string",
"description": "Validierungsfehlermeldung für das Feld.",
"example": "The property external_id is required"
}
}
}
},
"ItemGroup_422-invalid-request": {
"type": "object",
"required": [
"statusCode",
"errorCode",
"errorMessage",
"transactionId"
],
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-Antwortstatus.",
"example": 422
},
"errorCode": {
"type": "integer",
"description": "Fehlercode.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Kurze Fehlerbeschreibung.",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"description": "Anfrage-ID. Die ID, die zum Tracking und zur Zuordnung von Protokolleinträgen im Zusammenhang mit dieser bestimmten Anfrage oder diesem Vorgang verwendet wird. Die ID ist hilfreich bei der Fehlersuche, der Fehlerbehebung und zu Auditzwecken.",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
}
}
},
"admin-group-update-request": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/group-name-localization-object"
},
"description": {
"$ref": "#/components/schemas/group-description-localization-object"
},
"external_id": {
"type": "string",
"description": "Eindeutige externe Gruppen-ID. Darf nur alphanumerische Zeichen, Bindestriche und Unterstriche enthalten. Dient dazu, die externe ID der Gruppe umzubenennen.",
"pattern": "^[A-Za-z0-9_\\-]+$",
"example": "weapons"
},
"iconUrl": {
"$ref": "#/components/schemas/group-image-url"
},
"isEnabled": {
"allOf": [
{
"$ref": "#/components/schemas/group-is-enabled"
}
]
},
"order": {
"allOf": [
{
"$ref": "#/components/schemas/group-display-order"
}
]
}
},
"description": "Zu aktualisierende Artikelgruppendaten. Die Felder `external_id` and `name` sind in jeder Anfrage auszufüllen – es handelt sich um Pflichtfelder. Die übrigen Felder sind optional – ausgelassene Felder behalten ihre aktuellen Werte bei.",
"required": [
"external_id",
"name"
]
},
"group-is-contains-any-items": {
"type": "boolean",
"description": "Ob die Gruppe Artikel enthält, unabhängig vom angegebenen `item_type`. Eine Gruppe kann für den angegebenen Typ den Wert `items_count: 0` haben, während der Parameter `is_contains_any_items` den Wert `true` annimmt, wenn die Gruppe Artikel anderer Typen enthält.",
"example": true
},
"admin-group-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"admin-group-detail-response-by-item-type": {
"allOf": [
{
"$ref": "#/components/schemas/admin-group-response-base"
},
{
"type": "object",
"properties": {
"is_contains_any_items": {
"$ref": "#/components/schemas/group-is-contains-any-items"
}
}
}
]
},
"item-in-group-order-request-item": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"description": "Von Xsolla zugewiesene interne Artikel-ID. Verwenden Sie die Artikel-ID, die in den Antworten auf den [API-Aufruf für den Artikelkatalog](/de/api/catalog/common-catalog) zurückgegeben wird.",
"minimum": 0,
"example": 101
},
"order": {
"type": "integer",
"description": "Wert für die neue Anzeigereihenfolge.",
"minimum": 0,
"example": 1
}
},
"required": [
"item_id",
"order"
],
"additionalProperties": false
},
"Cart-Payment_custom_parameters": {
"description": "Ihre benutzerdefinierten Parameter werden in Form eines gültigen JSON-Satz von Schlüssel-Wert-Paaren dargestellt.
\nSie können über dieses Feld zusätzliche Parameter übermitteln und so Betrugsschutzfilter konfigurieren. [Siehe Bezahlstation-Dokumentation](https://developers.xsolla.com/de/doc/pay-station/features/antifraud/).",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array"
},
{
"type": "object"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"null_param": null
}
}
},
"Game-Keys_schemas-client-attributes": {
"type": "array",
"description": "Liste der Attribute und ihrer Werte, die dem Artikel zugeordnet sind. Kann für die Katalogfilterung verwendet werden.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Name des Attributs.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Wert des Attributs.",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_admin-attributes": {
"type": "array",
"description": "Liste der Attribute.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Game-Keys_regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"example": 1
}
}
}
},
"Game-Keys_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Liste der Attribute.\n\nAchtung: Sie können für den Artikel maximal 20 Attribute angeben. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"game_key_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Aktualisierungszeitraum begrenzen.",
"properties": {
"per_user": {
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
}
]
}
}
},
"Game-key-item-limit": {
"type": "object",
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/game_key_recurrent_schedule"
}
}
},
"Game-Keys_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"Pagination_total-items-count": {
"type": "integer",
"example": 10,
"description": "Gesamtzahl der Artikel im System."
},
"Game-Keys_client_name": {
"type": "string",
"example": "The Greatest Game in the World",
"description": "Name des Spielpakets."
},
"Game-Keys_description": {
"type": "string",
"example": "Description of the greatest game in the world.",
"description": "Beschreibung des Spielpakets."
},
"Game-Keys_project_id": {
"type": "integer",
"example": 44056,
"description": "Projekt-ID. Dieser Parameter wird im [Kundenportal](https://publisher.xsolla.com/) neben dem Projektnamen angezeigt."
},
"Game-Keys_game_sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "theGreatestGameSku",
"description": "Eindeutige Schlüsselpaket-ID."
},
"Game-Keys_drm_sku": {
"type": "string",
"example": "steam",
"description": "Eindeutige DRM-ID.",
"enum": [
"steam",
"playstation",
"xbox",
"uplay",
"origin",
"drmfree",
"gog",
"epicgames",
"nintendo_eshop",
"discord_game_store",
"oculus",
"rockstar",
"viveport",
"stadia"
]
},
"Game-Keys_image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "Bild-URL. Damit das Bild im Zahlungsportal korrekt angezeigt und schnell geladen wird, beachten Sie bitte unsere Richtlinien für Bilder und URLs:- Unterstützte Formate: WebP (empfohlen), PNG, JPG.
- Dateigröße: ≤ 50 kB (für WebP) oder ≤ 150 kB (für PNG und JPG).
- Bildgröße: 280 x 280 px.
- Farbraum: sRGB.
- Protokoll: HTTPS mit langlebigem Caching für versionierte URLs.
"
},
"Game-Keys_admin-attribute-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9-_]+$",
"example": "attribute_1",
"description": "Eindeutige Attribut-ID. Die `external_id` darf nur lateinische Klein- und Großbuchstaben, Ziffern, Bindestriche und Unterstriche enthalten."
},
"Game-Keys_value-external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[-_.\\d\\w]+$",
"example": "attribute_value",
"description": "Eindeutige Wert-ID für ein Attribut. Die `external_id` darf nur lateinische Kleinbuchstaben, alphanumerische Zeichen, Binde- und Unterstriche enthalten."
},
"Game-Keys_client-attributes": {
"type": "array",
"description": "Liste der Attribute und ihrer Werte, die dem Spiel zugeordnet sind.\n\nAchtung: Dieser Teil der Antwort ist nur verfügbar, wenn Sie den Abfrageparameter `additional_fields[]=attributes` senden.
",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Name des Attributs.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/Game-Keys_value-external_id"
},
"value": {
"type": "string",
"description": "Wert des Attributs.",
"example": "Strategy"
}
}
}
}
}
}
},
"Game-Keys_entitlement_item": {
"type": "object",
"properties": {
"name": {
"$ref": "#/components/schemas/Game-Keys_client_name"
},
"description": {
"$ref": "#/components/schemas/Game-Keys_description"
},
"project_id": {
"$ref": "#/components/schemas/Game-Keys_project_id"
},
"game_sku": {
"$ref": "#/components/schemas/Game-Keys_game_sku"
},
"drm": {
"$ref": "#/components/schemas/Game-Keys_drm_sku"
},
"image_url": {
"$ref": "#/components/schemas/Game-Keys_image_url"
},
"is_pre_order": {
"type": "boolean",
"example": false,
"description": "Ob das Spiel vorbestellt werden kann oder nicht."
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_client-attributes"
}
}
},
"Bundles_item_id": {
"type": "integer",
"example": 1,
"minLength": 1,
"maxLength": 255,
"description": "Interne eindeutige Artikel-ID."
},
"Bundles_sku": {
"type": "string",
"example": "bundle_1",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"Bundles_admin-attributes": {
"type": "array",
"description": "Liste der Attribute.",
"items": {
"$ref": "#/components/schemas/attribute"
}
},
"Bundles_type": {
"type": "string",
"example": "bundle",
"description": "Artikeltyp."
},
"bundle_type": {
"type": "string",
"description": "Bundle-Typ. Wird zurückgegeben, wenn der Artikeltyp ein Bundle ist.",
"enum": [
"standard",
"virtual_currency_package",
"partner_side_content"
]
},
"Bundles_image_url": {
"type": [
"string",
"null"
],
"example": "https://image.example.com",
"description": "Bild-URL. Damit das Bild im Zahlungsportal korrekt angezeigt und schnell geladen wird, beachten Sie bitte unsere Richtlinien für Bilder und URLs:- Unterstützte Formate: WebP (empfohlen), PNG, JPG.
- Dateigröße: ≤ 50 kB (für WebP) oder ≤ 150 kB (für PNG und JPG).
- Bildgröße: 280 x 280 px.
- Farbraum: sRGB.
- Protokoll: HTTPS mit langlebigem Caching für versionierte URLs.
"
},
"Bundles_groups_response": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"default": [],
"description": "Gruppen, zu denen der Artikel gehört.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"description": "Name des Artikels. Sollte Schlüssel-Wert-Paare enthalten,\nwobei der Schlüssel ein Gebietsschema im Format \"^[a–z]{2}\" und der Wert ein String ist.",
"example": {
"en": "Horror",
"de": "Horror"
},
"default": {
"en": "Horror"
},
"additionalProperties": {
"type": "string"
}
}
}
}
},
"Bundles_amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Artikelpreis.",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"Bundles_prices": {
"type": "array",
"description": "Preise in echten Währungen.",
"items": {
"type": "object",
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
},
"is_default": {
"type": "boolean",
"description": "Der Standardpreis dient dazu, einen Katalog zu erstellen, wenn kein Preis in der Währung des Nutzers angegeben ist."
},
"is_enabled": {
"type": "boolean",
"description": "Der Preis ist aktiviert."
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Land, in dem dieser Preis gilt. Code bestehend aus zwei Buchstaben gemäß [ISO 3166-1 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_vc-type": {
"type": "string",
"example": "virtual_currency",
"description": "Art der virtuellen Währung."
},
"Bundles_amount": {
"type": "string",
"example": "100.99",
"description": "Artikelpreis mit Rabatt.",
"pattern": "^\\d*\\.?\\d*$"
},
"Bundles_currency-is_default": {
"type": "boolean",
"example": true,
"description": "Ob es sich bei dem Preis um einen Standardpreis für einen Artikel handelt."
},
"Bundles_admin-response-virtual_price": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_vc-type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"is_default": {
"$ref": "#/components/schemas/Bundles_currency-is_default"
}
}
},
"Bundles_media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Zusätzliche Medieninhalte des Bundles.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Medieninhaltstyp: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Ressourcendatei."
}
}
}
},
"Bundles_order": {
"type": "integer",
"example": 1,
"default": 1,
"description": "Priorität der Bundle-Reihenfolge in der Liste."
},
"Bundles_is_enabled": {
"type": "boolean",
"example": true,
"default": true,
"description": "Ist diese Option deaktiviert, kann der Artikel weder gefunden noch gekauft werden."
},
"Bundles_is_show_in_store": {
"type": "boolean",
"example": true,
"default": false,
"description": "Artikel ist käuflich erhältlich."
},
"Bundles_admin-regions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1,
"example": 1
}
}
}
},
"Bundles_admin_content_response": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"quantity": {
"type": "integer",
"description": "Menge des Artikeltyps im Bundle.",
"default": 1,
"minimum": 1
}
}
},
"Bundles_total_content_price": {
"type": [
"object",
"null"
],
"description": "Preissumme der einzelnen Bundle-Inhalte.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Rabattierte Preissumme der einzelnen Bundle-Inhalte."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Preissumme der einzelnen Bundle-Inhalte."
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Bundles_admin_bundle_response": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/bundle_type"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"virtual_prices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin-response-virtual_price"
}
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"content": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_content_response"
}
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
}
},
"description": "Das angegebene Bundle."
},
"Bundles_groups_request": {
"type": "array",
"example": [
"honor"
],
"default": [],
"description": "Gruppen, zu denen der Artikel gehört.\n\nHinweis: Der String-Wert bezieht sich auf die Gruppe `external_id`.
",
"items": {
"type": "string"
}
},
"Bundles_admin-post-put-attributes": {
"type": "array",
"maxItems": 20,
"description": "Liste der Attribute.\n\nAchtung: Sie können für den Artikel maximal 20 Attribute angeben. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.
",
"items": {
"$ref": "#/components/schemas/admin-post-put-attribute-item"
}
},
"Bundles_vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"amount": {
"type": "integer"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"Bundles_bundle_type": {
"type": "string",
"example": "standard",
"enum": [
"standard",
"partner_side_content"
],
"description": "Bundle-Typ. Durch Angabe von `standard` erstellen Sie ein Bundle mit Artikeln, wobei die SKUs der im Bundle enthaltenen Artikel anzugeben ist.\nDurch Angabe von `partner_side_content` wird ein leeres Bundle erstellt, wobei die Artikel über einen [Webhook](https://developers.xsolla.com/de/webhooks/operation/personalized-partner-catalog/) hinzuzufügen sind. Dieser Typ wird nur für die [Katalogpersonalisierung aufseiten des Partners](https://developers.xsolla.com/de/doc/shop-builder/features/personalization/#guides_personalization_on_partner_side) verwendet.",
"default": "standard"
},
"Bundles_admin_content_request": {
"type": "array",
"minItems": 1,
"description": "Array der im Bundle enthaltenen Artikel. Jeder umfasst eine Artikelnummer (SKU) und die zugehörige Artikelmenge. Alle Artikel müssen zuvor in Ihrem Projekt erstellt worden sein. Das System gibt eine Fehlermeldung aus, wenn die angegebene SKU nicht existiert.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"example": "com.xsolla.kg_1",
"description": "SKU eines Artikels, der in das Bundle aufgenommen werden soll. Der Artikel muss zuvor in Ihrem Projekt erstellt worden sein. Das System gibt eine Fehlermeldung aus, wenn die angegebene SKU nicht existiert. Zulässige Zeichen: a–z, A–Z, 0–9, Punkt (.), Bindestrich (-), Unterstrich (_)."
},
"quantity": {
"type": "integer",
"description": "Menge der ausgewählten Artikel im Bundle.",
"default": 1,
"minimum": 1
}
},
"required": [
"sku"
],
"example": {
"sku": "com.xsolla.kg_1",
"quantity": 1
}
}
},
"per_user_hourly_bundle": {
"type": "object",
"title": "interval_type = hourly",
"properties": {
"interval_type": {
"$ref": "#/components/schemas/interval_type_hourly"
},
"hours_interval": {
"allOf": [
{
"$ref": "#/components/schemas/hours_interval"
},
{
"description": "Zeitintervall in Stunden, nach dessen Ablauf das Limit zurückgesetzt wird.
Der Countdown beginnt gemäß dem Parameter date_from.
Sind beispielsweise `date_start = \"2025-11-15T18:15:00+05:00\"` und `hours_interval = 2`angegeben, wird das Kauflimit für diesen Artikel alle zwei Stunden ab dem `\"2025-11-15T20:15:00+05:00\"` zurückgesetzt."
}
]
}
},
"required": [
"interval_type",
"hours_interval"
]
},
"bundle_recurrent_schedule": {
"type": [
"object",
"null"
],
"description": "Aktualisierungszeitraum begrenzen.",
"properties": {
"per_user": {
"description": "Das Kauflimit wird gemäß dem in Stunden angegebenen Zeitintervall zurückgesetzt.",
"oneOf": [
{
"$ref": "#/components/schemas/per_user_daily"
},
{
"$ref": "#/components/schemas/per_user_weekly"
},
{
"$ref": "#/components/schemas/per_user_monthly"
},
{
"$ref": "#/components/schemas/per_user_hourly_bundle"
}
]
}
}
},
"bundle-item-limit": {
"type": "object",
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"$ref": "#/components/schemas/limit_per_user"
},
"per_item": {
"$ref": "#/components/schemas/limit_per_item"
},
"recurrent_schedule": {
"$ref": "#/components/schemas/bundle_recurrent_schedule"
}
}
},
"Bundles_admin_bundle_request": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_request"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_admin-post-put-attributes"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"prices": {
"$ref": "#/components/schemas/Bundles_prices"
},
"vc_prices": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_vc_prices"
},
{
"type": "null"
}
]
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"content": {
"$ref": "#/components/schemas/Bundles_admin_content_request"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_paid_randomized_reward": {
"$ref": "#/components/schemas/value-is_paid_randomized_reward"
},
"is_enabled": {
"$ref": "#/components/schemas/Bundles_is_enabled"
},
"is_show_in_store": {
"$ref": "#/components/schemas/Bundles_is_show_in_store"
},
"media_list": {
"anyOf": [
{
"$ref": "#/components/schemas/Bundles_media_list"
},
{
"type": "null"
}
]
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"regions": {
"$ref": "#/components/schemas/Bundles_admin-regions"
},
"limits": {
"$ref": "#/components/schemas/bundle-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes"
}
},
"description": "Das angegebene Bundle.",
"required": [
"sku",
"name",
"description"
]
},
"Bundles_422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
},
"errorMessageExtended": {
"type": "array"
}
}
},
"Bundles_client_name": {
"type": "string",
"example": "Big Rocket",
"description": "Artikelname."
},
"Bundles_client_description": {
"type": [
"string",
"null"
],
"example": "Big Rocket - description.",
"description": "Artikelbeschreibung."
},
"Bundles_client-attributes": {
"type": "array",
"description": "Liste der Attribute und ihrer Werte, die dem Artikel zugeordnet sind. Kann für die Katalogfilterung verwendet werden.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Name des Attributs.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Wert des Attributs.",
"example": "Strategy"
}
}
}
}
}
}
},
"Bundles_price": {
"type": [
"object",
"null"
],
"description": "Artikelpreis.",
"required": [
"amount",
"amount_without_discount",
"currency"
],
"properties": {
"amount": {
"$ref": "#/components/schemas/Bundles_amount"
},
"amount_without_discount": {
"$ref": "#/components/schemas/Bundles_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Bundles_currency"
}
}
},
"Catalog_item_limits_with_hourly": {
"description": "Artikelbeschränkungen.",
"properties": {
"per_user": {
"type": [
"object",
"null"
],
"description": "Artikelbeschränkungen für einen Nutzer.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die ein einzelner Nutzer kaufen kann.",
"example": 5
},
"available": {
"type": "integer",
"description": "Verbleibende Anzahl von Artikeln, die der aktuelle Nutzer kaufen kann.",
"example": 3
},
"recurrent_schedule": {
"$ref": "#/components/schemas/catalog_recurrent_schedule_client_response"
},
"limit_exceeded_visibility": {
"$ref": "#/components/schemas/limit_exceeded_visibility"
}
}
},
"per_item": {
"type": [
"object",
"null"
],
"description": "Artikelbeschränkungen für einen Artikel.",
"properties": {
"total": {
"type": "integer",
"description": "Höchstzahl von Artikeln, die alle Nutzer kaufen können.",
"example": 5
},
"available": {
"type": "integer",
"description": "Verbleibende Anzahl von Artikeln, die alle Nutzer kaufen können.",
"example": 3
}
}
}
},
"type": [
"object",
"null"
]
},
"Bundles_client_content": {
"type": "array",
"example": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
}
}
],
"description": "Bundle-/Paketinhalt.",
"items": {
"type": "object",
"description": "Artikel in einem Paket.",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Artikelname."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`."
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "Bild-URL."
},
"quantity": {
"type": "integer",
"example": 250,
"description": "Artikelmenge in einem Paket."
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Art des virtuellen Gegenstands.\n\nMögliche Werte:\n- `consumable` – ein Gegenstand, der nach dem Gebrauch aus dem Inventar verschwindet (z. B. Munition).\n- `non_consumable` – ein Gegenstand, der unbegrenzt lange im Inventar verbleibt.\n- `non_renewing_subscription` – ein zeitlich begrenzter Artikel, der den Zugang zu Services oder Inhalten für einen begrenzten Zeitraum gewährt.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"price": {
"type": [
"object",
"null"
],
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Artikelpreis mit Rabatt."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"groups": {
"$ref": "#/components/schemas/Bundles_groups_response"
}
}
}
},
"Bundles_client_bundle": {
"type": "object",
"properties": {
"item_id": {
"$ref": "#/components/schemas/Bundles_item_id"
},
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
},
"name": {
"$ref": "#/components/schemas/Bundles_client_name"
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"description": {
"$ref": "#/components/schemas/Bundles_client_description"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Bundles_client-attributes"
},
"type": {
"$ref": "#/components/schemas/Bundles_type"
},
"bundle_type": {
"$ref": "#/components/schemas/Bundles_bundle_type"
},
"image_url": {
"$ref": "#/components/schemas/Bundles_image_url"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"$ref": "#/components/schemas/Bundles_price"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"content": {
"$ref": "#/components/schemas/Bundles_client_content"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits_with_hourly"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"order": {
"$ref": "#/components/schemas/Bundles_order"
},
"media_list": {
"$ref": "#/components/schemas/Bundles_media_list"
}
},
"description": "Das angegebene Bundle."
},
"value-cart_is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Ist `true` eingestellt, ist der Warenkorb kostenlos."
},
"Cart-Payment_client-attributes": {
"type": "array",
"description": "Liste der Attribute und ihrer Werte, die dem Artikel zugeordnet sind. Kann für die Katalogfilterung verwendet werden.",
"example": {
"value": {
"external_id": "genre",
"name": "Жанр",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
},
"default": [],
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"type": "string",
"description": "Name des Attributs.",
"example": "Genre"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"type": "string",
"description": "Wert des Attributs.",
"example": "Strategy"
}
}
}
}
}
}
},
"Catalog_cart_promotions": {
"type": "array",
"description": "Auf den gesamten Warenkorb angewandte Werbeaktionen. Das Array wird in den folgenden Fällen zurückgegeben:\n\n* Eine Werbeaktion wirkt sich auf den Warenkorb-Gesamtbetrag aus, z. B. ein Promocode mit der Einstellung **Rabatt auf den Kauf**.\n\n* Im Rahmen einer Werbeaktion werden Bonusartikel in den Warenkorb gelegt.\n\nWerden keine Werbeaktionen auf Bestellebene angewandt, wird ein leeres Array zurückgegeben.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"date_start": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"date_end": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"discount": {
"type": [
"object",
"null"
],
"properties": {
"percent": {
"type": [
"string",
"null"
]
},
"value": {
"type": [
"string",
"null"
]
}
}
},
"bonus": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"type": "string",
"description": "Typ des Bonusartikels.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"physical_good",
"game_key",
"nft"
]
},
"name": {
"type": "string",
"description": "Name des Bonusartikels. Nicht verfügbar für Bonusartikel vom Typ `physical_good`."
},
"image_url": {
"type": "string",
"description": "Bild-URL des Bonusartikels. Nicht verfügbar für Bonusartikel vom Typ `physical_good`."
},
"bundle_type": {
"type": "string",
"description": "Typ des im Bundle enthaltenen Bonusartikels. Nur verfügbar für Bonusartikel vom Typ `bundle`.",
"enum": [
"standard",
"virtual_currency_package"
]
}
}
}
},
"limits": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"available": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
}
}
}
}
}
},
"Cart-Payment_settings_ui": {
"description": "Benutzeroberflächeneinstellungen.",
"type": "object",
"additionalProperties": false,
"properties": {
"theme": {
"description": "Zahlungsportal-Theme. Möglich sind \"63295a9a2e47fab76f7708e1\" (helles Theme – voreingestellt) oder \"63295aab2e47fab76f7708e3\" (dunkles Theme). Sie können außerdem ein [individuelles Theme erstellen](https://developers.xsolla.com/de/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token) und dessen ID im Parameter übermitteln.",
"type": "string",
"default": "63295a9a2e47fab76f7708e1",
"enum": [
"63295a9a2e47fab76f7708e1",
"63295aab2e47fab76f7708e3"
]
},
"desktop": {
"type": "object",
"additionalProperties": false,
"description": "Benutzeroberflächeneinstellungen für die Desktopversion.",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"description": "Header-Einstellungen.",
"properties": {
"is_visible": {
"type": "boolean",
"description": "Ob der Header im Zahlungsportal angezeigt wird."
},
"visible_logo": {
"type": "boolean",
"description": "Wenn `true` wird das Logo im Header angezeigt. Um das Bild hochzuladen, öffnen Sie Ihr Projekt im [Kundenportal](https://publisher.xsolla.com/), und navigieren Sie zu Pay Station > Einstellungen."
},
"visible_name": {
"type": "boolean",
"description": "Ob der Projektname im Header angezeigt wird."
},
"visible_purchase": {
"type": "boolean",
"description": "Ob die Kaufbeschreibung (`purchase.description.value`) im Header angezeigt wird. `true` ist voreingestellt.",
"default": true
},
"type": {
"type": "string",
"description": "Wie der Header angezeigt wird. Möglich sind `compact` (Projektname und Benutzer-ID sind ausgeblendet) oder `normal` (Standard).",
"default": "normal",
"enum": [
"compact",
"normal"
]
},
"close_button": {
"type": "boolean",
"description": "Ob in der Desktop-Version des Zahlungsportals eine **Schließen**-Schaltfläche angezeigt werden soll. Die Schaltfläche schließt das Zahlungsportal und leitet den Nutzer zu der im Parameter `settings.return_url` angegebenen URL weiter. Standardmäßig ist `false` voreingestellt.",
"default": false
}
}
}
}
},
"mode": {
"type": "string",
"enum": [
"user_account"
],
"description": "Benutzeroberflächen-Modus im Zahlungsportal. Nur `user_account` ist möglich. Der Header enthält nur das Navigationsmenü, und der Nutzer kann kein Produkt auswählen oder eine Zahlung vornehmen. Dieser Modus ist nur für die Desktop-Version verfügbar."
},
"user_account": {
"type": "object",
"additionalProperties": false,
"description": "Benutzerkontodetails.",
"properties": {
"payment_accounts": {
"type": "object",
"additionalProperties": false,
"description": "Untermenü **Meine Zahlungskonten**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Ob das Untermenü angezeigt wird. `false` ist voreingestellt."
}
},
"required": [
"enable"
]
},
"info": {
"type": "object",
"additionalProperties": false,
"description": "Seite **Mein Konto**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Ob das Untermenü angezeigt wird. `false` ist voreingestellt."
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Position des Untermenüs im Hauptmenü."
}
},
"required": [
"enable",
"order"
]
},
"subscriptions": {
"type": "object",
"additionalProperties": false,
"description": "Untermenü **Abonnements verwalten**.",
"properties": {
"enable": {
"type": "boolean",
"default": false,
"description": "Ob das Untermenü angezeigt wird. `false` ist voreingestellt."
},
"order": {
"type": "integer",
"minimum": 1,
"description": "Position des Untermenüs im Hauptmenü."
}
},
"required": [
"enable",
"order"
]
}
}
},
"header": {
"type": "object",
"properties": {
"visible_virtual_currency_balance": {
"type": "boolean",
"additionalProperties": false,
"description": "Ob dieses Element im Zahlungsportal ausgeblendet werden kann oder nicht.",
"default": true
}
}
},
"mobile": {
"type": "object",
"properties": {
"header": {
"type": "object",
"additionalProperties": false,
"properties": {
"close_button": {
"type": "boolean",
"description": "Ob in der mobilgeräteoptimierten Version des Zahlungsportals eine **Schließen**-Schaltfläche angezeigt werden soll. Die Schaltfläche schließt das Zahlungsportal und leitet den Nutzer zu der im Parameter `settings.return_url` angegebenen URL weiter.",
"default": false
}
}
}
}
},
"is_prevent_external_link_open": {
"type": "boolean",
"description": "Ob die Weiterleitung per Link zu einer externen Ressource deaktiviert ist oder nicht. Wenn Sie auf einen externen Link klicken, wird das Ereignis `external-link-open` über den `postMessage`-Mechanismus gesendet. Die Adresse für den Weiterleitungs-Link wird im Parameter `url` übermittelt.",
"default": false
},
"is_payment_methods_list_mode": {
"type": "boolean",
"description": "Ob die Liste der im Land des Nutzers verfügbaren Zahlungsmethoden beim Öffnen des Zahlungsportals angezeigt wird. Ist `false` festgelegt (Standard), wird die im Parameter `settings.payment_method` übermittelte Zahlungsmethode oder die vom [PayRank-Algorithmus](https://developers.xsolla.com/de/solutions/payments/payment-ui-management/top-payment-methods-management/) ausgewählte Zahlungsmethode angezeigt.",
"default": false
},
"is_independent_windows": {
"type": "boolean",
"description": "Ob Nutzer zum Bezahlen vom im Launcher eingebetteten Browser (WebView) zu ihrem Standardbrowser weitergeleitet werden sollen.",
"default": false
},
"currency_format": {
"type": "string",
"description": "Damit ein Währungscode bestehend aus drei Buchstaben gemäß [ISO 4217](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/) im Zahlungsportal angezeigt wird, müssen Sie `code` als Wert festlegen. Standardmäßig wird das Währungssymbol anstelle des Währungscodes angezeigt."
},
"is_show_close_widget_warning": {
"type": "boolean",
"description": "Ob während der Transaktionsverarbeitung eine Warnmeldung angezeigt werden soll, wenn der Mauszeiger über das Schließen-Symbol (**×**) bewegt wird. Wird `false` oder kein Parameter übermittelt, wird die Warnmeldung nicht angezeigt.",
"default": true
},
"layout": {
"type": "string",
"description": "Position der Hauptelemente des Zahlungsportals. Sie können das Zahlungsportal im Spiel öffnen und/oder die Spalte mit den Bestellinformationen und den Angaben zu den Zahlungsmethoden vertauschen. Ausführliche Informationen finden Sie in den [Anpassungsanweisungen](https://developers.xsolla.com/de/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout).",
"enum": [
"embed",
"column_reverse",
"embed_column_reverse"
]
},
"is_three_ds_independent_windows": {
"type": "boolean",
"description": "Ob die \"3-D Secure\"-Prüfung in einem neuen Browserfenster geöffnet wird. Legen Sie `true` fest, wenn Ihr Setup eine Content Security Policy (CSP) vorschreibt.",
"default": false
},
"is_cart_open_by_default": {
"type": "boolean",
"description": "Wie die Artikelliste im Warenkorb beim Öffnen der mobilen Zahlungsportal-Version angezeigt wird. Wenn `true` festgelegt ist, wird die Liste ausgeklappt angezeigt. Wenn `false` (Standard) festgelegt ist oder der Parameter nicht übermittelt wird, wird die Liste zusammengeklappt angezeigt.",
"default": false
}
}
},
"Cart-Payment_settings_payment_method": {
"type": "integer",
"description": "Zahlungsmethoden-ID. Die ID steuert die Anzeige der Währung im Zahlungsportal, da einige Zahlungsmethoden möglicherweise nur bestimmte Währungen unterstützen.",
"minimum": 1
},
"Cart-Payment_settings_return_url": {
"type": "string",
"format": "uri",
"description": "Seite, auf die der Nutzer nach der Zahlung weitergeleitet wird. Die folgenden Parameter werden dem Link automatisch hinzugefügt: `user_id`, `foreigninvoice`, `invoice_id`, `status`.",
"maxLength": 1000
},
"Cart-Payment_redirect_policy": {
"type": "object",
"properties": {
"redirect_conditions": {
"description": "Zahlungsstatus, der eine Benutzerweiterleitung zur Rückgabe-URL auslöst.",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"delay": {
"description": "Verzögerung, nach der der Nutzer automatisch zur Rückgabe-URL weitergeleitet wird.",
"type": "integer",
"example": 0
},
"status_for_manual_redirection": {
"description": "Zahlungsstatus, der die Anzeige einer Schaltfläche auslöst, bei dessen Klick der Nutzer zur Rückgabe-URL weitergeleitet wird.",
"type": "string",
"example": "none",
"enum": [
"none",
"successful",
"successful_or_canceled",
"any"
]
},
"redirect_button_caption": {
"description": "Lokalisierte Beschriftungen der Weiterleiten-Schaltfläche.",
"type": "string",
"example": "Text button"
}
}
},
"Cart-Payment_settings_sandbox": {
"type": "boolean",
"description": "Stellen Sie den Wert auf `true`, um den Bezahlvorgang zu testen. Verwenden Sie in diesem Fall https://sandbox-secure.xsolla.com, um auf die Benutzeroberfläche für Testzahlungen zuzugreifen.",
"default": false
},
"Cart-Payment_admin-user-request-body": {
"type": "object",
"required": [
"id"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "object",
"properties": {
"value": {
"description": "Benutzer-ID. Zum Testen können Sie einen beliebigen Wert übermitteln. Um echte Zahlungen entgegenzunehmen, müssen Sie die Benutzer-ID aus Ihrem System angeben. Diese ID ist im Webhook [Benutzervalidierung](https://developers.xsolla.com/de/webhooks/operation/user-validation/) zu übermitteln.",
"type": "string",
"minLength": 1,
"maxLength": 255
}
}
},
"name": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Benutzername."
}
}
},
"email": {
"type": "object",
"properties": {
"value": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"format": "email",
"description": "E-Mail-Adresse des Nutzers. Muss gemäß dem Protokoll RFC 822 gültig sein."
}
}
},
"country": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Zweistelliger Ländercode in Großbuchstaben gemäß [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Ist erforderlich, wenn die IP-Adresse im `X-User-Ip`-Header nicht übermittelt wurde. Weitere Informationen zu den [von Xsolla unterstützten Ländern](https://developers.xsolla.com/de/doc/shop-builder/references/supported-countries/) finden Sie in der Dokumentation.
Beispiel: `country=US`",
"example": "US"
},
"allow_modify": {
"type": "boolean",
"description": "Legt fest, ob der Nutzer das Land im Zahlungsportal ändern kann oder nicht.",
"default": false,
"example": false
}
}
},
"age": {
"type": "integer",
"description": "Alter des Nutzers."
},
"phone": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "Telefonnummer des Nutzers."
},
"allow_modify": {
"type": "boolean",
"description": "Legt fest, ob ein Nutzer die Telefonnummer im Zahlungsportal ändern darf. Wenn `phone.value` im Token übermittelt wird, ist der Wert standardmäßig auf `false` gestellt.",
"default": false,
"example": false
},
"hidden": {
"type": "boolean",
"default": true,
"example": false
}
}
},
"tracking_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 32,
"maxLength": 32,
"pattern": "^[A-Za-z0-9]{32}$",
"description": "Eindeutige Tracking-ID (wird in Marketingkampagnen verwendet)."
}
}
},
"steam_id": {
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"minLength": 17,
"maxLength": 17,
"pattern": "^\\d{17}$",
"description": "Steam-ID."
}
}
},
"is_legal": {
"type": "boolean",
"description": "Legt fest, ob der Nutzer eine juristische Person ist."
},
"legal": {
"type": "object",
"description": "Objekt mit Angaben zur juristischen Person. Objekt und alle seine Parameter sind erforderlich, falls für `user.is_legal` `true` festgelegt ist.",
"properties": {
"name": {
"type": "string",
"description": "Vollständiger Name des Unternehmens."
},
"address": {
"type": "string",
"description": "Vollständige Unternehmensanschrift."
},
"vat_id": {
"type": "string",
"description": "Steuerliche Identifikationsnummer."
},
"country": {
"type": "string",
"description": "Land des Unternehmenssitzes. Ländercode, bestehend aus zwei Großbuchstaben gemäß [ISO 3166-1 ALPHA-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
}
},
"Cart_admin_payment": {
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.\n\nAchtung
Um eine SKU mehrfach zu verkaufen, müssen Sie die gewünschte Menge im Parameter purchase.items[].quantity angeben. Doppelte SKUs innerhalb des Arrays werden nicht unterstützt – beim Ersteller des Tokens wird nur die erste vorkommende SKU berücksichtigt. In diesem Fall wird kein Fehler zurückgegeben.
",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "Artikelmenge."
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"Promotions_coupon_code": {
"type": "string",
"description": "Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.",
"minLength": 1,
"maxLength": 128,
"example": "WINTER2021",
"default": "WINTER2021",
"pattern": "^[a-zA-Z0-9]+$"
},
"Cart-Payment_settings_currency": {
"type": "string",
"description": "Bevorzugte Zahlungswährung. Dreistelliger Währungscode gemäß [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Ausführliche Informationen zu den [von Xsolla unterstützten Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/) finden Sie in der Dokumentation."
},
"Cart-Payment_settings_locale": {
"type": "string",
"description": "Sprache der Benutzeroberfläche. [Sprachencode](https://developers.xsolla.com/de/doc/pay-station/features/localization/), bestehend aus 2 Kleinbuchstaben."
},
"Cart-Payment_settings_external_id": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Externe ID der Transaktion."
},
"Cart-Payment_custom_parameters_token": {
"description": "Ihre benutzerdefinierten Parameter werden in Form eines gültigen JSON-Satz von Schlüssel-Wert-Paaren dargestellt.
\nSie können über dieses Feld zusätzliche Parameter übermitteln und so Betrugsschutzfilter konfigurieren. [Siehe Bezahlstation-Dokumentation](https://developers.xsolla.com/de/doc/pay-station/features/antifraud/).",
"type": [
"object",
"null"
],
"minProperties": 1,
"maxProperties": 200,
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
},
"example": {
"custom_parameters": {
"string_param": "example",
"bool_param": true,
"int_param": 100,
"number_param": 12.5,
"null_param": null
}
}
},
"422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Antwortstatuscode.",
"example": 422
},
"errorCode": {
"type": "number",
"description": "Fehlercode.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Verständliche Fehlermeldung.",
"example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
},
"transactionId": {
"type": "string",
"description": "Eindeutige ID der Anfrage.",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"Cart": {
"type": "object",
"additionalProperties": false,
"properties": {
"country": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"example": "US",
"description": "Zweistelliger Ländercode in Großbuchstaben gemäß [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Weitere Informationen zu den [von Xsolla unterstützten Ländern](https://developers.xsolla.com/de/doc/shop-builder/references/supported-countries/) finden Sie in der Dokumentation.
Beispiel: `country=US`"
},
"currency": {
"type": "string",
"minLength": 3,
"maxLength": 3,
"example": "USD",
"description": "Die im Warenkorb angezeigte Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.",
"example": "t-shirt"
},
"quantity": {
"type": "number",
"minimum": 1,
"example": 2,
"description": "Artikelmenge."
}
},
"required": [
"sku",
"quantity"
]
},
"minItems": 1
}
},
"required": [
"items"
]
},
"User-limit_user-external-id": {
"description": "Externe Benutzer-ID.",
"type": "string",
"minLength": 1,
"pattern": "^\\S+$"
},
"User-limit_user": {
"type": "object",
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
},
"required": [
"user_external_id"
]
},
"User-limit_user_flexible": {
"type": [
"object",
"null"
],
"properties": {
"user_external_id": {
"$ref": "#/components/schemas/User-limit_user-external-id"
}
}
},
"User-limit-item": {
"type": "object",
"properties": {
"per_user": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"example": 10,
"description": "Die maximale Anzahl von Artikeln, die ein Nutzer kaufen kann."
},
"available": {
"type": "integer",
"example": 9,
"description": "Die verbleibende Anzahl von Artikeln, die der Nutzer kaufen kann."
}
}
}
}
},
"User-limit_available_flexible": {
"type": "integer",
"minimum": 0,
"description": "Wie viele Artikel der Nutzer noch erhalten kann bzw. wie oft der Nutzer Werbeaktionen innerhalb des geltenden Limits noch in Anspruch nehmen darf."
},
"User-limit_available": {
"type": "integer",
"minimum": 1,
"description": "Wie viele Artikel der Nutzer noch erhalten kann bzw. wie oft der Nutzer Werbeaktionen innerhalb des geltenden Limits noch in Anspruch nehmen darf."
},
"422-invalid-request-extended": {
"type": "object",
"properties": {
"statusCode": {
"type": "number",
"description": "Antwortstatuscode.",
"example": 422
},
"errorCode": {
"type": "number",
"description": "Fehlercode.",
"example": 1102
},
"errorMessage": {
"type": "string",
"description": "Verständliche Fehlermeldung.",
"example": "[0401-1102]: Unprocessable Entity"
},
"errorMessageExtended": {
"$ref": "#/components/schemas/error-message-extended-validation"
},
"transactionId": {
"type": "string",
"description": "Eindeutige Anfrage-ID. Kann verwendet werden, um sich zur Fehlerbehebung an den Xsolla-Support zu wenden.",
"example": "da145238620011eb8e24fe6913ff226a"
}
}
},
"client_virtual_prices_with_calculated_price_response": {
"type": "array",
"description": "Virtuelle Preise.",
"items": {
"type": "object",
"description": "Virtueller Preis.",
"properties": {
"amount": {
"type": "integer",
"example": 100,
"description": "Artikelpreis in virtueller Währung."
},
"amount_without_discount": {
"type": "integer",
"example": 200,
"description": "Der Artikelpreis in virtueller Währung ohne Rabatt. Immer gleich `amount`, da Rabatte nicht auf Preise in virtueller Währung angewendet werden."
},
"calculated_price": {
"type": "object",
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
}
}
},
"sku": {
"type": "string",
"example": "vc_gold",
"description": "SKU der virtuellen Währung."
},
"is_default": {
"type": "boolean",
"example": true,
"description": "Ob es sich um den Standardpreis in virtueller Währung handelt."
},
"image_url": {
"type": [
"string",
"null"
],
"example": "http://image.png",
"description": "Bild-URL der virtuellen Währung."
},
"item_id": {
"type": "integer",
"example": 259774,
"description": "Von Xsolla zugewiesene eindeutige Artikel-ID."
},
"name": {
"type": "string",
"example": "Gold",
"description": "Name der virtuellen Währung."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Artikeltyp. Für die virtuelle Währung ist es`virtual_currency."
},
"description": {
"type": [
"string",
"null"
],
"example": "In-game currency used to purchase weapons and upgrades",
"description": "Beschreibung der virtuellen Währung."
}
}
}
},
"Regions_region_id": {
"type": "integer",
"description": "Regions-ID. Eindeutige Regionskennung innerhalb des Projekts.",
"example": 42
},
"Regions_name": {
"type": "object",
"description": "Name der Region. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format \"^[a–z]{2}-[A–Z]{2}$\" und der Wert ein String ist.",
"additionalProperties": {
"type": "string"
},
"example": {
"en-US": "Asia",
"de-DE": "Asien"
},
"default": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
"Regions_200-region-short-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
}
},
"Regions_countries": {
"type": "array",
"description": "Liste der Länder, die einer Region hinzugefügt werden sollen.\n
Zweistelliger Ländercode in Großbuchstaben gemäß [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\n In der Dokumentation finden Sie ausführliche Informationen zu den [von Xsolla unterstützten Ländern](https://developers.xsolla.com/de/doc/shop-builder/references/supported-countries/).\n
Beispiel: `[\"JP\", \"CN\", \"VN\"]`",
"items": {
"type": "string"
}
},
"Regions_200-region-model": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/Regions_region_id"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
},
"countries": {
"$ref": "#/components/schemas/Regions_countries"
}
},
"example": {
"value": {
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
},
"admin_attribute_response": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
},
"example": {
"value": [
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
},
"schemas-422-invalid-request": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"request-attribute-value": {
"type": "object",
"required": [
"external_id",
"value"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
},
"value": {
"$ref": "#/components/schemas/value-name"
}
},
"example": {
"external_id": "value_id",
"value": {
"en": "Value",
"de": "Wert"
}
}
},
"404-not-found": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1102
},
"errorMessage": {
"type": "string",
"example": "[0000-0000]: Entity not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"responses": {
"Virtual-Items-Currency_200-admin-get-virtual-items": {
"description": "Die Liste der virtuelle Gegenstände wurde erfolgreich empfangen.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_1",
"name": {
"en": "Maximum Armor Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Suit up with flair showcasing your allegiance to Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"long_description": {
"en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "featured",
"name": {
"en": "featured"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "Premium",
"name": {
"en": "Premium"
}
},
{
"external_id": "NonConsumableGroupCode",
"name": {
"en": "Non-consumable"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "Xsolla",
"name": {
"en": "Xsolla"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_large_3",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
},
{
"external_id": "equipment",
"name": {
"en": "Nice Equipment"
}
},
{
"external_id": "Empire",
"name": {
"en": "Empire"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_401-invalid-basic-auth": {
"description": "Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Virtual-Items-Currency_201-created": {
"description": "Virtueller Gegenstand wurde erfolgreich erstellt.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"sku": "com.xsolla.item_1"
}
}
},
"schema": {
"type": "object",
"example": {
"sku": "com.xsolla.item_1"
},
"properties": {
"sku": {
"type": "string",
"example": "new-sku"
}
}
}
}
}
},
"Virtual-Items-Currency_422-invalid-request": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-items-by-group": {
"description": "Die Liste der virtuelle Gegenstände wurde erfolgreich empfangen.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.armor_max_2",
"name": {
"en": "Empire Maximum Armor"
},
"type": "virtual_good",
"description": {
"en": "A strong armor forged to withstand heavy attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 12.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "monthly",
"day_of_week": null,
"day_of_month": 28,
"time": "11:00:00+08:00",
"reset_next_date": 1679972400,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.armor_med_1",
"name": {
"en": "Xsolla Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Moderately protect yourself against the Empires barrage of attacks"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png",
"long_description": {
"en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises."
},
"attributes": [],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"country_iso": "CZ",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": false,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.armor_med_2",
"name": {
"en": "Empire Medium Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
},
{
"sku": "com.xsolla.armor_lrg_2",
"name": {
"en": "Empire Large Armor"
},
"type": "virtual_good",
"description": {
"en": "Provides moderate protection in battle."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png",
"long_description": {
"en": "A strong armor forged to withstand heavy attacks."
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
},
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": 20.99,
"currency": "CZK",
"is_default": false,
"is_enabled": true
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "hourly",
"hours_interval": 8,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-item": {
"description": "Der angegebene virtuelle Gegenstand wurde erfolgreich empfangen.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.swords_1",
"name": {
"en": "Sword Xsolla Skin"
},
"type": "virtual_good",
"description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
"long_description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
},
{
"external_id": "weapon",
"name": {
"en": "weapon"
}
}
],
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currencies": {
"description": "Die Liste der virtuellen Währungen wurde erfolgreich empfangen.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency": {
"description": "Die angegebene virtuelle Währung wurde erfolgreich empfangen.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 1,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency"
}
}
}
},
"Virtual-Items-Currency_404-item": {
"description": "Der Artikel wurde nicht gefunden. Stellen Sie sicher, dass die `project_id` und die `item_sku` korrekt sind.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-packages": {
"description": "Die Liste der virtuellen Währungspakete wurde erfolgreich empfangen.",
"content": {
"application/json": {
"example": {
"items": [
{
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
{
"sku": "com.xsolla.crystal_pack_2",
"name": {
"en": "Medium crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_2",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.crystal_pack_3",
"name": {
"en": "Massive crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_3",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_1",
"name": {
"en": "Small gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png",
"long_description": null,
"attributes": [],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_2",
"name": {
"en": "Medium gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 20,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_2",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
},
{
"sku": "com.xsolla.gold_pack_3",
"name": {
"en": "Large gold pack"
},
"type": "bundle",
"description": {
"en": "Gold x1500"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"order": 1,
"groups": [],
"prices": [
{
"amount": 50,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Money for in-store purchases"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png",
"sku": "com.xsolla.gold_3",
"name": {
"en": "Gold",
"ru": "Gold"
},
"type": "virtual_currency",
"quantity": 1500
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
}
}
}
},
"Virtual-Items-Currency_200-admin-get-virtual-currency-package": {
"description": "Das angegebene virtuelle Währungspaket wurde erfolgreich empfangen.",
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.crystal_pack_1",
"name": {
"en": "Small crystal pack"
},
"type": "bundle",
"description": {
"en": "Crystals x100"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png",
"long_description": null,
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": {
"en-US": "VALUE"
}
},
{
"external_id": "val2",
"value": {
"en-US": "VALUE2"
}
}
]
}
],
"is_free": false,
"is_paid_randomized_reward": true,
"order": 1,
"groups": [],
"prices": [
{
"amount": 5,
"currency": "USD",
"is_default": true,
"is_enabled": true,
"country_iso": "US"
}
],
"media_list": [],
"vc_prices": [],
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"quantity": 100
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-list": {
"description": "Die Liste der virtuelle Gegenstände wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item-list"
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": {
"en": "Big Rocket"
},
"groups": [
{
"external_id": "accessory",
"name": "accessory",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "Big Rocket - description"
},
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": null,
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
},
{
"quantity": 1,
"sku": "com.xsolla.phys_good_1",
"type": "physical_good"
},
{
"quantity": 1,
"name": "Super Lootbox with items",
"image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png",
"sku": "com.xsolla.SuperLootboxBundle_1",
"type": "bundle",
"bundle_type": "standard"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": {
"en": "description"
},
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": {
"en": "SHOTGUN FOR TRUE RAIDERS"
},
"groups": [],
"attributes": [],
"type": "virtual_good",
"description": {
"en": "description"
},
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-item-by-sku": {
"description": "Der virtuelle Gegenstand wurde erfolgreich empfangen.",
"content": {
"application/json": {
"example": {
"item_id": 488833,
"sku": "com.xsolla.swords_1",
"type": "virtual_good",
"name": {
"en": "Sword Xsolla Skin"
},
"description": {
"en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 3,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1761840000
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr_1",
"name": {
"en-US": "OK"
},
"values": [
{
"external_id": "val1",
"value": "VALUE"
},
{
"external_id": "val2",
"value": "VALUE2"
}
]
}
],
"is_free": false,
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_item"
}
}
}
},
"Virtual-Items-Currency_200-get-all-items-list": {
"description": "Die Liste aller virtuelle Gegenstände wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit virtuellen Gegenständen.",
"properties": {
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "accessory"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
]
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"description": "description",
"groups": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Artikelname."
},
"groups": {
"type": "array",
"properties": {
"external_id": {
"type": "string",
"example": "weapons"
},
"name": {
"type": "object",
"additionalProperties": {
"type": [
"string",
"null"
]
}
}
}
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Artikelbeschreibung."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "accessory",
"name": {
"en": "Accessory"
}
}
],
"description": "Big Rocket - description"
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "Weapons"
}
}
],
"description": "description"
},
{
"sku": "com.xsolla.shotgun_raider_2",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [],
"description": "description"
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-list": {
"description": "Die Liste der virtuellen Währung wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"type": "virtual_currency",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "Virtual currency name",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "Emeralds - short description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
},
{
"sku": "com.xsolla.diamond_1",
"name": "Diamonds",
"groups": [],
"attributes": [],
"type": "virtual_currency",
"description": "Diamonds - description",
"image_url": "http://image.png",
"is_free": true,
"price": null,
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency": {
"description": "Die virtuelle Währung wurde erfolgreich empfangen.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 451414,
"sku": "com.xsolla.crystal_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2023-08-11T10:00:00+03:00",
"date_until": "2023-08-11T20:00:00+03:00"
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"is_free": false,
"groups": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency"
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-list": {
"description": "Die Liste der virtuellen Währungspakete wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"type": "virtual_currency",
"quantity": 200,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-package": {
"description": "Das virtuelle Währungspaket wurde erfolgreich empfangen.",
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"item_id": 488832,
"sku": "com.xsolla.crystal_pack_1",
"type": "bundle",
"name": "Crystal Pack",
"bundle_type": "virtual_currency_package",
"description": "Crystal Pack Short Description",
"image_url": "http://vc_package_image.png",
"price": {
"amount": "100",
"amount_without_discount": "100",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": {
"per_user": {
"total": 1,
"available": 1,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1690732800
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 488831,
"sku": "com.xsolla.crystals_1",
"type": "virtual_currency",
"name": "Crystals",
"description": "Crystal - short description",
"image_url": "https://cdn.xsolla.net/items/crystal-pack.png",
"quantity": 10,
"limits": null
}
],
"vp_rewards": [],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package"
}
}
}
},
"Virtual-Items-Currency_200-get-items-by-group-id": {
"description": "Die Liste der Artikel aus der angegebenen Gruppe wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons"
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
},
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.shotgun_raider",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": {
"en": "weapons"
}
}
],
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [],
"limits": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "com.xsolla.big_rocket_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Big Rocket",
"description": "Artikelname."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Artikeltyp: `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`."
},
"description": {
"type": "string",
"example": "Big Rocket - description",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"description": "Bild-URL."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "100.99",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "100.99",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"virtual_item_type": {
"type": "string",
"example": "non_consumable",
"description": "Art des virtuellen Gegenstands.\n\nMögliche Werte:\n- `consumable` – ein Gegenstand, der nach dem Gebrauch aus dem Inventar verschwindet (z. B. Munition).\n- `non_consumable` – ein Gegenstand, der unbegrenzt lange im Inventar verbleibt.\n- `non_renewing_subscription` – ein zeitlich begrenzter Artikel, der den Zugang zu Services oder Inhalten für einen begrenzten Zeitraum gewährt.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"type": "virtual_good",
"description": "Big Rocket - description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"sku": "com.xsolla.shotgun_raider_1",
"name": "SHOTGUN FOR TRUE RAIDERS",
"groups": [
{
"external_id": "weapons",
"name": "weapons",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "stack_size",
"name": {
"en": "Stack size"
},
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_good",
"description": "description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
},
{
"amount": 200,
"sku": "com.xsolla.vc_2",
"is_default": false,
"amount_without_discount": 200,
"image_url": "http://image.png",
"name": "SHOTGUN FOR TRUE RAIDERS",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"virtual_item_type": "non_renewing_subscription",
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_404-item-group": {
"description": "Die Gruppe wurde nicht gefunden. Prüfen Sie, ob die `external_id` korrekt ist und die Gruppe nicht deaktiviert oder gelöscht wurde.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"description": "HTTP-Antwortstatuscode.",
"example": 404
},
"errorCode": {
"type": "integer",
"description": "Xsolla Fehlercode",
"example": 4403
},
"errorMessage": {
"type": "string",
"description": "Kurze Fehlerbeschreibung.",
"example": "[0401-4403]: Item group not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Item group not found"
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-by-group-id": {
"description": "Die Liste der virtuellen Währungen aus der angegebenen Gruppe wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 1
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
}
],
"type": "virtual_currency",
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"is_free": false,
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"virtual_prices": [
{
"amount": 100,
"sku": "com.xsolla.vc_1",
"is_default": true,
"amount_without_discount": 100,
"image_url": "http://image.png",
"name": "Virtual currency name",
"type": "virtual_currency",
"description": "description"
}
],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"groups": [
{
"external_id": "game_currencies",
"name": "VC",
"item_order_in_group": 2
}
],
"attributes": [
{
"external_id": "attr1",
"name": {
"en-US": "Attribute"
},
"values": [
{
"external_id": "val1",
"value": "Value"
},
{
"external_id": "val2",
"value": "Value"
}
]
},
{
"external_id": "rating",
"name": {
"en": "Rating"
},
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"type": "virtual_currency",
"description": "Emeralds - short description",
"image_url": "http://image.png",
"is_free": false,
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"limits": null,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-virtual-currency-packages-by-group-id": {
"description": "Die Liste der virtuellen Währungspakete aus der angegebenen Gruppe wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages"
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.vc_package_1",
"name": "VC Name first package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 1
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Crystals - short description",
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"sku": "com.xsolla.crystal_1",
"name": "Crystals",
"type": "virtual_currency",
"quantity": 100,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": []
},
{
"sku": "com.xsolla.vc_package_3",
"name": "VC Name third package",
"groups": [
{
"external_id": "gift",
"name": "Gift",
"item_order_in_group": 2
}
],
"attributes": [],
"type": "bundle",
"description": "VC Short Package Description",
"image_url": "http://vc_package_image.png",
"is_free": false,
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"sku": "com.xsolla.emerald_1",
"name": "Emeralds",
"type": "virtual_currency",
"quantity": 200,
"limits": null
}
],
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"Virtual-Items-Currency_200-get-items-groups": {
"description": "Die Gruppenliste wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"example": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": null,
"order": 1
},
{
"external_id": "group_external_id",
"name": "Super",
"description": "Super description",
"image_url": null,
"order": 1
}
],
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "weapons",
"description": "Externe ID der Gruppe."
},
"name": {
"type": "string",
"example": "Weapons",
"description": "Gruppenname."
},
"description": {
"type": "string",
"example": "All weapons available in the game",
"description": "Gruppenbeschreibung."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "Bild-URL."
},
"order": {
"type": "integer",
"example": 1,
"description": "Definiert die Anordnungsreihenfolge."
},
"level": {
"type": "integer",
"example": 0,
"description": "Verschachtelungsebene der Gruppe."
},
"children": {
"type": "array",
"example": [
{
"external_id": "background",
"name": "Background",
"description": "Background description",
"image_url": null,
"order": 1,
"level": 1,
"children": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"parent_external_id": "weapons"
}
],
"description": "Untergeordnete Gruppen.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "background",
"description": "Externe ID der Gruppe."
},
"name": {
"type": "string",
"example": "Background",
"description": "Gruppenname."
},
"description": {
"type": "string",
"example": "Background description",
"description": "Gruppenbeschreibung."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "Gruppenbild-URL."
},
"order": {
"type": "integer",
"example": 1,
"description": "Definiert die Anordnungsreihenfolge."
},
"level": {
"type": "integer",
"example": 1,
"description": "Verschachtelungsebene der Gruppe."
},
"children": {
"type": "array",
"example": [
{
"external_id": "accessory",
"name": "Accessory",
"description": "Accessory",
"image_url": null,
"order": 1,
"level": 2,
"children": [],
"parent_external_id": "background"
}
],
"description": "Untergeordnete Gruppen.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "accessory",
"description": "Externe ID der Gruppe."
},
"name": {
"type": "string",
"example": "Accessory",
"description": "Gruppenname."
},
"description": {
"type": "string",
"example": "Accessory",
"description": "Gruppenbeschreibung."
},
"image_url": {
"type": [
"string",
"null"
],
"example": null,
"description": "Bild-URL."
},
"order": {
"type": "integer",
"example": 1,
"description": "Definiert die Anordnungsreihenfolge."
},
"level": {
"type": "integer",
"example": 2,
"description": "Verschachtelungsebene der Gruppe."
},
"children": {
"type": "array",
"example": [],
"description": "Untergeordnete Gruppen.",
"items": {
"type": "string"
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "background",
"description": "Externe ID der übergeordneten Gruppe."
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": "weapons",
"description": "Externe ID der übergeordneten Gruppe."
}
}
}
},
"parent_external_id": {
"type": [
"string",
"null"
],
"example": null,
"description": "Externe ID der übergeordneten Gruppe."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"groups": [
{
"external_id": "weapons",
"name": "Weapons",
"description": "All weapons available in the game",
"image_url": "https://example.com/groups/weapons.png",
"order": 1
},
{
"external_id": "armor",
"name": "Armor",
"description": "Protective equipment",
"image_url": "https://example.com/groups/armor.png",
"order": 2
},
{
"external_id": "consumables",
"name": "Consumables",
"description": "Potions, food, and other single-use items",
"image_url": null,
"order": 3
}
]
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list": {
"description": "Artikelgruppenliste wurde erfolgreich abgerufen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-base"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list"
}
}
}
}
},
"ItemGroup_401-invalid-basic-auth": {
"description": "Die Basisauthentifizierung ist fehlgeschlagen oder es wurden ungültige Anmeldedaten angegeben. Achten Sie darauf, die Basisauthentifizierung zu verwenden und die richtigen Anmeldedaten anzugeben.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/error-response-base"
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_201-admin-create-group": {
"description": "Artikelgruppe wurde erfolgreich angelegt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "Bei der Erstellung angegebene externe Artikelgruppen-ID.",
"example": "weapons"
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/201-admin-create-group"
}
}
}
}
},
"ItemGroup_422-create-update": {
"description": "Die Anfrage kann nicht verarbeitet werden. Wird zurückgegeben, wenn ein Validierungsfehler oder ein Verstoß gegen die Systemregeln vorliegt.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"The property `external_id` is required": {
"$ref": "#/components/examples/422-property-external-id-required"
},
"Group already exists": {
"value": {
"statusCode": 422,
"errorCode": 4401,
"errorMessage": "[0401-4401]: Item group already exists",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Group cannot be its own parent": {
"value": {
"statusCode": 422,
"errorCode": 4404,
"errorMessage": "[0401-4404]: Group can't be self parent",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"Reserved external_id value": {
"value": {
"statusCode": 422,
"errorCode": 4516,
"errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group": {
"description": "Artikelgruppe wurde erfolgreich abgerufen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-response-base"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group"
}
}
}
}
},
"ItemGroup_404-group-not-found": {
"description": "Artikelgruppe nicht gefunden. Wird zurückgegeben, wenn die Gruppe mit der angegebenen `external_id` nicht existiert oder zu einem anderen Projekt gehört.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "Die bei der fehlgeschlagenen Suche verwendeten IDs.",
"properties": {
"project_id": {
"type": "integer",
"description": "Die bei der Suchanfrage verwendete Projekt-ID."
},
"external_id_list": {
"type": "array",
"description": "Liste der in der Suchanfrage verwendeten Gruppen-`external_id`.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "Liste der in der Suchanfrage verwendeten Gruppen-`id`.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
},
"Items or group not found (reorder endpoints)": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_204-admin-update-group": {
"description": "Artikelgruppe wurde erfolgreich aktualisiert."
},
"ItemGroup_204-admin-delete-group": {
"description": "Artikelgruppe wurde erfolgreich gelöscht."
},
"ItemGroup_422-delete": {
"description": "Die Anfrage kann nicht verarbeitet werden. Eine Gruppe, die Artikel enthält, kann nicht gelöscht werden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"Cannot delete group with items": {
"value": {
"statusCode": 422,
"errorCode": 4402,
"errorMessage": "[0401-4402]: Item group with items cannot be deleted.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"ItemGroup_200-admin-get-group-list-by-item-type": {
"description": "Die Liste der Artikelgruppen wurde erfolgreich abgerufen. Das Feld `items_count` enthält ausschließlich Artikel des angegebenen Typs.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin-group-response-by-item-type"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-list-by-item-type"
}
}
}
}
},
"ItemGroup_200-admin-get-group-by-item-type": {
"description": "Die Artikelgruppe wurde erfolgreich abgerufen, wobei `items_count` nach dem angegebenen Artikeltyp gefiltert wurde.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-detail-response-by-item-type"
},
"examples": {
"response": {
"$ref": "#/components/examples/200-admin-get-group-by-item-type"
}
}
}
}
},
"ItemGroup_204-admin-reorder-groups": {
"description": "Artikelgruppen wurden erfolgreich neu sortiert."
},
"ItemGroup_404-reorder-groups-not-found": {
"description": "Artikelgruppe nicht gefunden. Wird zurückgegeben, wenn die Gruppe mit der angegebenen `id` oder `external_id` nicht existiert oder zu einem anderen Projekt gehört.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "Die bei der fehlgeschlagenen Suche verwendeten IDs.",
"properties": {
"project_id": {
"type": "integer",
"description": "Die bei der Suchanfrage verwendete Projekt-ID."
},
"external_id_list": {
"type": "array",
"description": "Liste der in der Suchanfrage verwendeten Gruppen-`external_id`.",
"items": {
"type": "string"
}
},
"group_id_list": {
"type": "array",
"description": "Liste der in der Suchanfrage verwendeten Gruppen-`id`.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Group not found by external_id": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with external id = 'weapons' not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"external_id_list": [
"weapons"
]
}
}
},
"Group not found by ID": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {
"project_id": 123,
"group_id_list": [
99
]
}
}
}
}
}
}
},
"ItemGroup_422-ordering": {
"description": "Die Anfrage kann nicht verarbeitet werden. Die Validierung des Anfragerumpfs ist fehlgeschlagen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemGroup_422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "",
"message": "Object value found, but an array is required"
}
]
}
}
}
}
}
},
"ItemGroup_204-admin-reorder-items": {
"description": "Artikel innerhalb der Gruppe wurden erfolgreich neu angeordnet."
},
"ItemGroup_404-reorder-items-by-external-id-not-found": {
"description": "Artikelgruppe oder Artikel nicht gefunden. Wird zurückgegeben, wenn die Gruppe mit der angegebenen `external_id` nicht existiert oder zu einem anderen Projekt gehört oder wenn eine oder mehrere `item_id` in der Gruppe nicht gefunden wurden.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "Die bei der fehlgeschlagenen Suche verwendeten IDs.",
"properties": {
"project_id": {
"type": "integer",
"description": "Die bei der Suchanfrage verwendete Projekt-ID."
},
"external_id_list": {
"type": "array",
"description": "Liste der in der Suchanfrage verwendeten Gruppen-`external_id`.",
"items": {
"type": "string"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"ItemGroup_404-reorder-items-by-id-not-found": {
"description": "Artikelgruppe oder Artikel nicht gefunden. Wird zurückgegeben, wenn die Gruppe mit der angegebenen `id` nicht existiert oder zu einem anderen Projekt gehört oder wenn eine oder mehrere `item_id` in der Gruppe nicht gefunden wurden.",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/error-response-base"
},
{
"type": "object",
"properties": {
"errorMessageExtended": {
"type": [
"object",
"null"
],
"description": "Die bei der fehlgeschlagenen Suche verwendeten IDs.",
"properties": {
"project_id": {
"type": "integer",
"description": "Die bei der Suchanfrage verwendete Projekt-ID."
},
"group_id_list": {
"type": "array",
"description": "Liste der in der Suchanfrage verwendeten Gruppen-`id`.",
"items": {
"type": "integer"
}
}
}
}
}
}
]
},
"examples": {
"Items or group not found": {
"value": {
"statusCode": 404,
"errorCode": 4403,
"errorMessage": "[0401-4403]: Items or group were not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": {}
}
}
}
}
}
},
"Virtual-Items-Currency_200-quick-purchase": {
"description": "Erfolgreicher virtueller Schnellverkauf.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "Bestell-ID."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Virtual-Items-Currency_422-not-enough-virtual-currency": {
"description": "Nicht genügend virtuelle Währung.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 5006
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-5006]: Not enough virtual currency"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 5006,
"statusCode": 422,
"errorMessage": "[0401-5006]: Not enough virtual currency"
}
}
}
}
}
},
"Game-Keys_200-get-games-catalog": {
"description": "Die Liste der Spiele wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Spielen.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"promotions": [],
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"promotions": [],
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Artikelname."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "unit",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`."
},
"unit_type": {
"type": "string",
"example": "game",
"description": "Einheitstyp: `game`."
},
"description": {
"type": "string",
"example": "Game description",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "Bild-URL."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"unit_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Artikeltyp: `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "DRM-Name."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Eindeutige DRM-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "Ist `true` eingestellt, lassen sich Spielschlüssel auf der Plattform kaufen."
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "Ist `true` eingestellt, ist der Spielschlüssel vorbestellbar und der Release-Termin noch nicht verstrichen."
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "Release-Termin des Spielschlüssels im Format ISO 8601."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"sku": "com.xsolla.game_key_02",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Origin",
"drm_sku": "origin_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [],
"vp_rewards": []
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "unit",
"unit_type": "game",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"promotions": [],
"unit_items": [
{
"sku": "com.xsolla.game_key_01",
"type": "game_key",
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": false,
"is_pre_order": false,
"release_date": null,
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
],
"vp_rewards": []
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-get-game-keys-by-group-catalog": {
"description": "Die Liste der Spielschlüssel wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Spielen.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "game_01",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Game name",
"description": "Artikelname."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_schemas-client-attributes"
},
"type": {
"type": "string",
"example": "game_key",
"description": "Artikeltyp: `game_key`."
},
"description": {
"type": "string",
"example": "Game description",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "Bild-URL."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "2.9900",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "2.9900",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "DRM-Name."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Eindeutige DRM-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"has_keys": {
"type": "boolean",
"example": false,
"description": "Ist `true` eingestellt, lassen sich Spielschlüssel auf der Plattform kaufen."
},
"is_pre_order": {
"type": "boolean",
"example": true,
"description": "Ist `true` eingestellt, ist der Spielschlüssel vorbestellbar und der Release-Termin noch nicht verstrichen."
},
"release_date": {
"type": [
"string",
"null"
],
"example": "2020-08-11T10:00:00+03:00",
"description": "Release-Termin des Spielschlüssels im Format ISO 8601."
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"sku": "com.xsolla.game_1",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 2
},
{
"external_id": "Xsolla",
"name": "Xsolla games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"has_keys": true,
"is_pre_order": true,
"release_date": "2020-08-11T10:00:00+03:00",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"sku": "com.xsolla.game_2",
"name": "Game name",
"groups": [
{
"external_id": "all",
"name": "All games",
"item_order_in_group": 1
}
],
"type": "game_key",
"description": "Game description",
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc",
"value": "Horror"
}
]
}
],
"is_free": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"virtual_prices": [],
"drm_name": "Steam",
"drm_sku": "steam_key_2",
"has_keys": true,
"is_pre_order": false,
"release_date": null,
"periods": []
}
]
}
}
}
}
}
},
"Game-Keys_200-get-drm-list": {
"description": "Die Liste der DRMs wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Spielen.",
"properties": {
"drm": {
"type": "array",
"example": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "steam",
"description": "Eindeutige DRM-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Steam",
"description": "DRM-Name."
},
"image": {
"type": "string",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"description": "Bild-URL."
},
"link": {
"type": [
"string",
"null"
],
"example": "https://support.us.playstation.com",
"description": "Link zum Einlösen."
},
"redeem_instruction_link": {
"type": "string",
"example": "https://support.us.playstation.com",
"description": "Link zur Einlöseanleitung."
},
"drm_id": {
"type": "number",
"example": 1,
"description": "DRM-ID."
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"drm": [
{
"sku": "steam_key_1",
"name": "Steam",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"redeem_instruction_link": "https://support.steampowered.com",
"drm_id": 1
},
{
"sku": "playstation_key_1",
"name": "Playstation",
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": null,
"redeem_instruction_link": "https://support.us.playstation.com",
"drm_id": 2
}
]
}
}
}
}
}
},
"Game-Keys_200-admin-get-games-list": {
"description": "Die Liste der Spiele wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Spielen.",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Interne eindeutige Artikel-ID, die bei der Artikelerstellung vergeben wird."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"type": {
"type": "string",
"example": "unit",
"description": "Artikeltyp. In diesem Fall immer `unit`."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "Bild-URL."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Zusätzliche Spiel-Medieninhalte wie Screenshots, Gameplay-Videos usw.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Medieninhaltstyp: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Ressourcendatei."
}
}
}
},
"is_enabled": {
"type": "boolean",
"description": "Ist diese Option deaktiviert, kann der Artikel weder gekauft noch über das Inventar aufgerufen werden."
},
"is_show_in_store": {
"type": "boolean",
"description": "Artikel ist käuflich erhältlich."
},
"order": {
"type": "integer",
"example": 1,
"description": "Priorität der Spielreihenfolge in der Liste."
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Gruppen, zu denen der Artikel gehört.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"unit_items": {
"type": "array",
"description": "Spielschlüssel für verschiedene DRMs.",
"items": {
"type": "object",
"description": "Spielschlüssel-Artikel. Repräsentiert ein Spiel auf einer bestimmten Plattform (Steam, GOG usw.).",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Interne eindeutige Artikel-ID, die bei der Artikelerstellung vergeben wird."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Artikeltyp. In diesem Fall immer `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Preise in echten Währungen.",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"is_default": {
"type": "boolean",
"description": "Der Standardpreis dient dazu, den Katalog zu erstellen, wenn kein Preis in der Währung des Nutzers angegeben ist."
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Land, in dem dieser Preis gilt. Code bestehend aus zwei Buchstaben gemäß [ISO 3166-1 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "Objekt mit lokalisierten Namen der virtuellen Währung. Schlüssel sind in ISO 3166-1 spezifiziert."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Artikeltyp. In diesem Fall immer `virtual_currency`."
},
"description": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Objekt mit lokalisierten Spielbeschreibung. Die Schlüssel sind in ISO 3166-1 spezifiziert."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "Bild-URL."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Priorität der Spielreihenfolge in der Liste."
},
"is_enabled": {
"type": "boolean",
"description": "Ist diese Option deaktiviert, kann der Artikel weder gekauft noch über das Inventar aufgerufen werden."
},
"is_show_in_store": {
"type": "boolean",
"description": "Artikel ist käuflich erhältlich."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "DRM-Name des Spielschlüssels."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Eindeutige DRM-ID."
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "DRM-Symbol für den Spielschlüssel."
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "Interne eindeutige DRM-ID."
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "Anzahl der käuflich erhältlichen Schlüssel."
},
"total": {
"type": "integer",
"description": "Gesamtzahl der hochgeladenen Schlüssel."
},
"used": {
"type": "integer",
"description": "Anzahl der verkauften Schlüssel."
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "Ist `true` eingestellt, wurde der Spielschlüssel von Nutzern gekauft."
},
"pre_order": {
"type": "object",
"description": "Vorbestelleinstellungen.",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "Release-Termin des Spielschlüssels im Format ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Wenn diese Option deaktiviert ist, kann der Artikel nicht vorbestellt werden."
},
"description": {
"type": [
"string",
"null"
],
"description": "Zusätzliche Vorbestellinformationen, die per E-Mail verschickt werden."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Gruppen, zu denen der Artikel gehört.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"items": [
{
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T20:00:00+03:00",
"date_until": null
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"name": {
"en": "Game 1 Key 2"
},
"groups": [],
"attributes": [],
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
},
{
"item_id": 2,
"sku": "com.xsolla.game_2",
"type": "unit",
"name": {
"en": "Game 2"
},
"description": {
"en": "Example game 2"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"item_id": 5,
"sku": "com.xsolla.game_2_key_2",
"type": "game_key",
"is_free": false,
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"order": 1,
"is_enabled": false,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": true,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
]
}
}
}
}
}
},
"Game-Keys_401-invalid-basic-auth": {
"description": "Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Game-Keys_422-invalid-request": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Game-Keys_422-invalid-request"
},
"examples": {
"The property `drm_sku` is required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required"
}
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"Game-Keys_200-admin-get-game-by-sku": {
"description": "Das Spiel wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Spielinformationen.",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Interne eindeutige Artikel-ID, die bei der Artikelerstellung vergeben wird."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"type": {
"type": "string",
"example": "unit",
"description": "Artikeltyp. In diesem Fall immer `unit`."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "Bild-URL."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Zusätzliche Spiel-Medieninhalte wie Screenshots, Gameplay-Videos usw.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Medieninhaltstyp: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Ressourcendatei."
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Priorität der Spielreihenfolge in der Liste."
},
"groups": {
"type": "array",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"description": "Gruppen, zu denen der Artikel gehört.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
},
"name": {
"type": "object",
"example": {
"en": "Horror"
}
}
}
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_enabled": {
"type": "boolean"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_show_in_store": {
"type": "boolean"
},
"unit_items": {
"type": "array",
"description": "Spielschlüssel für verschiedene DRMs.",
"items": {
"type": "object",
"description": "Spielschlüssel-Artikel. Repräsentiert ein Spiel auf einer bestimmten Plattform (Steam, GOG usw.).",
"properties": {
"item_id": {
"type": "integer",
"example": 1,
"description": "Interne eindeutige Artikel-ID, die bei der Artikelerstellung vergeben wird."
},
"sku": {
"type": "string",
"example": "game_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"type": {
"type": "string",
"example": "game_key",
"description": "Artikeltyp. In diesem Fall immer `game_key`."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Preise in echten Währungen.",
"example": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_is": "RU"
}
],
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
},
"is_default": {
"type": "boolean",
"description": "Der Standardpreis dient dazu, den Katalog zu erstellen, wenn kein Preis in der Währung des Nutzers angegeben ist."
},
"is_enabled": {
"type": "boolean"
},
"country_iso": {
"type": [
"string",
"null"
],
"example": "US",
"description": "Land, in dem dieser Preis gilt. Code bestehend aus zwei Buchstaben gemäß [ISO 3166-1 Alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)."
}
}
}
},
"virtual_prices": {
"type": [
"array",
"null"
],
"example": [
{
"sku": "com.xsolla.gold_1",
"name": {
"en": "Gold"
},
"type": "virtual_currency",
"description": null,
"image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png",
"amount": 1000,
"is_default": true
}
],
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Gold"
},
"description": "Objekt mit lokalisierten Namen der virtuellen Währung. Schlüssel sind in ISO 3166-1 spezifiziert."
},
"type": {
"type": "string",
"example": "virtual_currency",
"description": "Artikeltyp. In diesem Fall immer `virtual_currency`."
},
"description": {
"type": "object",
"additionalProperties": true,
"example": {
"en": "Game 1 Example"
},
"description": "Objekt mit lokalisierten Spielbeschreibung. Die Schlüssel sind in ISO 3166-1 spezifiziert."
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "Bild-URL."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Priorität der Spielreihenfolge in der Liste."
},
"is_enabled": {
"type": "boolean",
"description": "Ist diese Option deaktiviert, kann der Artikel weder gekauft noch über das Inventar aufgerufen werden."
},
"is_show_in_store": {
"type": "boolean",
"description": "Artikel ist käuflich erhältlich."
},
"drm_name": {
"type": "string",
"example": "Steam",
"description": "DRM-Name des Spielschlüssels."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Eindeutige DRM-ID."
},
"drm_image": {
"type": [
"string",
"null"
],
"example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"description": "DRM-Symbol für den Spielschlüssel."
},
"drm_id": {
"type": "integer",
"example": 1,
"description": "Interne eindeutige DRM-ID."
},
"keys": {
"type": "object",
"properties": {
"available": {
"type": "integer",
"description": "Anzahl der käuflich erhältlichen Schlüssel."
},
"total": {
"type": "integer",
"description": "Gesamtzahl der hochgeladenen Schlüssel."
},
"used": {
"type": "integer",
"description": "Anzahl der verkauften Schlüssel."
}
}
},
"is_sales_exist": {
"type": "boolean",
"description": "Ist `true` eingestellt, wurde der Spielschlüssel von Nutzern gekauft."
},
"pre_order": {
"type": "object",
"description": "Vorbestelleinstellungen.",
"properties": {
"release_date": {
"type": [
"string",
"null"
],
"description": "Release-Termin des Spielschlüssels im Format ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Wenn diese Option deaktiviert ist, kann der Artikel nicht vorbestellt werden."
},
"description": {
"type": [
"string",
"null"
],
"description": "Zusätzliche Vorbestellinformationen, die per E-Mail verschickt werden."
}
}
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/admin-item-limit-response"
},
"periods": {
"$ref": "#/components/schemas/item-periods-response"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"item_id": 1,
"sku": "com.xsolla.game_1",
"type": "unit",
"name": {
"en": "Game 1"
},
"description": {
"en": "Example game 1"
},
"long_description": {
"en": "Example game's long description"
},
"image_url": "https://image.example.com",
"media_list": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"order": 1,
"groups": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"attributes": [
{
"external_id": "platform",
"name": {
"en-US": "Platform"
},
"values": [
{
"external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989",
"value": {
"en-US": "Windows, Linux",
"de-DE": "Windows, Linux"
}
}
]
}
],
"is_free": false,
"is_enabled": true,
"is_show_in_store": false,
"unit_items": [
{
"item_id": 3,
"sku": "com.xsolla.game_1_key_1",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1199.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png",
"drm_id": 1,
"keys": {
"available": 3,
"total": 4,
"used": 1
},
"is_sales_exist": false,
"pre_order": {
"release_date": null,
"is_enabled": false,
"description": null
},
"limits": {
"per_user": {
"total": 5,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"item_id": 4,
"sku": "com.xsolla.game_1_key_2",
"type": "game_key",
"is_free": false,
"prices": [
{
"amount": 1299.99,
"currency": "RUB",
"is_default": true,
"is_enabled": true,
"country_iso": "RU"
}
],
"virtual_prices": null,
"order": 1,
"is_enabled": true,
"is_show_in_store": false,
"drm_name": "Epic Games Store",
"drm_sku": "epicgames_key_1",
"drm_image": null,
"drm_id": 8,
"keys": {
"available": 0,
"total": 0,
"used": 0
},
"is_sales_exist": false,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": null
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
}
}
},
"Game-Keys_200-session-information": {
"description": "Sitzungsdaten zum Laden von Codes wurden erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"session_id": {
"type": "string",
"example": "fc7105b6e8ee01339582970b37697242"
},
"count_uploaded": {
"type": "integer",
"example": 0
},
"count_total": {
"type": "integer",
"example": 100
},
"count_skipped": {
"type": "integer",
"example": 10
},
"status": {
"type": "string",
"example": "processing"
}
}
},
"examples": {
"response": {
"value": {
"session_id": "fc7105b6e8ee01339582970b37697242",
"count_uploaded": 0,
"count_total": 100,
"count_skipped": 10,
"status": "processing"
}
}
}
}
}
},
"Game-Keys_200-get-codes": {
"description": "Codes wurden erfolgreich empfangen.",
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "PIN-CODE-ALL PIN-CODE-ALL-3"
},
"examples": {
"response": {
"value": "PIN-CODE-ALL PIN-CODE-ALL-3"
}
}
}
}
},
"Game-Keys_200-user-entitlement-list": {
"description": "Erfolgreicher Empfang einer Liste von Spielschlüsseln, die dem Nutzer gehören.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Spielinformationen.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"total_items_count": {
"$ref": "#/components/schemas/Pagination_total-items-count"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Game-Keys_entitlement_item"
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"total_items_count": 1,
"items": [
{
"name": "The Greatest Game in the World",
"description": "Description of the greatest game in the world.",
"image_url": "https://none",
"project_id": 30810,
"game_sku": "com.xsolla.key_1",
"drm": "drmfree",
"is_pre_order": false
}
]
}
}
}
}
}
},
"Game-Keys_403-auth-header-not-sent": {
"description": "Autorisierungs-Header nicht gesendet.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "Authorization header not sent."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"Bundles_200-admin-get-bundle-list": {
"description": "Die Liste der Bundles wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Artikeln.",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "daily",
"time": "11:00:00+08:00",
"reset_next_date": 1677639600,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-01T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_401-invalid-basic-auth": {
"description": "Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Bundles_201-admin-create-bundle": {
"description": "Bundle wurde erfolgreich erstellt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"$ref": "#/components/schemas/Bundles_sku"
}
}
},
"examples": {
"response": {
"value": {
"sku": "com.xsolla.kg_1"
}
}
}
}
}
},
"Bundles_422-invalid-request": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_422-invalid-request"
},
"examples": {
"The property `sku` is required": {
"$ref": "#/components/examples/422-property-sku-is-required"
},
"Numbers of attribute values per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded"
},
"Numbers of attributes per item exceeded": {
"$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded"
},
"Value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
},
"Custom attributes JSON can’t exceed 500 characters": {
"$ref": "#/components/examples/422-custom-attributes-size-exceeded"
}
}
}
}
},
"Bundles_200-admin-get-bundle-list-in-group": {
"description": "Die Liste der Bundles wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Artikeln.",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
}
}
}
},
"example": {
"items": [
{
"item_id": 610316,
"sku": "com.xsolla.UltraSuperLootboxBundle_1",
"name": {
"en": "Ultra Super Lootbox Bundle"
},
"type": "bundle",
"description": {
"en": "Ultra Super Lootbox with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png",
"long_description": {
"en": "Ultra Super lootbox with different items"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [
{
"amount": "150.49",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"virtual_prices": [],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.booster_min_1",
"name": {
"en": "Xsolla Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png",
"quantity": 2
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Booster"
},
"type": "virtual_good",
"description": {
"en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png",
"quantity": 15
},
{
"sku": "com.xsolla.gloves_1",
"name": {
"en": "Xsolla Gloves"
},
"type": "virtual_good",
"description": {
"en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png",
"quantity": 3
},
{
"sku": "com.xsolla.boots_1",
"name": {
"en": "Xsolla Boots"
},
"type": "virtual_good",
"description": {
"en": "Stylishly protect your toes with the accent of Xsolla"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png",
"quantity": 2
},
{
"sku": "com.xsolla.gun_max",
"name": {
"en": "Xsolla Gun"
},
"type": "virtual_good",
"description": {
"en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png",
"quantity": 10
},
{
"sku": "com.xsolla.minigun_2",
"name": {
"en": "Empire Minigun"
},
"type": "virtual_good",
"description": {
"en": "Just hold down the trigger and pray to the Empire"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": {
"total": 500,
"available": 455,
"reserved": 5,
"sold": 40
},
"recurrent_schedule": {
"per_user": {
"interval_type": "weekly",
"day_of_week": 2,
"time": "11:00:00+08:00",
"reset_next_date": 1677553200,
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_next_date": "2023-03-07T11:00:00+08:00"
}
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
},
{
"item_id": 610317,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": null,
"per_item": null,
"recurrent_schedule": null
},
"periods": []
}
]
}
}
}
},
"Bundles_200-admin-get-bundle": {
"description": "Das angegebene Bundle wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_response"
},
"example": {
"item_id": 610316,
"sku": "com.xsolla.EmpireBundle_1",
"name": {
"en": "Empire bundle"
},
"type": "bundle",
"description": {
"en": "Empire bundle with items"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
"long_description": {
"en": "Empire bundle with some goods"
},
"attributes": [],
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
{
"external_id": "all",
"name": {
"en": "Equipment"
}
}
],
"prices": [],
"virtual_prices": [
{
"sku": "com.xsolla.crystal_1",
"name": {
"en": "Crystals",
"ru": "Crystals"
},
"type": "virtual_currency",
"description": {
"en": "Main in-game currency"
},
"image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png",
"amount": "150",
"is_default": true
}
],
"media_list": [],
"order": 1,
"is_enabled": true,
"is_show_in_store": true,
"regions": [],
"bundle_type": "standard",
"content": [
{
"sku": "com.xsolla.keys_2",
"name": {
"en": "Empire Key"
},
"type": "virtual_good",
"description": {
"en": "Opens ONE Empire lootbox of any kind"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png",
"quantity": 5
},
{
"sku": "com.xsolla.booster_mega_2",
"name": {
"en": "Empire Booster Mega"
},
"type": "virtual_good",
"description": {
"en": "Take it, take it all! All of the Empires riches in one Mega Booster."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png",
"quantity": 1
},
{
"sku": "com.xsolla.booster_min_2",
"name": {
"en": "Empire Booster Mini"
},
"type": "virtual_good",
"description": {
"en": "Test your luck to find glorious treasures from Empire's past"
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png",
"quantity": 3
}
],
"limits": {
"per_user": {
"total": 10,
"limit_exceeded_visibility": "show"
},
"per_item": null,
"recurrent_schedule": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
}
},
"Bundles_204-admin-update-bundle": {
"description": "Bundle wurde erfolgreich aktualisiert.",
"content": {}
},
"Bundles_204-admin-delete-bundle": {
"description": "Bundle wurde erfolgreich gelöscht.",
"content": {}
},
"Bundles_204-admin-show-bundle": {
"description": "Bundle wurde erfolgreich angezeigt.",
"content": {}
},
"Bundles_204-admin-hide-bundle": {
"description": "Bundle wurde erfolgreich ausgeblendet.",
"content": {}
},
"Bundles_200-get-bundle-list": {
"description": "Die Liste der Bundles wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Artikeln.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Bundles_client_bundle"
}
}
}
},
"examples": {
"response": {
"$ref": "#/components/examples/Bundles_200-get-bundle-list"
}
}
}
}
},
"Cart-Payment_200-get-cart-json-model": {
"description": "Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "Warenkorb-ID."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Warenkorbpreis."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Artikelpreis."
},
"virtual_item_type": {
"type": "string",
"description": "Artikeltyp."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_200-fill-cart-json-model": {
"description": "Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "Warenkorb-ID."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string",
"default": "50.0000000000000000"
},
"amount_without_discount": {
"type": "string",
"default": "100.0000000000000000"
},
"currency": {
"type": "string",
"default": "USD"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Warenkorbpreis."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"example": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"description": "Artikelpreis."
},
"virtual_item_type": {
"type": "string",
"description": "Artikeltyp."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.booster_mega_21",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found"
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-item": {
"description": "Der Artikel wurde nicht gefunden. Stellen Sie sicher, dass die `project_id` und die `item_sku` korrekt sind.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found"
}
},
"type": "object"
}
}
}
},
"Cart-Payment_422-non-negative-quantity": {
"description": "Die Artikelmenge muss eine positive Ganzzahl sein.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "Item quantity must be non-negative integer."
},
"errorCode": {
"type": "integer",
"example": 1102
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1102,
"errorMessage": "[0401-1102]: Item quantity must be non-negative integer",
"statusCode": 422
}
}
}
}
}
},
"Cart-Payment_422-can-put-only-virtual-good-to-cart": {
"description": "Dieser Artikeltyp kann nicht in den Warenkorb gelegt werden. Wählen Sie einen anderen Artikeltyp aus.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 422
},
"errorCode": {
"type": "integer",
"example": 1421
},
"errorMessage": {
"type": "string",
"example": "This type of item cannot be put to the cart. Select another type of item."
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1421,
"errorMessage": "Only Virtual Good Supported"
}
}
}
}
}
},
"Cart-Payment_200-order-created": {
"description": "Bestellung wurde erfolgreich erstellt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "Bestell-ID."
},
"token": {
"type": "string",
"description": "Zahlungstoken."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641,
"token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}
}
}
}
}
},
"Cart-Payment_422-invalid-cart": {
"description": "Ungültiger Warenkorb. Prüfen Sie, ob der Warenkorb existiert, gefüllt ist und alle Artikel darin kostenpflichtig sind.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1401
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1401]: Invalid cart"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart"
}
}
}
}
}
},
"Cart-Payment_404-create-order-with-item-not-found-errors": {
"description": "Artikel oder Gutschein nicht gefunden. Prüfen Sie, ob die verwendeten Daten korrekt sind.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"transactionId": {
"type": "string"
}
}
},
"examples": {
"item not found": {
"$ref": "#/components/examples/404-item-by-sku-not-found"
},
"coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
}
}
}
}
},
"Cart-Payment_422-create-order-with-item-invalid": {
"description": "Ungültiger Fehler.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"invalid item": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
},
"code expired": {
"value": {
"errorCode": 9810,
"statusCode": 422,
"errorMessage": "[0401-9810]: Sorry, this code is expired."
}
},
"code redemption limit": {
"value": {
"errorCode": 9804,
"statusCode": 422,
"errorMessage": "[0401-9804]: You have reached the coupon redemption limit."
}
},
"regionally restricted": {
"value": {
"errorCode": 9808,
"statusCode": 422,
"errorMessage": "[0401-9808]: Coupon is not available in your region."
}
}
}
}
}
},
"Cart-Free_200-order-created": {
"description": "Kostenlose Bestellung wurde erfolgreich angelegt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"description": "Bestell-ID."
}
}
},
"examples": {
"response": {
"value": {
"order_id": 641
}
}
}
}
}
},
"Cart-Payment_422-invalid-item": {
"description": "Ungültiger Artikel. Prüfen Sie, ob der Artikel existiert und weder deaktiviert noch gelöscht oder kostenlos ist.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1411
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0401-1411]: Invalid item"
}
}
},
"examples": {
"response": {
"value": {
"errorCode": 1411,
"statusCode": 422,
"errorMessage": "[0401-1411]: Invalid item"
}
}
}
}
}
},
"Cart-Payment_200-get-order": {
"description": "Erfolgreiche Bestellanfrage.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"default": "Order ID.",
"description": "Bestell-ID."
},
"status": {
"type": "string",
"example": "paid",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"description": "Bestellstatus. Eine ausführliche Beschreibung der Status finden Sie im Abschnitt [Lebenszyklus von Bestellungen](https://developers.xsolla.com/de/api/catalog/order-life-cycle)."
},
"content": {
"type": "object",
"description": "Bestelldetails.",
"properties": {
"price": {
"type": "object",
"description": "Bestellpreis.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Rabattierter Bestellpreis."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Bestellpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Bestellpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_price": {
"type": "object",
"description": "Bestellpreis in virtueller Währung.",
"properties": {
"amount": {
"type": "string",
"example": "100",
"description": "Rabattierter Bestellpreis."
},
"amount_without_discount": {
"type": "string",
"example": "150",
"description": "Bestellpreis."
},
"currency": {
"type": "string",
"example": "test_vc",
"description": "Die in der Bestellung verwendete SKU der virtuellen Währung."
}
}
},
"is_free": {
"type": "boolean",
"example": false,
"description": "Ist `true` eingestellt, ist die Bestellung kostenlos."
},
"items": {
"type": "array",
"example": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
],
"description": "Artikelliste.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "some_sku",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"quantity": {
"type": "integer",
"example": 1,
"description": "Artikelmenge."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Artikelpreis.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"order_id": 1,
"status": "paid",
"content": {
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"is_free": false,
"items": [
{
"sku": "com.xsolla.item_1",
"quantity": 1,
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
}
]
}
}
}
}
}
}
},
"Cart-Payment_404-get-order": {
"description": "Bestellung nicht gefunden. Stellen Sie sicher, dass die `project_id` und die `order_id` korrekt sind.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9001
},
"errorMessage": {
"type": "string",
"example": "[0401-9001]: Order not found"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9001,
"errorMessage": "[0401-9001]: Order not found"
}
}
}
}
}
},
"200-admin-order-search": {
"description": "Die Bestellliste wurde erfolgreich abgerufen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"orders": {
"type": "array",
"description": "Bestellliste.",
"items": {
"type": "object",
"properties": {
"order_id": {
"type": "integer",
"example": 1,
"description": "Bestell-ID."
},
"project_id": {
"type": "integer",
"example": 44056,
"description": "Projekt-ID. Dieser Parameter wird im [Kundenportal](https://publisher.xsolla.com/) neben dem Projektnamen angezeigt."
},
"status": {
"type": "string",
"enum": [
"new",
"paid",
"done",
"canceled",
"expired"
],
"example": "paid",
"description": "Bestellstatus. Eine ausführliche Beschreibung der Status finden Sie im Abschnitt [Lebenszyklus von Bestellungen](https://developers.xsolla.com/de/api/catalog/order-life-cycle)."
},
"date_created": {
"type": "string",
"format": "date-time",
"example": "2020-08-11T10:00:00+03:00",
"description": "Datum (mit oder ohne Uhrzeit), an dem die Bestellung angelegt wurde, gemäß [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
},
"mode": {
"type": "string",
"enum": [
"default",
"sandbox"
],
"example": "default",
"description": "Modus der Bestellanlegung."
},
"is_free": {
"type": "boolean",
"example": false,
"description": "Ob die Bestellung kostenlos ist."
},
"invoice_id": {
"type": "string",
"description": "Rechnungs-ID."
},
"price": {
"type": [
"object",
"null"
],
"description": "Bestellpreis.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Endgültiger Bestellpreis."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Bestellpreis ohne Rabatte."
},
"currency": {
"type": "string",
"example": "USD",
"description": "SKU der virtuellen Währung oder dreistelliger Code der echten Währung gemäß [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu den [von Xsolla unterstützten Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/) finden Sie in der Dokumentation."
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "Ob die Währung virtuell ist."
}
}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "07e653a2b15011e6818f005056a54369",
"description": "Benutzer-ID, die beim Anlegen der Bestellung übermittelt wird."
},
"country": {
"type": "string",
"description": "Zweistelliger Ländercode in Großbuchstaben gemäß [ISO 3166-1 Alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Detaillierte Informationen zu den [von Xsolla unterstützten Ländern](https://developers.xsolla.com/de/doc/shop-builder/references/supported-countries/) finden Sie in der Dokumentation.",
"example": "US"
},
"email": {
"type": "string",
"format": "email",
"example": "user@xsolla.com",
"description": "E-Mail-Adresse des Nutzers gemäß dem [RFC 822](https://www.w3.org/Protocols/rfc822/#z8)-Protokoll."
},
"region_id": {
"type": [
"integer",
"null"
],
"example": 12,
"description": "Region-ID des Nutzers. Wird zurückgegeben, wenn regionale Verkaufsbeschränkungen festgelegt sind. Das Land des Nutzers, das beim Anlegen der Bestellung übermittelt wurde, wird mit der Liste der Länder abgeglichen, die beim [Erstellen der Region](https://developers.xsolla.com/de/api/shop-builder/operation/admin-create-region/) angegeben wurden. Weitere Informationen zu regionalen Verkaufsbeschränkungen finden Sie in der [Dokumentation](https://developers.xsolla.com/de/doc/shop-builder/features/regional-restrictions/)."
}
}
},
"items": {
"type": "array",
"description": "Artikelliste.",
"items": {
"type": "object",
"properties": {
"order_item_id": {
"type": "integer",
"description": "Artikel-ID in der Bestellung. Die ID wird von Xsolla beim Anlegen der Bestellung generiert."
},
"item_id": {
"type": "integer",
"example": 1,
"description": "Artikel-ID. Wird von Xsolla beim Erstellen eines Artikels generiert."
},
"sku": {
"type": "string",
"example": "elven_shield",
"description": "Die bei der Erstellung angegebene Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Artikeltyp.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good",
"value_point"
]
},
"quantity": {
"type": "integer",
"example": 1,
"description": "Artikelmenge."
},
"is_free": {
"type": "boolean",
"example": false,
"default": false,
"description": "Ob der Artikel kostenlos ist."
},
"is_bonus": {
"type": "boolean",
"example": false,
"description": "Ob es sich bei dem Artikel um einen Bonus handelt."
},
"region_id": {
"type": [
"integer",
"null"
],
"description": "ID der Region, in der der Artikel verfügbar ist. Weitere Informationen zu regionalen Verkaufsbeschränkungen finden Sie in der [Dokumentation](https://developers.xsolla.com/de/doc/shop-builder/features/regional-restrictions/)."
},
"tax_category": {
"type": "string",
"example": "DG00002",
"description": "Steuerkategorie."
},
"price": {
"type": [
"object",
"null"
],
"description": "Artikelpreis.",
"properties": {
"amount": {
"type": "string",
"example": "30",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "30",
"description": "Artikelpreis ohne Rabatte."
},
"currency": {
"type": "string",
"example": "USD",
"description": "SKU der virtuellen Währung oder dreistelliger Code gemäß [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu den [von Xsolla unterstützten Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/) finden Sie in der Dokumentation."
},
"is_virtual_currency": {
"type": "boolean",
"example": false,
"description": "Ob die Währung virtuell ist."
}
}
},
"description": {
"type": [
"object",
"null"
],
"description": "Objekt mit lnformationen über den Artikel.",
"properties": {
"name": {
"type": "string",
"description": "Artikelname."
},
"image_url": {
"type": "string",
"format": "uri",
"description": "URL des Artikelbildes."
},
"description": {
"type": "string",
"description": "Artikelbeschreibung."
}
}
}
}
}
},
"promotions": {
"type": [
"array",
"null"
],
"description": "Liste der bei der Bestellung angewendeten Werbeaktionen.",
"items": {
"type": "object",
"properties": {
"promotion_id": {
"type": "integer",
"example": 111425,
"description": "Werbeaktions-ID innerhalb des Projekts."
}
}
}
},
"coupons": {
"type": [
"array",
"null"
],
"description": "Liste der bei der Bestellung eingelösten Gutscheine.",
"items": {
"type": "object",
"properties": {
"coupon_id": {
"type": "integer",
"description": "Die von Xsolla beim Erstellen einer Gutscheinaktion generierte Gutschein-ID."
},
"sku": {
"type": "string",
"description": "Die von Xsolla beim Erstellen einer Gutscheinaktion generierte Gutschein-SKU."
},
"code": {
"type": "string",
"description": "Verwendeter Gutscheincode. Einzigartiger Code, bei dem zwischen Groß- und Kleinschreibung unterschieden wird. Enthält Buchstaben und Ziffern."
},
"type": {
"type": "string",
"enum": [
"unique_catalog_offer",
"coupon",
"promocode"
],
"description": "Gutscheintyp."
}
}
}
}
}
}
},
"total_items_count": {
"type": "integer",
"example": 1,
"description": "Die Gesamtzahl der Bestellungen im angegebenen Zeitraum."
},
"has_more": {
"type": "boolean",
"example": true,
"description": "Ob weitere Seiten vorhanden sind."
}
}
},
"examples": {
"response": {
"value": {
"orders": [
{
"order_id": 100511,
"project_id": 101,
"status": "done",
"date_created": "2018-01-08T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": 1
},
"is_free": true,
"items": [
{
"order_item_id": 29,
"item_id": 1005111,
"sku": "com.xsolla.1005111",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": false,
"region_id": 1,
"tax_category": "DG00001",
"description": {
"name": "bla",
"image_url": "http://example.com/image.jpg",
"description": "yes"
}
},
{
"order_item_id": 30,
"item_id": 1005112,
"sku": "com.xsolla.1005112",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": 1,
"tax_category": "DG00001",
"description": null
}
]
},
{
"order_id": 100510,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-07T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 27,
"item_id": 1005101,
"sku": "com.xsolla.1005101",
"type": "game_key",
"quantity": 1,
"is_free": false,
"is_bonus": false,
"region_id": null,
"tax_category": "DG00001",
"description": null,
"price": {
"amount": "67.3400",
"amount_without_discount": "67.3400",
"currency": "USD",
"is_virtual_currency": false
}
},
{
"order_item_id": 28,
"item_id": 1005102,
"sku": "com.xsolla.1005102",
"type": "value_point",
"quantity": 2,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "67.3400",
"amount_without_discount": "72.3400",
"currency": "USD",
"is_virtual_currency": false
},
"invoice_id": "100510",
"promotions": [
{
"promotion_id": 1005101
}
],
"coupons": [
{
"coupon_id": 100510,
"sku": "com.xsolla.100510",
"code": "OPQRSTUVWX",
"type": "promocode"
}
]
},
{
"order_id": 100505,
"project_id": 101,
"status": "paid",
"date_created": "2018-01-02T15:32:06+03:00",
"mode": "default",
"user": {
"id": "07e653a2b15011e6818f005056a54369",
"country": "US",
"email": "user@xsolla.com",
"region_id": null
},
"is_free": false,
"items": [
{
"order_item_id": 17,
"item_id": 1005051,
"sku": "com.xsolla.1005051",
"type": "virtual_good",
"quantity": 1,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
},
{
"order_item_id": 18,
"item_id": 1005052,
"sku": "com.xsolla.1005052",
"type": "value_point",
"quantity": 3,
"is_free": true,
"is_bonus": true,
"region_id": null,
"tax_category": "DG00001",
"description": null
}
],
"price": {
"amount": "78.2300",
"amount_without_discount": "78.2300",
"currency": "popugi",
"is_virtual_currency": true
}
}
],
"total_items_count": 11,
"has_more": true
}
}
}
}
}
},
"401-invalid-basic-auth": {
"description": "Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Cart-Payment_201-admin-create-payment-token": {
"description": "Zahlungstoken und Bestellung erfolgreich erstellt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"token": {
"type": "string",
"description": "Zahlungstoken."
},
"order_id": {
"type": "integer",
"example": 1,
"description": "Bestell-ID."
}
}
},
"examples": {
"response": {
"value": {
"token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb",
"order_id": 12345
}
}
}
}
}
},
"Cart-Payment_401-invalid-basic-auth": {
"description": "Basisauthentifizierung nicht bestanden oder falsch. Prüfen Sie die Anmeldedaten und vergewissern Sie sich, dass Sie die Basisauthentifizierung verwenden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"Cart-Payment_422-admin-create-payment-token": {
"description": "Fehler beim Prüfen des Anfragerumpfs und beim Zusammenstellen des Warenkorbs.\n- Ungültiger Warenkorb, zusammengestellt aus übermittelten Artikeln. Prüft, dass der Warenkorb nicht leer und kein darin enthaltener Artikel kostenlos ist.\n- Ungültiger Anfragerumpf.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/422-invalid-request"
},
"examples": {
"Invalid request body": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Item is free": {
"value": {
"errorCode": 1421,
"statusCode": 422,
"errorMessage": "[0401-1421]: Item is free",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Invalid cart": {
"value": {
"errorCode": 1401,
"statusCode": 422,
"errorMessage": "[0401-1401]: Invalid cart",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"Empty cart": {
"value": {
"errorCode": 1417,
"statusCode": 422,
"errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"User country not provided": {
"value": {
"errorCode": 1102,
"statusCode": 422,
"errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
}
}
}
}
},
"Cart-Payment_200-admin-fill-cart-json-model": {
"description": "Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"cart_id": {
"type": "string",
"example": "cart_id",
"description": "Warenkorb-ID. Übermitteln Sie die ID, um die Kaufseite oder Zahlungs-API-Endpunkte abzufragen."
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "Warenkorbpreis."
},
"is_free": {
"$ref": "#/components/schemas/value-cart_is_free"
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"name": {
"type": [
"string",
"null"
]
},
"attributes": {
"$ref": "#/components/schemas/Cart-Payment_client-attributes"
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"image_url": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"is_bonus": {
"type": "boolean"
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"can_be_bought": {
"$ref": "#/components/schemas/Can_be_bought"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
},
"price": {
"type": [
"object",
"null"
],
"properties": {
"amount": {
"type": "string"
},
"amount_without_discount": {
"type": "string"
},
"currency": {
"type": "string"
}
},
"description": "Artikelpreis."
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_response"
}
}
}
},
"promotions": {
"$ref": "#/components/schemas/Catalog_cart_promotions"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "The cup of tea",
"groups": [
{
"external_id": "cups",
"name": "Cups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "Cup",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"quantity": 2,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": false,
"is_bonus": false,
"name": "White T-shirt",
"price": {
"amount": "3.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"quantity": 1,
"sku": "com.xsolla.t-shirt01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
},
{
"attributes": [],
"description": "Wonderful white T-shirt",
"groups": [
{
"external_id": "clothes",
"name": "Clothes"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"is_free": true,
"is_bonus": false,
"name": "Cat's cup",
"price": null,
"quantity": 1,
"sku": "com.xsolla.cup01",
"type": "physical_good",
"virtual_prices": [],
"promotions": [],
"can_be_bought": true,
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"limits": {
"per_user": {
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"total": 5
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
],
"warnings": [
{
"sku": "com.xsolla.hat01",
"quantity": 1,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found"
}
],
"price": {
"amount": "15.97",
"amount_without_discount": "22.96",
"currency": "USD"
},
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
]
}
}
}
}
}
},
"Cart-Payment_404-user": {
"description": "Der Nutzer wurde nicht gefunden. Stellen Sie sicher, dass der Token `x-user-for` oder `x-user-id` korrekt ist.",
"content": {
"application/json": {
"schema": {
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 5008
},
"errorMessage": {
"type": "string",
"example": "[0401-5008]: Could not find User"
}
},
"type": "object"
}
}
}
},
"Common_401-invalid-basic-auth": {
"description": "Die Anmeldedaten für die Basisauthentifizierung wurden nicht angegeben oder sind falsch. Prüfen Sie, ob Sie die Basisauthentifizierung verwenden und ob die Anmeldedaten korrekt sind.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 401
},
"errorCode": {
"type": "integer",
"example": 1020
},
"errorMessage": {
"type": "string",
"example": "[0401-1020]: Error in Authentication method occurred"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 401,
"errorCode": 1020,
"errorMessage": "[0401-1020]: Error in Authentication method occurred"
}
}
}
}
}
},
"200-admin-get-user-item-limits": {
"description": "Kauflimits für einen Nutzer wurden erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User-limit-item"
},
"examples": {
"response": {
"value": {
"per_user": {
"total": 10,
"available": 9
}
}
}
}
}
}
},
"connector-422-validation-failed": {
"description": "Validierungsfehler aufgrund falscher Parameter im Anfragerumpf, in den Dateieigenschaften oder im Dateiinhalt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"errorCode": {
"type": "integer",
"example": 1803
},
"statusCode": {
"type": "integer",
"example": 422
},
"errorMessage": {
"type": "string",
"example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1803,
"errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"200-items-import-status-model": {
"description": "Der Importstatus wurde erfolgreich abgerufen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "error",
"description": "Importstatus.\n\nMögliche Werte:\n- `initialized` – Import wurde initiiert.\n- `process` – Import läuft.\n- `done` – Import war erfolgreich.\n- `error` – aufgrund von Fehlern wurde der Import nicht oder nur teilweise abgeschlossen.",
"enum": [
"initialized",
"process",
"done",
"error"
]
},
"date_created": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Der Zeitstempel für die Erstellung des Importvorgangs. Datum und Uhrzeit sind in der Zeitzone GMT+3 angegeben."
},
"date_updated": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Der Zeitstempel für den Zeitpunkt, als der Import aufgrund eines Fehlers unterbrochen wurde. Datum und Uhrzeit sind in der Zeitzone GMT+3 angegeben."
},
"date_completed": {
"type": "string",
"example": "2024-12-15T18:16:00+03:00",
"description": "Der Zeitstempel für den Abschluss des Importvorgangs. Datum und Uhrzeit sind in der Zeitzone GMT+3 angegeben. Wenn der Import aufgrund eines Fehlers unterbrochen wurde und keine Artikel importiert wurden, wird ein leerer String zurückgegeben."
},
"progress": {
"type": "integer",
"example": 100,
"description": "Der Fortschritt der Importvorgangs in Prozent."
},
"error": {
"type": "string",
"description": "Beschreibung des allgemeinen Importfehlers."
},
"error_code": {
"type": "string",
"description": "Der Code des allgemeinen Importfehlers."
},
"result": {
"type": "object",
"description": "Ein Objekt mit Daten zu den Importergebnissen und Importfehlern für bestimmte Artikel-SKU.",
"properties": {
"errors_count": {
"type": "integer",
"example": 3,
"description": "Die Anzahl der Artikel, bei denen beim Import Fehler aufgetreten sind."
},
"total_entities_count": {
"type": "integer",
"example": 11,
"description": "Die Gesamtzahl der importierten Artikel."
},
"errors_by_sku": {
"type": "array",
"description": "Ein Array von Objekten mit Daten zu Importfehlern für bestimmte Artikel-SKUs.",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "sku_1",
"description": "SKU des importierten Artikels."
},
"type": {
"type": "string",
"example": "vi",
"description": "Artikeltyp.",
"enum": [
"virtual_good",
"virtual_currency",
"virtual_currency_packages",
"bundle"
]
},
"error_code": {
"type": "integer",
"example": 1001,
"description": "Der Importfehlercode für eine bestimmte Artikel-SKU."
},
"error_message": {
"type": "string",
"example": "Something went wrong",
"description": "Die Beschreibung des Importfehlers für eine bestimmte Artikel-SKU."
}
}
}
}
}
}
},
"example": {
"status": "error",
"date_created": "2024-11-19T14:27:31+03:00",
"date_updated": "2024-11-19T15:27:31+03:00",
"date_completed": "2024-11-19T15:27:31+03:00",
"progress": 100,
"error": null,
"error_code": null,
"result": {
"errors_count": 2,
"total_entities_count": 10,
"errors_by_sku": [
{
"sku": "com.xsolla.sword_1",
"type": "virtual_items",
"error_code": 4055,
"error_message": "[0401-4055]: Item default price not set"
},
{
"sku": "",
"type": null,
"error_code": 1817,
"error_message": "[0410-1817]: SKU can't be empty"
}
]
}
}
}
}
}
},
"sellable_items_200-get-items-list": {
"description": "Die Liste der verkäuflichen Artikel wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit verkäuflichen Artikeln.",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"limits": null,
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows"
}
],
"virtual_item_type": "non_consumable",
"limits": null,
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_2",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_14",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Interne eindeutige Artikel-ID, die bei der Artikelerstellung vergeben wird."
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Artikelname."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"total_content_price": {
"$ref": "#/components/schemas/Bundles_total_content_price"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"bundle_type": {
"type": "string",
"description": "Bundle-Typ. Wird zurückgegeben, wenn der Artikeltyp ein Bundle ist.",
"enum": [
"standard",
"virtual_currency_package"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "Bild-URL."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Sofern `true`, kann der Nutzer einen Artikel kaufen."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Art des virtuellen Gegenstands.\n\nMögliche Werte:\n- `consumable` – ein Gegenstand, der nach dem Gebrauch aus dem Inventar verschwindet (z. B. Munition).\n- `non_consumable` – ein Gegenstand, der unbegrenzt lange im Inventar verbleibt.\n- `non_renewing_subscription` – ein zeitlich begrenzter Artikel, der den Zugang zu Services oder Inhalten für einen begrenzten Zeitraum gewährt.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
},
"content": {
"type": "array",
"items": {
"type": "object",
"items": {
"$ref": "#/components/schemas/Bundles_client_content"
}
}
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": false,
"items": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"price": {
"amount": "1.00",
"amount_without_discount": "1.00",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"limits": null,
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"price": {
"amount": "0.50",
"amount_without_discount": "0.50",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": []
},
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"price": {
"amount": "0.10",
"amount_without_discount": "0.10",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"vp_rewards": []
},
{
"item_id": 259768,
"sku": "com.xsolla.gold_chest_1",
"type": "bundle",
"name": "Chest of gold",
"bundle_type": "virtual_currency_package",
"description": "Chest of gold",
"image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png",
"price": {
"amount": "7.99",
"amount_without_discount": "7.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"type": "virtual_currency",
"name": "Gold",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"quantity": 10
}
],
"vp_rewards": []
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_1",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"vp_rewards": []
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_1",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"vp_rewards": []
},
{
"item_id": 259771,
"sku": "com.xsolla.sword_1",
"type": "virtual_good",
"name": "Sword",
"description": "Sword",
"image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 50,
"amount_without_discount": 50,
"calculated_price": {
"amount": "50.00",
"amount_without_discount": "50.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259773,
"sku": "com.xsolla.bow_1",
"type": "virtual_good",
"name": "Bow",
"description": "Bow",
"image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png",
"price": {
"amount": "4.99",
"amount_without_discount": "4.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 5,
"amount_without_discount": 5,
"calculated_price": {
"amount": "5.00",
"amount_without_discount": "5.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 100,
"amount_without_discount": 100,
"calculated_price": {
"amount": "100.00",
"amount_without_discount": "100.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "bows",
"name": "Bows",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_5",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_5",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_5",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_2",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_6",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_6",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_6",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_7",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_7",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_7",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_8",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_8",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_8",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259778,
"sku": "com.xsolla.armor_chest_1",
"type": "bundle",
"name": "Chest of armor",
"bundle_type": "standard",
"description": "Chest of armour",
"image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_9",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_9",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_9",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "11.98",
"amount_without_discount": "11.98",
"currency": "USD"
},
"content": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_2",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_10",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_10",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_10",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_2",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_11",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_11",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_11",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
}
],
"vp_rewards": []
},
{
"item_id": 259779,
"sku": "com.xsolla.treasure_chest_1",
"type": "bundle",
"name": "Treasure Chest",
"bundle_type": "standard",
"description": "Treasure Chest",
"image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_12",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_12",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_12",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [],
"total_content_price": {
"amount": "802.89",
"amount_without_discount": "802.89",
"currency": "USD"
},
"content": [
{
"item_id": 259772,
"sku": "com.xsolla.saber_1",
"type": "virtual_good",
"name": "Saber",
"description": "Saber",
"image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png",
"price": {
"amount": "3.99",
"amount_without_discount": "3.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_13",
"name": "Gold",
"type": "virtual_currency",
"amount": 3,
"amount_without_discount": 3,
"calculated_price": {
"amount": "3.00",
"amount_without_discount": "3.00"
},
"is_default": true
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"name": "Silver",
"type": "virtual_currency",
"amount": 7,
"amount_without_discount": 7,
"calculated_price": {
"amount": "7.00",
"amount_without_discount": "7.00"
},
"is_default": false
},
{
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"name": "Bronze",
"type": "virtual_currency",
"amount": 70,
"amount_without_discount": 70,
"calculated_price": {
"amount": "70.00",
"amount_without_discount": "70.00"
},
"is_default": false
}
],
"can_be_bought": true,
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "swords",
"name": "Swords"
}
],
"virtual_item_type": "non_consumable",
"quantity": 1
},
{
"item_id": 259769,
"sku": "com.xsolla.silver_chest_2",
"type": "bundle",
"name": "Chest of silver",
"bundle_type": "virtual_currency_package",
"description": "Chest of silver",
"image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259766,
"sku": "com.xsolla.silver_13",
"type": "virtual_currency",
"name": "Silver",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"quantity": 50
}
],
"quantity": 10
},
{
"item_id": 259770,
"sku": "com.xsolla.bronze_chest_2",
"type": "bundle",
"name": "Chest of bronze",
"bundle_type": "virtual_currency_package",
"description": "Chest of bronze",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png",
"price": {
"amount": "5.99",
"amount_without_discount": "5.99",
"currency": "USD"
},
"virtual_prices": [],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [],
"content": [
{
"item_id": 259767,
"sku": "com.xsolla.bronze_13",
"type": "virtual_currency",
"name": "Bronze",
"description": "",
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"quantity": 100
}
],
"quantity": 100
}
],
"vp_rewards": []
}
]
}
}
}
}
}
},
"sellable_items_200-get-item-by-id": {
"description": "Der verkäufliche Artikel wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit verkäuflichen Artikel.",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Interne eindeutige Artikel-ID, die bei der Artikelerstellung vergeben wird."
},
"sku": {
"type": "string",
"example": "electric_shield",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Artikelname."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": "string",
"example": "Electric shield",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "Bild-URL."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Sofern `true`, kann der Nutzer einen Artikel kaufen."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"virtual_item_type": {
"type": "string",
"example": "non-consumable",
"description": "Art des virtuellen Gegenstands.\n\nMögliche Werte:\n- `consumable` – ein Gegenstand, der nach dem Gebrauch aus dem Inventar verschwindet (z. B. Munition).\n- `non_consumable` – ein Gegenstand, der unbegrenzt lange im Inventar verbleibt.\n- `non_renewing_subscription` – ein zeitlich begrenzter Artikel, der den Zugang zu Services oder Inhalten für einen begrenzten Zeitraum gewährt.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
},
"examples": {
"response": {
"value": {
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 10
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
}
}
},
"sellable-item-by-id_404": {
"description": "Artikel nicht gefunden. Stellen Sie sicher, dass die `project_id` und die `item_id` korrekt sind.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with id = 259774 not found"
}
}
}
}
}
},
"sellable-item-by-sku_404": {
"description": "Artikel nicht gefunden. Stellen Sie sicher, dass die `project_id` und die `sku` korrekt sind.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 4001
},
"errorMessage": {
"type": "string",
"example": "[0401-4001]: Item with sku = 'electric_shiel' not found"
}
}
}
}
}
},
"sellable_items_200-get-items-by-group-id": {
"description": "Die Liste der verkäuflichen Artikel aus der angegebenen Gruppe wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"has_more": {
"$ref": "#/components/schemas/Pagination_has-more"
},
"items": {
"type": "array",
"example": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shield_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "clan_value_point_sku_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_1",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_4",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_4",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_4",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour"
}
],
"virtual_item_type": "non_consumable",
"vp_rewards": []
}
],
"items": {
"type": "object",
"properties": {
"item_id": {
"type": "integer",
"example": 259774,
"description": "Interne eindeutige Artikel-ID, die bei der Artikelerstellung vergeben wird."
},
"sku": {
"type": "string",
"example": "com.xsolla.electric_shield_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"type": "string",
"example": "Electric shield",
"description": "Artikelname."
},
"groups": {
"$ref": "#/components/schemas/items_client_groups_response"
},
"attributes": {
"$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes"
},
"type": {
"type": "string",
"example": "virtual_good",
"description": "Artikeltyp: `virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`.",
"enum": [
"virtual_good",
"virtual_currency",
"bundle",
"game_key",
"physical_good"
]
},
"description": {
"type": [
"string",
"null"
],
"example": "Electric shield",
"description": "Artikelbeschreibung."
},
"image_url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"description": "Bild-URL."
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"price": {
"type": "object",
"description": "Artikelpreise.",
"properties": {
"amount": {
"type": "string",
"example": "9.99",
"description": "Reduzierter Artikelpreis."
},
"amount_without_discount": {
"type": "string",
"example": "9.99",
"description": "Artikelpreis."
},
"currency": {
"type": "string",
"example": "USD",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)."
}
}
},
"virtual_prices": {
"$ref": "#/components/schemas/client_virtual_prices_with_calculated_price_response"
},
"virtual_item_type": {
"type": "string",
"example": "non_consumable",
"description": "Art des virtuellen Gegenstands.\n\nMögliche Werte:\n- `consumable` – ein Gegenstand, der nach dem Gebrauch aus dem Inventar verschwindet (z. B. Munition).\n- `non_consumable` – ein Gegenstand, der unbegrenzt lange im Inventar verbleibt.\n- `non_renewing_subscription` – ein zeitlich begrenzter Artikel, der den Zugang zu Services oder Inhalten für einen begrenzten Zeitraum gewährt.",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
]
},
"can_be_bought": {
"type": "boolean",
"example": true,
"description": "Sofern `true`, kann der Nutzer einen Artikel kaufen."
},
"promotions": {
"$ref": "#/components/schemas/Catalog_item_promotions"
},
"limits": {
"$ref": "#/components/schemas/Catalog_item_limits"
},
"custom_attributes": {
"$ref": "#/components/schemas/item-custom-attributes-response"
},
"vp_rewards": {
"$ref": "#/components/schemas/client-item-value-point-reward"
}
}
}
}
}
},
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"item_id": 259774,
"sku": "com.xsolla.electric_shields_1",
"type": "virtual_good",
"name": "Electric shield",
"description": "Electric shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png",
"price": {
"amount": "9.99",
"amount_without_discount": "9.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 10,
"amount_without_discount": 10,
"calculated_price": {
"amount": "10.00",
"amount_without_discount": "10.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 200,
"amount_without_discount": 200,
"calculated_price": {
"amount": "200.00",
"amount_without_discount": "200.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 1
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259775,
"sku": "com.xsolla.royal_shield_1",
"type": "virtual_good",
"name": "Royal shield",
"description": "Royal shield",
"image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png",
"price": {
"amount": "19.99",
"amount_without_discount": "19.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_1",
"name": "Gold",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_1",
"name": "Silver",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_1",
"name": "Bronze",
"type": "virtual_currency",
"amount": 400,
"amount_without_discount": 400,
"calculated_price": {
"amount": "400.00",
"amount_without_discount": "400.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 2
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259776,
"sku": "com.xsolla.ancient_helmet_1",
"type": "virtual_good",
"name": "Ancient helmet",
"description": "Ancient helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png",
"price": {
"amount": "1.99",
"amount_without_discount": "1.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_2",
"name": "Gold",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_2",
"name": "Silver",
"type": "virtual_currency",
"amount": 4,
"amount_without_discount": 4,
"calculated_price": {
"amount": "4.00",
"amount_without_discount": "4.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_2",
"name": "Bronze",
"type": "virtual_currency",
"amount": 40,
"amount_without_discount": 40,
"calculated_price": {
"amount": "40.00",
"amount_without_discount": "40.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 3
}
],
"virtual_item_type": "non_consumable"
},
{
"item_id": 259777,
"sku": "com.xsolla.wooden_helmet_2",
"type": "virtual_good",
"name": "Wooden helmet",
"description": "Wooden helmet",
"image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png",
"price": {
"amount": "0.99",
"amount_without_discount": "0.99",
"currency": "USD"
},
"virtual_prices": [
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png",
"item_id": 259765,
"sku": "com.xsolla.gold_3",
"name": "Gold",
"type": "virtual_currency",
"amount": 1,
"amount_without_discount": 1,
"calculated_price": {
"amount": "1.00",
"amount_without_discount": "1.00"
},
"is_default": true
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png",
"item_id": 259766,
"sku": "com.xsolla.silver_3",
"name": "Silver",
"type": "virtual_currency",
"amount": 2,
"amount_without_discount": 2,
"calculated_price": {
"amount": "2.00",
"amount_without_discount": "2.00"
},
"is_default": false
},
{
"description": null,
"image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png",
"item_id": 259767,
"sku": "com.xsolla.bronze_3",
"name": "Bronze",
"type": "virtual_currency",
"amount": 20,
"amount_without_discount": 20,
"calculated_price": {
"amount": "20.00",
"amount_without_discount": "20.00"
},
"is_default": false
}
],
"can_be_bought": true,
"promotions": [
{
"name": "Bonus promotion",
"date_start": "2020-04-15T16:16:00+03:00",
"date_end": "2026-04-15T16:16:00+03:00",
"discount": {
"percent": "50.00"
},
"bonus": [
{
"quantity": 1,
"name": "Xsolla Minigun",
"image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png",
"sku": "com.xsolla.minigun_1",
"type": "virtual_good"
}
]
}
],
"attributes": [],
"is_free": false,
"groups": [
{
"external_id": "armour",
"name": "Armour",
"item_order_in_group": 4
}
],
"virtual_item_type": "non_consumable",
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
}
}
},
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
]
}
}
}
}
}
},
"200-admin-get-regions-list": {
"description": "Liste der Regionen wurde erfolgreich abgerufen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Artikeln.",
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Regions_200-region-short-model"
}
}
}
},
"examples": {
"response": {
"value": {
"regions": [
{
"id": 44,
"name": {
"en-US": "Asia",
"de-DE": "Asien"
}
},
{
"id": 45,
"name": {
"en-US": "CIS",
"de-DE": "GUS"
}
}
]
}
}
}
}
}
},
"201-admin-create-region": {
"description": "Region wurde erfolgreich erstellt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"region_id": {
"$ref": "#/components/schemas/Regions_region_id"
}
}
},
"example": {
"region_id": 42
}
}
}
},
"200-admin-get-region": {
"description": "Die angegebene Region wurde erfolgreich abgerufen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Regions_200-region-model"
}
}
}
},
"404-region-not-found": {
"description": "Region nicht gefunden. Prüfen Sie, ob die `id` korrekt ist.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9701
},
"errorMessage": {
"type": "string",
"example": "[0401-9701]: Region not found"
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-region": {
"description": "Region wurde erfolgreich aktualisiert.",
"content": {}
},
"204-admin-delete-region": {
"description": "Region wurde erfolgreich gelöscht.",
"content": {}
},
"200-admin-get-attribute-list-response": {
"description": "Attributliste wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Objekt mit Artikeln.",
"properties": {
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/admin_attribute_response"
}
},
"total_count": {
"type": "integer"
}
}
},
"examples": {
"response": {
"value": {
"total_count": 2,
"attributes": [
{
"external_id": "size",
"name": {
"en": "Size",
"de": "Größe"
}
},
{
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
]
}
}
}
}
}
},
"201-admin-create-attribute": {
"description": "Attribut wurde erfolgreich erstellt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
}
}
},
"example": {
"external_id": "genre"
}
}
}
},
"422-validation-failed": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"response": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required"
}
}
}
}
}
},
"200-admin-get-attribute": {
"description": "Das angegebene Attribut wurde erfolgreich empfangen.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin_attribute_response"
}
}
}
},
"404-attribute-not-found": {
"description": "Attribut nicht gefunden.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 404
},
"errorCode": {
"type": "integer",
"example": 9901
},
"errorMessage": {
"type": "string",
"example": "[0401-9901]: Attribute not found."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
}
}
},
"204-admin-update-attribute": {
"description": "Attribut wurde erfolgreich aktualisiert.",
"content": {}
},
"201-admin-create-attribute-value": {
"description": "Attributwert wurde erfolgreich erstellt.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"external_id": {
"$ref": "#/components/schemas/value-external_id"
}
}
},
"example": {
"external_id": "rpg"
}
}
}
},
"403-auth-header-not-sent": {
"description": "Autorisierungs-Header nicht gesendet.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"statusCode": {
"type": "integer",
"example": 403
},
"errorCode": {
"type": "integer",
"example": 0
},
"errorMessage": {
"type": "string",
"example": "Authorization header not sent."
},
"transactionId": {
"type": "string",
"example": "x-x-x-x-transactionId-mock-x-x-x"
}
}
},
"examples": {
"response": {
"value": {
"statusCode": 403,
"errorCode": 0,
"errorMessage": "Authorization header not sent"
}
}
}
}
}
},
"422-create-update-attribute-value": {
"description": "Ungültige Anfrage.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/schemas-422-invalid-request"
},
"examples": {
"external_id is required": {
"$ref": "#/components/examples/422-external-id-required"
},
"external_id is invalid": {
"$ref": "#/components/examples/422-external-id-invalid"
},
"external_id is duplicate": {
"$ref": "#/components/examples/422-external-id-duplicate"
},
"value is required": {
"$ref": "#/components/examples/422-value-invalid"
},
"value properties minimum length": {
"$ref": "#/components/examples/422-value-properties-required"
},
"value limit exceeded": {
"$ref": "#/components/examples/422-value-limit-exceeded"
}
}
}
}
},
"404-attribute-value-not-found": {
"description": "Attributwert nicht gefunden.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404-not-found"
},
"examples": {
"Attribute not found": {
"$ref": "#/components/examples/404-attribute-not-found"
},
"Attribue value not found": {
"$ref": "#/components/examples/404-attribute-value-not-found"
}
}
}
}
}
},
"requestBodies": {
"Virtual-Items-Currency_admin-create-virtual-item": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item"
},
"examples": {
"default": {
"summary": "Minimal setup example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle."
}
}
},
"quickstart": {
"summary": "Quickstart example",
"value": {
"sku": "booster_mega_1",
"name": {
"en": "Mega Booster",
"de": "Mega-Booster"
},
"description": {
"en": "Temporarily doubles the experience points earned in battle.",
"de": "Verdoppelt vorübergehend die im Kampf erhaltenen Erfahrungspunkte."
},
"is_enabled": true,
"is_show_in_store": true,
"is_free": false,
"groups": [
"boosters"
],
"order": 1,
"prices": [
{
"amount": 4.99,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
]
}
},
"full-payload": {
"summary": "Full payload example",
"value": {
"sku": "com.xsolla.sword_1",
"name": {
"en": "Sword",
"de": "Schwert"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"weapons"
],
"order": 1,
"description": {
"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.",
"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."
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
},
{
"amount": 200,
"currency": "CZK",
"country_iso": "CZ",
"is_enabled": false,
"is_default": true
}
],
"vc_prices": [],
"is_show_in_store": true,
"attributes": [
{
"external_id": "craft-materials",
"name": {
"en": "Craft materials"
},
"values": [
{
"external_id": "steel",
"value": {
"en-US": "5"
}
},
{
"external_id": "leather",
"value": {
"en-US": "1"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 100
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency"
},
"example": {
"sku": "com.xsolla.coin_1",
"name": {
"en-US": "Gold coin",
"de-DE": "Goldmünze"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": false,
"groups": [
"gold"
],
"order": 1,
"description": {
"en-US": "The main currency of your kingdom",
"de-DE": "Die Hauptwährung deines Königreichs"
},
"prices": [
{
"amount": 100,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"attributes": [
{
"external_id": "material",
"name": {
"en-US": "Material"
},
"values": [
{
"external_id": "gold",
"value": {
"en-US": "Gold"
}
}
]
}
],
"limits": {
"per_user": 5,
"per_item": 10000
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
}
}
}
},
"Virtual-Items-Currency_admin-create-virtual-currency-package": {
"content": {
"application/json": {
"example": {
"sku": "com.xsolla.novigrad_crown_500",
"name": {
"en-US": "500x Novigradian crown",
"ru-RU": "500x Новиградских крон"
},
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": true,
"groups": [
"witcher"
],
"order": 1,
"long_description": {
"en-US": "Long Test new",
"ru-RU": "Длинное описание"
},
"description": {
"en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms",
"ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах"
},
"image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"attributes": [
{
"external_id": "event",
"name": {
"en-US": "Event"
},
"values": [
{
"external_id": "10-anniversary",
"value": {
"en-US": "10th anniversary"
}
},
{
"external_id": "christmas",
"value": {
"en-US": "Christmas"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": 99.99,
"is_default": true
},
{
"currency": "EUR",
"amount": 80.03,
"is_enabled": false
}
],
"vc_prices": null,
"content": [
{
"sku": "com.xsolla.novigrad_crown",
"quantity": 500
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
}
},
"schema": {
"$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package"
}
}
}
},
"ItemGroup_create": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-create-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons",
"de": "Waffen"
},
"description": {
"en": "Player weapons",
"de": "Spielerwaffen"
},
"iconUrl": "https://example.com/weapons.png",
"isEnabled": true,
"order": 1
}
}
},
"description": "Objekt mit Artikelgruppendaten.",
"required": true
},
"ItemGroup_update": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/admin-group-update-request"
},
"example": {
"external_id": "weapons",
"name": {
"en": "Weapons Updated",
"de": "Waffen Aktualisiert"
},
"description": {
"en": "Updated player weapons",
"de": "Aktualisierte Spielerwaffen"
},
"iconUrl": "https://example.com/weapons-new.png",
"isEnabled": true,
"order": 2
}
}
},
"description": "Objekt mit den zu aktualisierenden Artikelgruppendaten.",
"required": true
},
"ItemGroup_order": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"title": "Anhand der ID identifizieren",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "Von Xsolla zugewiesene Artikelgruppen-ID.",
"minimum": 0,
"example": 1
},
"order": {
"type": "integer",
"description": "Wert für die neue Anzeigereihenfolge.",
"minimum": 0,
"example": 1
}
},
"required": [
"id",
"order"
],
"additionalProperties": false
}
},
{
"title": "Anhand der external_id identifizieren",
"type": "array",
"uniqueItems": true,
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"description": "Bei der Erstellung angegebene externe Artikelgruppen-ID.",
"minLength": 1,
"example": "weapons"
},
"order": {
"type": "integer",
"description": "Wert für die neue Anzeigereihenfolge.",
"minimum": 0,
"example": 1
}
},
"required": [
"external_id",
"order"
],
"additionalProperties": false
}
}
]
},
"examples": {
"by_id": {
"summary": "Identify groups by ID",
"value": [
{
"id": 1,
"order": 1
},
{
"id": 2,
"order": 2
},
{
"id": 3,
"order": 3
}
]
},
"by_external_id": {
"summary": "Identify groups by external_id",
"value": [
{
"external_id": "weapons",
"order": 1
},
{
"external_id": "armor",
"order": 2
},
{
"external_id": "consumables",
"order": 3
}
]
}
}
}
},
"description": "Array von Gruppen mit Werten für die neue Reihenfolge. Alle Artikel müssen anhand derselben Methode identifizierbar sein (entweder anhand ihrer `id` oder ihrer `external_id`).",
"required": true
},
"ItemGroup_item_order": {
"content": {
"application/json": {
"schema": {
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/components/schemas/item-in-group-order-request-item"
}
},
"example": [
{
"item_id": 101,
"order": 1
},
{
"item_id": 102,
"order": 2
},
{
"item_id": 103,
"order": 3
}
]
}
},
"description": "Array von Artikeln mit Werten für die neue Reihenfolge innerhalb der Gruppe.",
"required": true
},
"Game-Keys_create-update-game-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"pattern": "^[a-zA-Z0-9_\\-–.]*$",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"description": {
"$ref": "#/components/schemas/description-localization-object"
},
"long_description": {
"$ref": "#/components/schemas/long-description-localization-object"
},
"image_url": {
"type": "string",
"example": "https://image.example.com",
"description": "Bild-URL."
},
"media_list": {
"type": "array",
"example": [
{
"type": "image",
"url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
}
],
"description": "Zusätzliche Spiel-Medieninhalte wie Screenshots, Gameplay-Videos usw.",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"image",
"video"
],
"example": "image",
"description": "Medieninhaltstyp: `image`/`video`."
},
"url": {
"type": "string",
"example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg",
"description": "Ressourcendatei."
}
}
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Priorität der Spielreihenfolge in der Liste."
},
"groups": {
"type": "array",
"description": "Gruppen, zu denen der Artikel gehört.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes"
},
"is_enabled": {
"type": "boolean",
"description": "Ist diese Option deaktiviert, kann der Artikel weder gekauft noch über das Inventar aufgerufen werden."
},
"is_show_in_store": {
"type": "boolean",
"description": "Artikel ist käuflich erhältlich."
},
"unit_items": {
"type": "array",
"description": "Spielschlüssel für verschiedene DRMs.",
"items": {
"type": "object",
"description": "Spielschlüssel-Artikel. Repräsentiert ein Spiel auf einer bestimmten Plattform (Steam, GOG usw.).",
"properties": {
"sku": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"example": "game_1",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"groups": {
"type": "array",
"description": "Gruppen, zu denen der Artikel gehört.",
"items": {
"type": "object",
"properties": {
"external_id": {
"type": "string",
"example": "horror"
}
},
"required": [
"external_id"
]
}
},
"attributes": {
"$ref": "#/components/schemas/Game-Keys_admin-attributes"
},
"is_free": {
"$ref": "#/components/schemas/value-is_free"
},
"prices": {
"type": "array",
"description": "Preise in echten Währungen.",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1299.99
},
"currency": {
"type": "string",
"example": "RUB",
"description": "Währung des Artikelpreises. Dreistelliger Code pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
},
"is_default": {
"type": "boolean",
"description": "Der Standardpreis dient dazu, den Katalog zu erstellen, wenn kein Preis in der Währung des Nutzers angegeben ist."
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"vc_prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"example": "gold",
"description": "Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten."
},
"amount": {
"type": "number"
},
"is_default": {
"type": "boolean"
},
"is_enabled": {
"type": "boolean"
}
},
"required": [
"amount",
"currency",
"is_default",
"is_enabled"
]
}
},
"order": {
"type": "integer",
"example": 1,
"description": "Priorität der Spielreihenfolge in der Liste."
},
"is_enabled": {
"type": "boolean",
"description": "Ist diese Option deaktiviert, kann der Artikel weder gekauft noch über das Inventar aufgerufen werden."
},
"is_show_in_store": {
"type": "boolean",
"description": "Artikel ist käuflich erhältlich."
},
"drm_sku": {
"type": "string",
"example": "steam",
"description": "Eindeutige DRM-ID."
},
"pre_order": {
"type": "object",
"description": "Vorbestelleinstellungen.",
"properties": {
"release_date": {
"type": "string",
"description": "Release-Termin des Spielschlüssels im Format ISO 8601."
},
"is_enabled": {
"type": "boolean",
"description": "Wenn diese Option deaktiviert ist, kann der Artikel nicht vorbestellt werden."
},
"description": {
"type": "string",
"description": "Zusätzliche Vorbestellinformationen, die per E-Mail verschickt werden."
}
},
"required": [
"release_date",
"is_enabled"
]
},
"regions": {
"$ref": "#/components/schemas/Game-Keys_regions"
},
"limits": {
"$ref": "#/components/schemas/Game-key-item-limit"
},
"periods": {
"$ref": "#/components/schemas/item-periods"
}
},
"required": [
"sku",
"drm_sku",
"prices"
]
}
}
},
"required": [
"sku",
"name",
"unit_items"
],
"example": {
"sku": "com.xsolla.game_1",
"name": {
"en-US": "Game name",
"ru-RU": "Название игры"
},
"description": {
"en-US": "Game description",
"ru-RU": "Краткое описание игры"
},
"long_description": {
"en-US": "Game long description",
"ru-RU": "Полное описание игры"
},
"image_url": "http://image.png",
"media_list": [
{
"type": "image",
"url": "http://image.png"
},
{
"type": "video",
"url": "http://video.png"
}
],
"groups": [
"new_games"
],
"is_enabled": true,
"is_show_in_store": true,
"unit_items": [
{
"sku": "com.xsolla.game_key_1",
"name": {
"en-US": "Game key name",
"ru-RU": "Название игрового ключа"
},
"drm_sku": "steam_key_1",
"prices": [
{
"amount": 35.5,
"currency": "USD",
"is_enabled": true,
"is_default": true
}
],
"vc_prices": [
{
"amount": 35.5,
"sku": "com.xsolla.gold_1",
"is_enabled": true,
"is_default": true
}
],
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"pre_order": {
"release_date": "2020-08-11T10:00:00+03:00",
"is_enabled": true,
"description": "Some description"
},
"regions": [
{
"id": 12
},
{
"id": 64
}
],
"limits": {
"per_user": {
"total": 5
},
"per_item": {
"total": 10000,
"available": 5000,
"reserved": 500,
"sold": 4500
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
]
}
]
}
}
}
},
"description": "Objekt mit Spieldaten.",
"required": true
},
"Bundles_bundle": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundles_admin_bundle_request"
},
"example": {
"sku": "com.xsolla.armour_chest_1",
"name": {
"en": "Chest of armour",
"de": "Brustpanzer"
},
"is_enabled": true,
"is_free": true,
"is_paid_randomized_reward": true,
"order": 1,
"long_description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"description": {
"en": "Chest of armour for soldiers",
"de": "Brustpanzer für Soldaten"
},
"image_url": "https://picture.bundle-with-many-stuff.png",
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"groups": [
"chests"
],
"attributes": [
{
"external_id": "class",
"name": {
"en": "Class"
},
"values": [
{
"external_id": "soldier",
"value": {
"en": "Soldier"
}
},
{
"external_id": "officer",
"value": {
"en": "Officer"
}
}
]
}
],
"prices": [
{
"currency": "USD",
"amount": "9.99",
"is_default": true,
"is_enabled": true
},
{
"currency": "EUR",
"amount": "9.99",
"is_default": false,
"is_enabled": true
}
],
"vc_prices": [],
"content": [
{
"sku": "com.xsolla.iron_gloves_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_boots_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_shield_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_armour_1",
"quantity": 1
},
{
"sku": "com.xsolla.iron_helmet_1",
"quantity": 1
}
],
"limits": {
"per_user": null,
"per_item": null
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"type": "lootbox",
"purchased": 0
}
}
}
},
"description": "Objekt mit Bundle-Daten.",
"required": true
},
"Cart-Payment_fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"example": {
"items": [
{
"sku": "com.xsolla.booster_mega_1",
"quantity": 123
}
]
},
"properties": {
"items": {
"type": "array",
"description": "Liste der Artikel.",
"items": {
"type": "object",
"minItems": 1,
"required": [
"sku",
"quantity"
],
"properties": {
"sku": {
"type": "string",
"default": "booster_mega_1"
},
"quantity": {
"type": "number",
"default": 123
}
}
}
}
}
}
}
}
},
"Cart-Payment_put-item-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"quantity": {
"type": "number",
"description": "Artikelmenge.",
"default": 123
}
}
}
}
}
},
"Cart-Payment_create-order-by-cart-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Währung des Bestellpreises. Dreistelliger Währungscode pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
},
"locale": {
"type": "string",
"description": "Antwortsprache."
},
"sandbox": {
"type": "boolean",
"description": "Legt eine Bestellung in der Testumgebung an. Die Option steht den Nutzern offen, die in der Liste der Firmennutzer aufgeführt sind.",
"default": false
},
"settings": {
"type": "object",
"description": "Einstellungen zum Konfigurieren des Bezahlvorgangs und des Zahlungsportals für einen Nutzer.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "Projektspezifische Parameter.",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"Cart-Payment_create-order-with-specified-item-idJsonModel": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"description": "Währung des Bestellpreises. Dreistelliger Währungscode pro [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). Detaillierte Informationen zu [Von Xsolla unterstützte Währungen](https://developers.xsolla.com/de/doc/pay-station/references/supported-currencies/)."
},
"locale": {
"type": "string",
"description": "Antwortsprache."
},
"sandbox": {
"type": "boolean",
"description": "Legt eine Bestellung in der Testumgebung an. Die Option steht den Nutzern offen, die in der Liste der Firmennutzer aufgeführt sind.",
"default": false
},
"quantity": {
"type": "integer",
"minimum": 1,
"description": "Artikelmenge.",
"default": 1
},
"promo_code": {
"type": "string",
"description": "Löst den Code einer Promocode-Aktion gegen Bezahlung ein."
},
"settings": {
"type": "object",
"description": "Einstellungen zum Konfigurieren des Bezahlvorgangs und des Zahlungsportals für einen Nutzer.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"type": "object",
"description": "Projektspezifische Parameter.",
"minProperties": 1,
"maxProperties": 200
}
}
},
"example": {
"sandbox": true,
"quantity": 5,
"promo_code": "discount_code",
"settings": {
"ui": {
"theme": "63295a9a2e47fab76f7708e1",
"desktop": {
"header": {
"is_visible": true,
"visible_logo": true,
"visible_name": true,
"visible_purchase": true,
"type": "normal",
"close_button": false
}
}
}
},
"custom_parameters": {
"character_id": "ingameUsername"
}
}
}
}
},
"admin-order-search": {
"description": "Suchparameter für Bestellungen",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Wie viele Bestellungen in der Antwort maximal enthalten sein dürfen.",
"minimum": 1,
"maximum": 10,
"default": 10,
"nullable": false
},
"offset": {
"type": "integer",
"description": "Die Nummer der Bestellung aus der generierten Liste (die Zählung beginnt bei 0).",
"default": 0,
"minimum": 0,
"nullable": false
},
"created_date_from": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-15T18:16:00+05:00",
"description": "Startdatum (mit oder ohne Uhrzeit) des Bestellzeitraums gemäß [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
},
"created_date_until": {
"type": "string",
"format": "date-time",
"nullable": false,
"example": "2020-04-16T18:16:00+05:00",
"description": "Enddatum (mit oder ohne Uhrzeit) des Bestellzeitraums gemäß [ ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)."
}
}
},
"example": {
"offset": 0,
"limit": 5,
"created_date_from": "2018-01-07T00:00:00+03:00",
"created_date_until": "2018-01-09T16:00:00+03:00"
}
}
}
},
"Cart-Payment_admin-create-payment-token": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"purchase"
],
"properties": {
"sandbox": {
"$ref": "#/components/schemas/Cart-Payment_settings_sandbox"
},
"user": {
"$ref": "#/components/schemas/Cart-Payment_admin-user-request-body"
},
"purchase": {
"$ref": "#/components/schemas/Cart_admin_payment"
},
"promo_code": {
"$ref": "#/components/schemas/Promotions_coupon_code"
},
"settings": {
"type": "object",
"description": "Einstellungen zum Konfigurieren des Bezahlvorgangs und des Zahlungsportals für einen Nutzer.",
"additionalProperties": false,
"properties": {
"ui": {
"$ref": "#/components/schemas/Cart-Payment_settings_ui"
},
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"language": {
"$ref": "#/components/schemas/Cart-Payment_settings_locale"
},
"external_id": {
"$ref": "#/components/schemas/Cart-Payment_settings_external_id"
},
"payment_method": {
"$ref": "#/components/schemas/Cart-Payment_settings_payment_method"
},
"return_url": {
"$ref": "#/components/schemas/Cart-Payment_settings_return_url"
},
"redirect_policy": {
"$ref": "#/components/schemas/Cart-Payment_redirect_policy"
}
}
},
"custom_parameters": {
"$ref": "#/components/schemas/Cart-Payment_custom_parameters_token"
}
},
"additionalProperties": false
},
"examples": {
"common": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/de/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
}
}
},
"in-sandbox": {
"value": {
"sandbox": true,
"user": {
"id": {
"value": "user-id"
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"currency": "USD"
}
}
},
"with-custom-parameters": {
"value": {
"user": {
"id": {
"value": "user-id"
},
"name": {
"value": "user-name"
},
"email": {
"value": "user@xsolla.com"
},
"country": {
"value": "US",
"allow_modify": false
}
},
"purchase": {
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
},
"settings": {
"language": "de",
"external_id": "AABBCCDD01",
"currency": "USD",
"payment_method": 1380,
"return_url": "https://developers.xsolla.com/de/",
"ui": {
"theme": "63295aab2e47fab76f7708e3"
}
},
"custom_parameters": {
"user_public_id": "player1",
"user_os": "windows10"
}
}
}
}
}
}
},
"Cart-Payment_admin-fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart"
},
"examples": {
"basic": {
"value": {
"currency": "USD",
"items": [
{
"sku": "com.xsolla.cup01",
"quantity": 2
},
{
"sku": "com.xsolla.t-shirt01",
"quantity": 1
},
{
"sku": "com.xsolla.cup02",
"quantity": 1
},
{
"sku": "com.xsolla.hat01",
"quantity": 1
}
]
}
}
}
}
}
},
"reset-user-limits": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"reset-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}
}
}
},
"update-user-limits-flexible": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available_flexible"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 0
}
}
}
},
"update-user-limits-strict": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"user",
"available"
],
"properties": {
"user": {
"$ref": "#/components/schemas/User-limit_user"
},
"available": {
"$ref": "#/components/schemas/User-limit_available"
}
}
},
"example": {
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
},
"available": 1
}
}
}
},
"connector-import-items-body": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"connector_external_id",
"file_url"
],
"properties": {
"connector_external_id": {
"type": "string",
"description": "Ein Fixwert, der den Vorgangstyp für den Artikelimport festlegt.",
"enum": [
"import_items"
]
},
"file_url": {
"type": "string",
"description": "Die URL einer Datei mit Daten im JSON-Format. Die Datei sollte auf einem öffentlich zugänglichen Speicherdienst gehostet sein. Die Dateivorlage steht im Kundenportal unter [Store > Virtuelle Gegenstände > Katalog verwalten > Artikel importieren (JSON)](https://publisher.xsolla.com/0/projects/0/storefront/import-export/import-items) zum Download bereit.",
"example": "https://my-bucket.s3.amazonaws.com/items.json"
},
"mode": {
"type": "string",
"description": "Importaktionen:\n\nMögliche Werte:\n- `create` – neue Artikel hinzufügen.\n- `create_and_update` – neue hinzufügen und bestehende aktualisieren.\n- `sync` – neue hinzufügen, bestehende aktualisieren, fehlende deaktivieren.",
"enum": [
"create",
"create_and_update",
"sync"
],
"default": "create_and_update"
}
}
}
}
}
},
"create-update-region": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"countries",
"name"
],
"properties": {
"countries": {
"$ref": "#/components/schemas/Regions_countries"
},
"name": {
"$ref": "#/components/schemas/Regions_name"
}
},
"example": {
"name": {
"en-US": "Asia",
"de-DE": "Asien"
},
"countries": [
"JP",
"CN",
"VN"
]
}
}
}
}
},
"create-update-attribute": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"external_id",
"name"
],
"properties": {
"external_id": {
"$ref": "#/components/schemas/admin-attribute-external_id"
},
"name": {
"$ref": "#/components/schemas/admin-attribute-name"
}
}
},
"example": {
"external_id": "genre",
"name": {
"en": "Genre",
"de": "Genre"
}
}
}
}
},
"create-update-attribute-value": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/request-attribute-value"
},
"example": {
"external_id": "weapon_class_sword_value",
"value": {
"en": "Sword",
"de": "Schwert"
}
}
}
}
}
},
"examples": {
"422-property-sku-is-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attribute-values-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9909,
"errorMessage": "[0401-9909]: The number of attribute values you specified for the item exceeds the required limit. Try to specify fewer attribute values.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-numbers-of-attributes-per-item-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.",
"transactionId": "da145238620011eb8e24fe6913ff226a"
}
},
"422-value-limit-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 9908,
"errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-custom-attributes-size-exceeded": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "da145238620011eb8e24fe6913ff226a",
"errorMessageExtended": [
{
"property": "custom_attributes",
"message": "JSON can’t exceed 500 characters."
}
]
}
},
"200-admin-get-group-list": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 3
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 4
}
]
}
},
"201-admin-create-group": {
"value": {
"external_id": "weapons"
}
},
"422-property-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x",
"errorMessageExtended": [
{
"property": "external_id",
"message": "The property external_id is required"
}
]
}
},
"200-admin-get-group": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 5
}
},
"200-admin-get-group-list-by-item-type": {
"value": {
"groups": [
{
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
},
{
"id": 2,
"external_id": "swords",
"name": {
"en": "Swords"
},
"description": {
"en": "Melee weapons"
},
"image_url": "https://example.com/swords.png",
"order": 2,
"is_enabled": true,
"items_count": 2,
"is_contains_any_items": true
},
{
"id": 3,
"external_id": "armor",
"name": {
"en": "Armor"
},
"description": {
"en": "Player armor"
},
"image_url": "https://example.com/armor.png",
"order": 3,
"is_enabled": true,
"items_count": 0,
"is_contains_any_items": false
}
]
}
},
"200-admin-get-group-by-item-type": {
"value": {
"id": 1,
"external_id": "weapons",
"name": {
"en": "Weapons"
},
"description": {
"en": "Player weapons"
},
"image_url": "https://example.com/weapons.png",
"order": 1,
"is_enabled": true,
"items_count": 3,
"is_contains_any_items": true
}
},
"404-game-code-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4603,
"errorMessage": "[0401-4603]: Game code not found.",
"transactionId": "transaction id"
}
},
"422-drm-is-not-drm-free": {
"value": {
"statusCode": 422,
"errorCode": 5103,
"errorMessage": "[0401-5103]: Selected drm is not drmfree.",
"transactionId": "transaction id"
}
},
"422-user-already-has-entitlement": {
"value": {
"statusCode": 422,
"errorCode": 5101,
"errorMessage": "[0401-5101]: User already has entitlement.",
"transactionId": "transaction id"
}
},
"Bundles_200-get-bundle-list": {
"value": {
"has_more": true,
"items": [
{
"item_id": 61031,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1",
"image_url": null,
"long_description": null,
"attributes": [
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
}
],
"is_free": false,
"order": 999,
"groups": [
{
"external_id": "exclusive",
"name": "Exclusive",
"item_order_in_group": 1
}
],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"can_be_bought": true,
"bundle_type": "standard",
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"content": [
{
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "virtual_currency",
"quantity": 100,
"virtual_item_type": "non_consumable",
"attributes": [
{
"external_id": "size",
"name": "Size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Large"
}
]
}
],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
}
]
}
},
"Bundles_200-get-bundle": {
"value": {
"item_id": 610316,
"sku": "com.xsolla.kg_1",
"name": "kg_10.00_bundle",
"type": "bundle",
"description": "pricePoint_44056_1.",
"image_url": null,
"long_description": null,
"attributes": [],
"is_free": false,
"order": 999,
"groups": [],
"price": {
"amount": "9.99",
"currency": "USD",
"amount_without_discount": "9.99"
},
"total_content_price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"media_list": [],
"virtual_prices": [],
"promotions": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
},
"can_be_bought": true,
"bundle_type": "standard",
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"custom_attributes": {
"purchased": 0,
"attr": "value"
},
"content": [
{
"description": "Big Rocket - short description.",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"sku": "com.xsolla.big_rocket_1",
"name": "Big Rocket",
"type": "virtual_currency",
"quantity": 100,
"attributes": [],
"is_free": false,
"groups": [],
"price": {
"amount": "10.99",
"currency": "USD",
"amount_without_discount": "10.99"
},
"virtual_prices": [],
"limits": {
"per_user": {
"total": 5,
"available": 3,
"recurrent_schedule": {
"interval_type": "weekly",
"reset_next_date": 1746057600
},
"limit_exceeded_visibility": "show"
}
}
}
],
"vp_rewards": [
{
"item_id": 175232,
"sku": "com.xsolla.value_point_1",
"amount": 130,
"name": "Value point",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg"
},
{
"item_id": 186321,
"sku": "com.xsolla.clan_value_point_1",
"amount": 50,
"name": "Clan Reward VP 1",
"image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg",
"is_clan": true
}
]
}
},
"404-item-by-sku-not-found": {
"value": {
"statusCode": 404,
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found",
"transactionId": "transaction id"
}
},
"404-coupon-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9802,
"errorMessage": "[0401-9802]: Coupon not found",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-user-not-found": {
"value": {
"statusCode": 404,
"errorCode": 5008,
"errorMessage": "[0401-5008]: Could not find User",
"transactionId": "transaction id"
}
},
"422-user_external_id_invalid": {
"value": {
"statusCode": 404,
"errorCode": 1102,
"errorMessage": "[0401-1102]: Unprocessable Entity",
"transactionId": "transaction id",
"errorMessageExtended": [
{
"property": "user_external_id",
"message": "Must be at least 1 characters long"
},
{
"property": "user_external_id",
"message": "Does not match the regex pattern ^\\S+$"
}
]
}
},
"422-item-without-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4508,
"errorMessage": "[0401-4508]: Item does not have configured user limits.",
"transactionId": "transaction id"
}
},
"422-item-out-of-range-available-user-limit": {
"value": {
"statusCode": 422,
"errorCode": 4510,
"errorMessage": "[0401-4510]: Available item limit is out of range.",
"transactionId": "transaction id"
}
},
"422-external-id-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-external-id-duplicate": {
"value": {
"statusCode": 422,
"errorCode": 9907,
"errorMessage": "[0401-9907]: The attribute value already exists.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-invalid": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"422-value-properties-required": {
"value": {
"statusCode": 422,
"errorCode": 9901,
"errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9901,
"errorMessage": "[0401-9901]: Attribute not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
},
"404-attribute-value-not-found": {
"value": {
"statusCode": 404,
"errorCode": 9906,
"errorMessage": "[0401-9906]: Attribute value not found.",
"transactionId": "x-x-x-x-transactionId-mock-x-x-x"
}
}
}
},
"x-tagGroups": [
{
"name": "VIRTUELLE GEGENSTÄNDE UND WÄHRUNG",
"tags": [
"virtual-items-currency-overview",
"virtual-items-currency-admin",
"virtual-items-currency-catalog",
"virtual-payment"
]
},
{
"name": "SPIELSCHLÜSSEL",
"tags": [
"game-keys-overview",
"game-keys-catalog",
"game-keys-entitlement",
"game-keys-admin"
]
},
{
"name": "BUNDLES",
"tags": [
"bundles-overview",
"bundles-admin",
"bundles-catalog"
]
},
{
"name": "WARENKORB UND ZAHLUNG",
"tags": [
"cart-and-payment-overview",
"order-life-cycle",
"cart-client-side",
"cart-server-side",
"payment-client-side",
"payment-server-side",
"order",
"free-item"
]
},
{
"name": "LIMITS",
"tags": [
"limits-overview",
"user-limits-admin"
]
},
{
"name": "ARTIKELIMPORT",
"tags": [
"connector-admin"
]
},
{
"name": "ALLGEMEINES",
"tags": [
"common-pre-orders",
"common-merchant",
"common-catalog",
"common-regions",
"common-webhooks"
]
},
{
"name": "ARTIKELATTRIBUTE",
"tags": [
"attribute-admin"
]
},
{
"name": "ARTIKELGRUPPEN",
"tags": [
"item-groups-admin",
"item-groups-catalog"
]
}
]
}