Zum Inhalt springen
/
Virtuellen Gegenstand akt...

Katalog-API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

The Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store.

The API allows you to manage the following catalog entities:

  • Virtual items — in-game items such as weapons, skins, boosters.
  • Virtual currency — virtual money used to purchase virtual goods.
  • Virtual currency packages — predefined bundles of virtual currency.
  • Bundles — combined packages of virtual items, currency, or game keys sold as a single SKU.
  • Game keys — keys for games and DLCs distributed via platforms like Steam or other DRM providers.
  • Groups — logical groupings for organizing and sorting items within the catalog.

API calls

The API is divided into the following groups:

  • Admin — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via basic access authentication with your merchant or project credentials. Not intended for storefront use.
  • Catalog — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions.

Authentication

API calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the Security section in the description of each call.

Authentication using user's JWT

User's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the XsollaLoginUserJWT scheme is applied. For details on how to create a token, see the Xsolla Login API documentation.

The token is passed in the Authorization header in the following format: Authorization: Bearer <user_JWT>, where <user_JWT> is the user token. The token identifies the user and provides access to personalized data.

Alternativ können Sie einen Token zum Öffnen des Zahlungsportals verwenden.

Basic HTTP authentication

Basic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an API key is typically used.

Note

The API key is confidential and must not be stored or used in client applications.

With basic server-side authentication, all API requests must include the following header:

  • for basicAuth — Authorization: Basic <your_authorization_basic_key>, where your_authorization_basic_key is the project_id:api_key pair encoded in Base64
  • for basicMerchantAuth — Authorization: Basic <your_authorization_basic_key>, where your_authorization_basic_key is the merchant_id:api_key pair encoded in Base64

You can find the parameter values in Publisher Account:

  • merchant_id is displayed:
    • In Company settings > Company.
    • In the URL in the browser address bar on any Publisher Account page. The URL has the following format: https://publisher.xsolla.com/<merchant_id>.
  • project_id is displayed:
    • Next to the project name in Publisher Account.
    • In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
  • api_key is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections:
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.

For more information about working with API keys, see the API references.

Authentication with guest access support

Das Authentifizierungsschema AuthForCart wird für Warenkorbkäufe verwendet und unterstützt zwei Modi:

  1. Authentication with a user's JWT. The token is passed in the Authorization header in the following format: Authorization: Bearer <user_JWT>, where <user_JWT> is the user token. The token identifies the user and provides access to personalized data. Alternatively, you can use a token for opening the payment UI.

  2. Simplified mode without Authorization header. This mode is used only for unauthorized users and can be applied only for game key sales. Instead of a token, the request must include the following headers:

    • x-unauthorized-id with a request ID
    • x-user with the user's email address encoded in Base64

Core entity structure

Items 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.

Note

Some calls may include additional fields but they don't change the basic structure.

Identification

  • merchant_id — company ID in Publisher Account
  • project_id — project ID in Publisher Account
  • sku — item SKU, unique within the project

Store display

  • name — item name
  • description — item description
  • image_url — image URL
  • is_enabled — item availability
  • is_show_in_store — whether the item is displayed in the catalog

For more information about managing item availability in the catalog, see the documentation.

Organization

  • type — item type, for example, a virtual item (virtual_item) or bundle (bundle)
  • groups — groups the item belongs to
  • order — display order in the catalog

Sale conditions

  • prices — prices in real or virtual currency
  • limits — purchase limits
  • periods — availability periods
  • regions — regional restrictions

Example of core entity structure:

{
  "attributes": [],
  "bundle_type": "virtual_currency_package",
  "content": [
    {
      "description": {
        "en": "Main in-game currency"
      },
      "image_url": "https://.../image.png",
      "name": {
        "en": "Crystals",
        "de": "Kristalle"
      },
      "quantity": 500,
      "sku": "com.xsolla.crystal_2",
      "type": "virtual_currency"
    }
  ],
  "description": {
    "en": "Crystals x500"
  },
  "groups": [],
  "image_url": "https://.../image.png",
  "is_enabled": true,
  "is_free": false,
  "is_show_in_store": true,
  "limits": {
    "per_item": null,
    "per_user": null,
    "recurrent_schedule": null
  },
  "long_description": null,
  "media_list": [],
  "name": {
    "en": "Medium crystal pack"
  },
  "order": 1,
  "periods": [
    {
      "date_from": null,
      "date_until": "2020-08-11T20:00:00+03:00"
    }
  ],
  "prices": [
    {
      "amount": 20,
      "country_iso": "US",
      "currency": "USD",
      "is_default": true,
      "is_enabled": true
    }
  ],
  "regions": [],
  "sku": "com.xsolla.crystal_pack_2",
  "type": "bundle",
  "vc_prices": []
}

Basic purchase flow

The 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.

The following example shows a basic flow for setting up and operating a store, from item creation to purchase.

Create items and groups (Admin)

Create an item catalog for your store, such as virtual items, bundles, or virtual currency.

Example API calls:

Set up promotions, chains, and limits (Admin)

Configure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.

Example API calls:

Get item information (Client)

Configure item display in your application.

Notice

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.

Example API calls:

Note

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.

Sell items

You can sell items using the following methods:

  • Fast purchase — sell one SKU multiple times.
  • Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.

If an item is purchased using virtual currency instead of real money, use the Create order with specified item purchased by virtual currency API call. The payment UI is not required, as the charge is processed when the API call is executed.

For free item purchase, use the Create order with specified free item API call or the Create order with free cart API call. The payment UI is not required — the order is immediately set to the done status.

Fast purchase

Use the client-side API call to create an order with a specified item. The call returns a token used to open the payment UI.

Note

Discount information is available to the user only in the payment UI. Promo codes are not supported.

Cart purchase

Cart setup and purchase can be performed on the client or on the server side.

Set up and purchase a cart on the client

Implement 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.

Implement the following cart logic:

  1. After the player has filled a cart, use the Fill cart with items API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).
  2. Update the cart contents based on user actions:
Note

To get the current status of the cart, use the Get current user's cart API call.
  1. Use the Create order with all items from current cart API call. The call returns the order ID and payment token. The newly created order is set to new status by default.

Set up and purchase a cart on the server

This setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.

Implement the following cart logic:

  1. After the player has filled a cart, use the Fill cart with items API call. The call returns current information about the selected items (prices before and after discounts, bonus items).
  2. Use the Create order with all items from current cart API call. The call returns the order ID and payment token. The newly created order is set to new status by default.

Open payment UI

Use the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the documentation.

ActionEndpoint
Open in production environment.https://secure.xsolla.com/paystation4/?token={token}
Open in sandbox mode.https://sandbox-secure.xsolla.com/paystation4/?token={token}
Note

Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use test bank cards.

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.

Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in Publisher Account, 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.

To enable or disable sandbox mode, change the value of the sandbox parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default.

Possible order statuses:

  • new — order created
  • paid — payment received
  • done — item delivered
  • canceled — order canceled
  • expired — order expired

Track order status using one of the following methods:

Pagination

API calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially.

Use the following parameters to control the number of returned items:

  • limit — number of items per page
  • offset — index of the first item on the page (numbering starts from 0)
  • has_more — indicates whether another page is available
  • total_items_count — total number of items

Example request:

GET /items?limit=20&offset=40

Response example:

{
  "items": [...],
  "has_more": true,
  "total_items_count": 135
}

It is recommended to send subsequent requests until the response returns has_more = false.

Date and time format

Dates and time values are passed in the ISO 8601 format.

The following are supported:

  • UTC offset
  • null value when there is no time restriction for displaying an item
  • Unix timestamp (in seconds) used in some fields

Format: YYYY-MM-DDTHH:MM:SS±HH:MM

Example: 2026-03-16T10:00:00+03:00

Localization

Xsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the documentation.

Supported fields

Localization can be specified for the following parameters:

  • name
  • description
  • long_description

Locale format

The locale key can be specified in one of the following formats:

  • Two-letter language code: en, ru
  • Five-letter language code: en-US, ru-RU, de-DE

Examples

Example with a two-letter language code:

{
  "name": {
    "en": "Starter Pack",
    "ru": "Стартовый набор"
  }
}

Example with a five-letter language code:

{
  "description": {
    "en-US": "Premium bundle",
    "de-DE": "Premium-Paket"
  }
}

Country and currency determination

The user's country determines catalog prices, the payment currency, and available payment methods in the payment UI. Depending on the API call, the country is determined as follows:

  • In client-side API calls, the country is determined by the IP address of the request.
  • In server-side API calls, the country is determined by the value of the user.country.value parameter or by the user's IP address from the X-User-Ip header. If both are passed, the user.country.value parameter takes precedence.
Note

Only IPv4 addresses are supported for country determination. Passing an IPv6 address may result in incorrect country and currency detection. If you use the server-side API call and cannot provide the user's IPv4 address, pass the country in the user.country.value parameter.

Error response format

If an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the documentation.

Response example:

{
  "errorCode": 1102,
  "errorMessage": "Validation error",
  "statusCode": 422,
  "transactionId": "c9e1a..."
}
  • errorCode — error code.
  • errorMessage — short error description.
  • statusCode — HTTP response status.
  • transactionId — request ID. Returned only in some cases.
  • errorMessageExtended — additional error details, such as request parameters. Returned only in some cases.

Extended response example:

{
  "errorCode": 7001,
  "errorMessage": "Chain not found",
  "errorMessageExtended": {
    "chain_id": "test_chain_id",
    "project_id": "test_project_id",
    "step_number": 2
  },
  "statusCode": 404
}

Common HTTP status codes

  • 400 — invalid request
  • 401 — authentication error
  • 403 — insufficient permissions
  • 404 — resource not found
  • 422 — validation error
  • 429 — rate limit exceeded

Recommendations

  • Handle the HTTP status and the response body together.
  • Use errorCode to process errors related to application logic.
  • Use transactionId to identify requests more quickly when analyzing errors.
OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/catalog/

Übersicht

Sie können einen Ingame-Shop mit virtuellen Gegenständen und virtueller Währung einrichten und festlegen, wie dieser Shop den Nutzern angezeigt wird. Folgende Artikeltypen stehen zur Verfügung:

  • virtuelle Gegenstände – Ingame-Items wie Waffen, Skins oder Booster. Können gegen echtes Geld oder virtuelle Währung verkauft werden.
  • virtuelle Währung – Ingame-Währung für den Kauf virtueller Gegenstände. Kann gegen echtes Geld oder virtuelle Währung verkauft werden.
  • virtuelle Währungspakete – eine festgelegte Menge virtueller Währung. Können gegen echtes Geld oder virtuelle Währung verkauft werden.

Gruppen dienen dazu, Artikel im Katalog zu organisieren, logisch zu gruppieren und zu steuern, wie Artikel angezeigt werden.

Mit API-Aufrufen aus dem Unterabschnitt Verwaltung können Sie Artikel erstellen, aktualisieren und löschen.

Mit API-Aufrufen aus dem Unterabschnitt Katalog können Sie Artikellisten abrufen und sie den Nutzern anzeigen.

Hinweis

Verwenden Sie keine API-Aufrufe aus dem Unterabschnitt Verwaltung,0 um einen Shopkatalog zu erstellen.

Hinweis

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.

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.

Wird ein Artikel mit virtueller Währung gekauft, müssen Sie den API-Aufruf Bestellung mit einem angegebenen, in virtueller Währung gekauften Artikel anlegen verwenden. Das Zahlungsportal muss nicht aufgerufen werden – die Zahlungsabwicklung erfolgt bei Ausführung des API-Aufrufs.

Kaufvorgang mit virtueller Währung (Beispiel):

Kaufvorgang mit virtueller Währung (Beispiel)

Administrator

Operationen

Virtuellen Gegenstand abrufenServer-sideAdmin

Anfrage

Ruft den virtuellen Gegenstand innerhalb eines Projekts zur Verwaltung ab.

Hinweis

Verwenden Sie diesen Endpunkt nicht zum Erstellen eines Shop-Katalogs.
Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID. Dieser Parameter wird im Kundenportal 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/<merchant_id>/projects/<project_id>.

Beispiel: 44056
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/virtual_items/sku/booster_mega_1

Antworten

Der angegebene virtuelle Gegenstand wurde erfolgreich empfangen.

Bodyapplication/json
skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

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

attributesArray of objects

Liste der Attribute.

Beispiel: [{"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"}}]}]
attributes[].​external_idstring[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$erforderlich

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

Beispiel: "attribute_external_id"
attributes[].​nameobject

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

Beispiel: {"en":"Attribute name","de":"Attributname"}
attributes[].​name.​property name*stringzusätzliche Eigenschaft
attributes[].​valuesArray of objectserforderlich
Beispiel: [{"external_id":"value_1","name":{"en":"value 1","de":"wert 1"}},{"external_id":"value_2","name":{"en":"value 2","de":"wert 2"}}]
attributes[].​values[].​external_idstring[ 1 .. 255 ] characters^[-_.\d\w]+$erforderlich

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

Beispiel: "value_external_id"
attributes[].​values[].​valueobjecterforderlich

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

attributes[].​values[].​value.​property name*stringzusätzliche Eigenschaft
name(object or null)

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

Any of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

name.​enstring or null

Englisch

name.​arstring or null

Arabisch

name.​bgstring or null

Bulgarisch

name.​cnstring or null

Chinesisch (vereinfacht)

name.​csstring or null

Tschechisch

name.​destring or null

Deutsch

name.​esstring or null

Spanisch (Spanien)

name.​frstring or null

Französisch

name.​hestring or null

Hebräisch

name.​itstring or null

Italienisch

name.​jastring or null

Japanisch

name.​kostring or null

Koreanisch

name.​plstring or null

Polnisch

name.​ptstring or null

Portugiesisch

name.​rostring or null

Rumänisch

name.​rustring or null

Russisch

name.​thstring or null

Thai

name.​trstring or null

Türkisch

name.​twstring or null

Chinesisch (traditionell)

name.​vistring or null

Vietnamesisch

name.​kmstring or null

Khmer

name.​idstring or null

Indonesisch

name.​lostring or null

Laotisch

name.​mystring or null

Birmanisch

name.​phstring or null

Filipino

name.​nestring or null

Nepalesisch

description(object or null)

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

Any of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

description.​enstring or null

Englisch

description.​arstring or null

Arabisch

description.​bgstring or null

Bulgarisch

description.​cnstring or null

Chinesisch (vereinfacht)

description.​csstring or null

Tschechisch

description.​destring or null

Deutsch

description.​esstring or null

Spanisch (Spanien)

description.​frstring or null

Französisch

description.​hestring or null

Hebräisch

description.​itstring or null

Italienisch

description.​jastring or null

Japanisch

description.​kostring or null

Koreanisch

description.​plstring or null

Polnisch

description.​ptstring or null

Portugiesisch

description.​rostring or null

Rumänisch

description.​rustring or null

Russisch

description.​thstring or null

Thai

description.​trstring or null

Türkisch

description.​twstring or null

Chinesisch (traditionell)

description.​vistring or null

Vietnamesisch

description.​kmstring or null

Khmer

description.​idstring or null

Indonesisch

description.​lostring or null

Laotisch

description.​mystring or null

Birmanisch

description.​phstring or null

Filipino

description.​nestring or null

Nepalesisch

long_description(object or null)

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

Any of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

long_description.​enstring or null

Englisch

long_description.​arstring or null

Arabisch

long_description.​bgstring or null

Bulgarisch

long_description.​cnstring or null

Chinesisch (vereinfacht)

long_description.​csstring or null

Tschechisch

long_description.​destring or null

Deutsch

long_description.​esstring or null

Spanisch (Spanien)

long_description.​frstring or null

Französisch

long_description.​hestring or null

Hebräisch

long_description.​itstring or null

Italienisch

long_description.​jastring or null

Japanisch

long_description.​kostring or null

Koreanisch

long_description.​plstring or null

Polnisch

long_description.​ptstring or null

Portugiesisch

long_description.​rostring or null

Rumänisch

long_description.​rustring or null

Russisch

long_description.​thstring or null

Thai

long_description.​trstring or null

Türkisch

long_description.​twstring or null

Chinesisch (traditionell)

long_description.​vistring or null

Vietnamesisch

long_description.​kmstring or null

Khmer

long_description.​idstring or null

Indonesisch

long_description.​lostring or null

Laotisch

long_description.​mystring or null

Birmanisch

long_description.​phstring or null

Filipino

long_description.​nestring or null

Nepalesisch

groupsArray of objects

Gruppen, zu denen der Artikel gehört.

groups[].​external_idstring
Beispiel: "horror"
groups[].​nameobject

Name des Artikels. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}" und der Wert ein String ist.

Standard {"en":"Horror"}
Beispiel: {"en":"Horror","de":"Horror"}
groups[].​name.​property name*stringzusätzliche Eigenschaft
media_listArray of objects

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

media_list[].​typestring

Medieninhaltstyp: image/video.

Enum"image""video"
Beispiel: "image"
media_list[].​urlstring

Ressourcendatei.

Beispiel: "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
typestring

Artikeltyp: virtual_good/virtual_currency/bundle/physical_good/unit.

pricesArray of objects
Beispiel: [{"currency":"USD","amount":10.5,"is_default":true,"is_enabled":true}]
prices[].​amountnumber> 0erforderlich

Betrag.

Beispiel: 10.5
prices[].​currencystringerforderlich

Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

Beispiel: "USD"
prices[].​country_isostring

Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern finden Sie in der Dokumentation.
Beispiel: country=US

Beispiel: "US"
prices[].​is_defaultboolean
Standard false
Beispiel: true
prices[].​is_enabledboolean
Standard true
Beispiel: true
vc_pricesArray of objects
Beispiel: [{"sku":"com.xsolla.gold_1","amount":10,"is_default":true}]
vc_prices[].​skustringerforderlich

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

Beispiel: "com.xsolla.gold_1"
vc_prices[].​amountnumber> 0erforderlich

Betrag.

Beispiel: 10
vc_prices[].​is_defaultboolean
Standard false
Beispiel: true
image_urlstring

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.

is_freeboolean

Ob der Artikel kostenlos ist.

is_paid_randomized_rewardboolean

Ob der Artikel eine kostenpflichtige zufällige Belohnung ist, z. B. eine Lootbox.

orderinteger

Reihenfolge, in der die Artikel im Katalog angezeigt werden. Je höher der Wert, desto weiter unten erscheint der Artikel in der Liste. Bei gleichen Werten werden die Artikel nach Erstellungsdatum sortiert, wobei neuere Artikel weiter oben angezeigt werden.

is_enabledboolean

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.

is_show_in_storeboolean

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.

regionsArray of objects

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.

regions[].​idinteger>= 1

Regions-ID innerhalb des Projekts.

Ausführliche Informationen finden Sie in der Dokumentation zu den regionalen Verkaufsbeschränkungen sowie in den API-Aufrufen zur Regionsverwaltung.

Beispiel: 1
limitsobject or null

Artikelbeschränkungen.

limits.​per_userobject or null

Artikelbeschränkung für einen separaten Nutzer.

limits.​per_user.​totalinteger

Höchstzahl von Artikeln, die ein einzelner Nutzer kaufen kann.

limits.​per_user.​limit_exceeded_visibilitystring

Steuert die Sichtbarkeit des Artikels im Katalog nach Erreichen des Kauflimits, und zwar bis das Limit das nächste Mal zurückgesetzt wird.

Gilt für Artikel, bei denen im Array recurrent_schedule Limits konfiguriert sind, die regelmäßig zurückgesetzt werden.

Wenn 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.

Mögliche Wert:

  • show – Der Artikel wird in API-Aufrufen zur Katalogabfrage zurückgegeben, auch wenn das Kauflimit bereits erreicht wurde. Bei clientseitigen API-Aufrufen zur Katalogabfrage wird der Artikel nach Erreichen des Limits mit dem Flag can_be_bought: false zurückgegeben. Das Datum, an dem das Limit das nächste Mal zurückgesetzt wird, wird im Parameter reset_next_date zurückgegeben.
  • hide – nachdem das Kauflimit erreicht wurde, wird der Artikel bei API-Aufrufen zur Katalogabfrage nicht mehr zurückgegeben, bis das Limit zurückgesetzt wird.
Enum"show""hide"
limits.​per_itemobject or null

Globale Artikelbeschränkung.

limits.​per_item.​totalinteger

Höchstzahl von Artikeln, die alle Nutzer kaufen können.

limits.​per_item.​availableinteger

Verbleibende Anzahl von Artikeln, die alle Nutzer kaufen können.

limits.​per_item.​reservedinteger
limits.​per_item.​soldinteger
limits.​recurrent_scheduleobject or null

Aktualisierungszeitraum begrenzen.

limits.​recurrent_schedule.​per_userobject

Aktualisierungszeitraum für das Nutzerlimit.

One of:

Tägliche Aktualisierung der Nutzerlimits.

limits.​recurrent_schedule.​per_user.​interval_typestring

Typ des wiederkehrenden Aktualisierungszeitraums.

Wert"daily"
limits.​recurrent_schedule.​per_user.​timestring(full-time)

Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).

Beispiel: "11:00:00+03:00"
limits.​recurrent_schedule.​per_user.​reset_next_dateinteger

Datum und Uhrzeit der Limitaktualisierung (Unix-Zeitstempel).

Beispiel: 1677553200
limits.​recurrent_schedule.​per_user.​displayable_reset_start_datestring(date-time)

Datum und Uhrzeit der ersten Limitaktualisierung (ISO 8601).

Beispiel: "2023-02-28T11:00:00+08:00"
limits.​recurrent_schedule.​per_user.​displayable_reset_next_datestring(date-time)

Datum und Uhrzeit, zu der die Limits zurückgesetzt werden sollen (ISO 8601).

Beispiel: "2023-02-28T11:00:00+08:00"
periodsArray of objects

Artikelangebotszeitraum.

periods[].​date_fromstring or null(date-time)

Datum, an dem der angegebene Artikel zum Verkauf angeboten wird.

Beispiel: "2020-08-11T10:00:00+03:00"
periods[].​date_untilstring or null(date-time)

Datum, an dem der angegebene Artikel nicht mehr zum Verkauf angeboten wird. Möglich ist: null.

Beispiel: "2020-08-11T20:00:00+03:00"
custom_attributesobject(json)

Ein JSON-Objekt mit Artikelattributen und ‑werten.

Antwort
application/json
{
  "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": [
    { … }
  ],
  "is_free": false,
  "is_paid_randomized_reward": true,
  "order": 1,
  "groups": [
    { … },
    { … }
  ],
  "prices": [
    { … }
  ],
  "media_list": [],
  "vc_prices": [],
  "is_enabled": true,
  "is_show_in_store": true,
  "regions": [],
  "limits": {
    "per_user": { … },
    "per_item": null,
    "recurrent_schedule": { … }
  },
  "periods": [
    { … }
  ],
  "custom_attributes": {
    "purchased": 0,
    "attr": "value"
  }
}

Virtuellen Gegenstand aktualisierenServer-sideAdmin

Anfrage

Aktualisiert einen virtuellen Gegenstand.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID. Dieser Parameter wird im Kundenportal 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/<merchant_id>/projects/<project_id>.

Beispiel: 44056
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
Bodyapplication/json
Hinweis

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.

Hinweis

Übermitteln Sie alle Artikelparameter, auch diejenigen, die nicht aktualisiert werden müssen. In der Anfrage weggelassene Parameter werden entfernt.

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

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

name(object or null)

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

Any of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

name.​enstring or null

Englisch

name.​arstring or null

Arabisch

name.​bgstring or null

Bulgarisch

name.​cnstring or null

Chinesisch (vereinfacht)

name.​csstring or null

Tschechisch

name.​destring or null

Deutsch

name.​esstring or null

Spanisch (Spanien)

name.​frstring or null

Französisch

name.​hestring or null

Hebräisch

name.​itstring or null

Italienisch

name.​jastring or null

Japanisch

name.​kostring or null

Koreanisch

name.​plstring or null

Polnisch

name.​ptstring or null

Portugiesisch

name.​rostring or null

Rumänisch

name.​rustring or null

Russisch

name.​thstring or null

Thai

name.​trstring or null

Türkisch

name.​twstring or null

Chinesisch (traditionell)

name.​vistring or null

Vietnamesisch

name.​kmstring or null

Khmer

name.​idstring or null

Indonesisch

name.​lostring or null

Laotisch

name.​mystring or null

Birmanisch

name.​phstring or null

Filipino

name.​nestring or null

Nepalesisch

description(object or null)

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

Any of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

description.​enstring or null

Englisch

description.​arstring or null

Arabisch

description.​bgstring or null

Bulgarisch

description.​cnstring or null

Chinesisch (vereinfacht)

description.​csstring or null

Tschechisch

description.​destring or null

Deutsch

description.​esstring or null

Spanisch (Spanien)

description.​frstring or null

Französisch

description.​hestring or null

Hebräisch

description.​itstring or null

Italienisch

description.​jastring or null

Japanisch

description.​kostring or null

Koreanisch

description.​plstring or null

Polnisch

description.​ptstring or null

Portugiesisch

description.​rostring or null

Rumänisch

description.​rustring or null

Russisch

description.​thstring or null

Thai

description.​trstring or null

Türkisch

description.​twstring or null

Chinesisch (traditionell)

description.​vistring or null

Vietnamesisch

description.​kmstring or null

Khmer

description.​idstring or null

Indonesisch

description.​lostring or null

Laotisch

description.​mystring or null

Birmanisch

description.​phstring or null

Filipino

description.​nestring or null

Nepalesisch

long_description(object or null)

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

Any of:

Sprachencodes bestehend aus zwei Kleinbuchstaben.

long_description.​enstring or null

Englisch

long_description.​arstring or null

Arabisch

long_description.​bgstring or null

Bulgarisch

long_description.​cnstring or null

Chinesisch (vereinfacht)

long_description.​csstring or null

Tschechisch

long_description.​destring or null

Deutsch

long_description.​esstring or null

Spanisch (Spanien)

long_description.​frstring or null

Französisch

long_description.​hestring or null

Hebräisch

long_description.​itstring or null

Italienisch

long_description.​jastring or null

Japanisch

long_description.​kostring or null

Koreanisch

long_description.​plstring or null

Polnisch

long_description.​ptstring or null

Portugiesisch

long_description.​rostring or null

Rumänisch

long_description.​rustring or null

Russisch

long_description.​thstring or null

Thai

long_description.​trstring or null

Türkisch

long_description.​twstring or null

Chinesisch (traditionell)

long_description.​vistring or null

Vietnamesisch

long_description.​kmstring or null

Khmer

long_description.​idstring or null

Indonesisch

long_description.​lostring or null

Laotisch

long_description.​mystring or null

Birmanisch

long_description.​phstring or null

Filipino

long_description.​nestring or null

Nepalesisch

image_urlstring

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.

media_listArray of objects

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

media_list[].​typestring

Medieninhaltstyp: image/video.

Enum"image""video"
Beispiel: "image"
media_list[].​urlstring

Ressourcendatei.

Beispiel: "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"
groupsArray of strings

Liste der externen Gruppen-IDs, zu denen der Artikel gehört.

Beispiel: ["horror", "action"]

attributesArray of objects<= 20 items

Liste der Attribute.

Achtung: Sie können für den Artikel maximal 20 Attribute angeben. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.
attributes[].​external_idstring[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$erforderlich

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

attributes[].​nameobject

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

attributes[].​name.​property name*stringzusätzliche Eigenschaft
attributes[].​valuesArray of objectserforderlich
Achtung: Sie können für jedes Attribut maximal 6 Werte erstellen. Jeder Versuch, das Limit zu überschreiten, führt zu einem Fehler.
Beispiel: [{"external_id":"strategy","value":{"en":"Strategy","de":"Strategie"}},{"external_id":"action","value":{"en":"Action","de":"Aktion"}}]
attributes[].​values[].​external_idstring[ 1 .. 255 ] characters^[-_.\d\w]+$erforderlich

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

Beispiel: "value_external_id"
attributes[].​values[].​valueobjecterforderlich

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

attributes[].​values[].​value.​property name*stringzusätzliche Eigenschaft
pricesArray of objects
Beispiel: [{"currency":"USD","amount":10.5,"is_default":true,"is_enabled":true}]
prices[].​amountnumber> 0erforderlich

Betrag.

Beispiel: 10.5
prices[].​currencystringerforderlich

Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

Beispiel: "USD"
prices[].​country_isostring

Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern finden Sie in der Dokumentation.
Beispiel: country=US

Beispiel: "US"
prices[].​is_defaultboolean
Standard false
Beispiel: true
prices[].​is_enabledboolean
Standard true
Beispiel: true
vc_pricesArray of objects or null

Array der Preisangaben in virtueller Währung.

Beispiel: [{"sku":"com.xsolla.gold_1","amount":10,"is_default":true,"is_enabled":true}]
vc_prices[].​skustringerforderlich

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

Beispiel: "com.xsolla.gold_1"
vc_prices[].​amountintegererforderlich

Artikelpreis in virtueller Währung.

Beispiel: 10
vc_prices[].​is_defaultbooleanerforderlich

Ob es sich um den Standardpreis in virtueller Währung handelt.

Standard false
Beispiel: true
vc_prices[].​is_enabledbooleanerforderlich

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.

Standard true
Beispiel: true
is_enabledboolean

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.

is_show_in_storeboolean

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.

is_freeboolean

Ob der Artikel kostenlos ist.

is_paid_randomized_rewardboolean

Ob der Artikel eine kostenpflichtige zufällige Belohnung ist, z. B. eine Lootbox.

orderinteger

Reihenfolge, in der die Artikel im Katalog angezeigt werden. Je höher der Wert, desto weiter unten erscheint der Artikel in der Liste. Bei gleichen Werten werden die Artikel nach Erstellungsdatum sortiert, wobei neuere Artikel weiter oben angezeigt werden.

regionsArray of objects

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.

regions[].​idinteger>= 1

Regions-ID innerhalb des Projekts.

Ausführliche Informationen finden Sie in der Dokumentation zu den regionalen Verkaufsbeschränkungen sowie in den API-Aufrufen zur Regionsverwaltung.

Beispiel: 1
limitsobject

Artikelbeschränkungen.

limits.​per_usernull or integer or object

Artikelbeschränkung für einen separaten Nutzer.

Any of:

Artikelbeschränkung für einen separaten Nutzer.

null
limits.​per_iteminteger or null

Globale Artikelbeschränkung.

limits.​recurrent_scheduleobject or null

Aktualisierungszeitraum begrenzen.

limits.​recurrent_schedule.​per_userobject

Das Kauflimit wird gemäß dem in Stunden angegebenen Zeitintervall zurückgesetzt.

One of:

Das Kauflimit wird gemäß dem in Stunden angegebenen Zeitintervall zurückgesetzt.

limits.​recurrent_schedule.​per_user.​interval_typestringerforderlich

Wiederkehrender Aktualisierungszeitraum.

Wert"daily"
limits.​recurrent_schedule.​per_user.​timestring((0[0-9]|1[0-9]|2[0-3]):00:00)(\+|-)(0[0-9]|1...erforderlich

Zeitpunkt der Limitaktualisierung in der gewünschten Zeitzone (auf Stunden gerundet).

Beispiel: "02:00:00+03:00"
periodsArray of objects or null

Artikelangebotszeitraum.

periods[].​date_fromstring(date-time)

Datum, an dem der angegebene Artikel zum Verkauf angeboten wird.

Beispiel: "2020-08-11T10:00:00+03:00"
periods[].​date_untilstring or null(date-time)

Datum, an dem der angegebene Artikel nicht mehr zum Verkauf angeboten wird. Möglich ist: null.

Beispiel: "2020-08-11T20:00:00+03:00"
custom_attributesobject(json)<= 500 characters

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

curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/virtual_items/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "sku": "booster_mega_1",
    "name": {
      "en": "Mega Booster"
    },
    "description": {
      "en": "Temporarily doubles the experience points earned in battle."
    }
  }'

Antworten

Virtueller Gegenstand wurde erfolgreich aktualisiert.

Body
Antwort
Kein Inhalt

Virtuellen Gegenstand löschenServer-sideAdmin

Anfrage

Löscht einen virtuellen Gegenstand.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID. Dieser Parameter wird im Kundenportal 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/<merchant_id>/projects/<project_id>.

Beispiel: 44056
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/virtual_items/sku/booster_mega_1

Antworten

Virtueller Gegenstand wurde erfolgreich gelöscht.

Body
Antwort
Kein Inhalt

Katalog

Operationen

Virtuelle Bezahlung

Operationen

Übersicht

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, über den Shop oder über ein Widget verkaufen. Außerdem können Sie regionale Beschränkungen konfigurieren und so den Verkauf von Spielschlüsseln auf bestimmte Ländern beschränken. Ausführliche Informationen finden Sie im Abschnitt Spielschlüsselpakete.

Fü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, Kaufbeschränkungen oder Berechtigungssystem. Ausführliche Informationen finden Sie im Abschnitt So richten Sie die Authentifizierung beim Verkauf von Spielschlüsseln ein.

Ablauf beim Verkauf von Spielschlüsseln:

  1. Erstellen Sie ein Spiel mit dem API-Aufruf Spiel erstellen.
  2. Konfigurieren Sie regionale Beschränkungen.
  3. Laden Sie Spielschlüssel mithilfe des API-Aufrufs Codes hochladen in ein Spielschlüsselpaket hoch, um sie zum Kauf bereitzustellen.
  4. Zeigen Sie den Spielekatalog mitsamt den Preisen für die Region des Nutzers mithilfe des API-Aufrufs Spieleliste abrufen an.
  5. Legen Sie eine Bestellung an. Verwenden Sie bei einem Schnellkauf den API-Aufruf Bestellung mit allen Artikeln aus dem aktuellen Warenkorb anlegen und übermitteln Sie dabei die SKU des Spielschlüssels. In der Antwort wird ein Token zum Öffnen des Zahlungsportals zurückgegeben.
  6. Implementieren Sie das Öffnen des Zahlungsportals, damit die Bestellung bezahlt werden kann.

Damit 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. Die Schlüssel werden an die E-Mail-Adresse gesendet, die der Nutzer beim Bezahlvorgang angegeben hat, und der Bestellstatus wechselt in done.

Spielschlüssel

Katalog

Operationen

Berechtigung

Operationen

Administrator

Operationen

Übersicht

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.

Verwenden Sie die folgenden Gruppen von API-Aufrufen, um mit Bundles zu arbeiten:

  • Mit den API-Aufrufen aus dem Unterabschnitt Verwaltung können Sie Bundles erstellen, aktualisieren, löschen und deren Sichtbarkeit steuern.
  • Mit den API-Aufrufen aus dem Unterabschnitt Katalog können Sie Bundles abrufen.

Kauflimits lassen sich beim Erstellen oder Aktualisieren eines Bundles über das limits-Objekt konfigurieren. Weitere Informationen finden Sie in der Übersicht unter Limits. Sie können zudem regionale Beschränkungen festlegen und so den Verkauf von Artikeln auf bestimmte Länder beschränken.

Hinweis

Ausführliche Informationen zur Konfiguration von Bundles finden Sie im Abschnitt Bundles.

Bundle verwalten (Szenario):

  1. Erstellen Sie ein Bundle mithilfe des API-Aufrufs Bundle erstellen. Verwenden Sie den API-Aufruf Bundle abrufen, um das erstellte Bundle zu überprüfen. Mit dem API-Aufruf Liste der Bundles abrufen können Sie alle Bundles im Projekt abrufen.
  2. Verwenden Sie bei Bedarf den API-Aufruf Bundle aktualisieren, um den Bundle-Inhalt oder die ‑Einstellungen zu ändern.
  3. Implementieren Sie die Logik, gemäß der Bundles in Ihrem Storefront angezeigt werden, mithilfe des API-Aufrufs Liste der Bundles abrufen, Angegebenes Bundle abrufen oder Liste der Bundles anhand der angegebenen Gruppe abrufen.
  4. Legen Sie eine Berstellung mit einem der API-Aufrufe aus dem Abschnitt Warenkorb und Zahlung an. Bei einem Schnellkauf können Sie beispielsweise den API-Aufruf Bestellung mit angegebenem Artikel anlegen verwenden und dabei die Bundle-SKU übermitteln. In der Antwort wird ein Token zum Öffnen des Zahlungsportals zurückgegeben.
  5. Implementieren Sie das Öffnen des Zahlungsportals, damit die Bestellung bezahlt werden kann.
  6. Richten Sie das Bestellstatus-Tracking ein, beispielsweise mithilfe von Webhooks, um zeitnah Daten zu erfolgreich bezahlten Artikeln zu erhalten und diese dem Nutzer zu übertragen.

Bundle verwalten (Szenario)

Administrator

Operationen

Katalog

Operationen

Übersicht

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 einlösen.

Der Warenkorb wird aufseiten von Xsolla gespeichert. Ob der Warenkorb sitzungsübergreifend gespeichert wird, hängt davon ab, ob der Nutzer autorisiert ist:

  • 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.

  • Bei nicht autorisierten Nutzern 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.

Sie können den Warenkorb auf zwei Arten identifizieren: automatisch anhand des JWT des Nutzers oder anhand der Warenkorb-ID (cart_id).

Der Warenkorb lässt sich sowohl clientseitig als auch serverseitig verwalten.

Serverseitig 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:

  • den aktuellen Warenkorb des Nutzers oder einen Warenkorb anhand einer ID abrufen
  • den Warenkorb befüllen
  • Artikel im Warenkorb aktualisieren
  • Artikel aus dem Warenkorb löschen

Um Artikel aus dem Warenkorb zu kaufen, werden client- und serverseitige Aufrufe zur Bestellanlegung verwendet.

Die 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.

Nach erfolgreicher Zahlung wird der Warenkorb nicht automatisch geleert. Um den Warenkorb zu leeren, müsse Sie die folgenden clientseitigen API-Aufrufe verwenden:

Anwendungsszenario für den Warenkorb:

  1. Implementieren Sie eine Shopoberfläche, auf der der Nutzer Artikel auswählen kann.

  2. 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. Im Array "items" müssen Sie die SKUs und die gewünschte Stückzahl des jeweiligen Artikels übermitteln.

  3. Implementieren Sie die Warenkorbansicht. Wenn der Nutzer zum Warenkorb navigiert, müssen Sie den Warenkorbinhalt mithilfe des Aufrufs Warenkorb des aktuellen Benutzers abrufen anzeigen. In der Antwort werden Informationen zum finalen Preis der Artikel (einschließlich Rabatten und angewendeten Werbeaktionen) zurückgegeben.

  4. 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 verwenden. In der Antwort ist ein Token zum Öffnen des Zahlungsportals enthalten.

  5. Richten Sie das Bestellstatus-Tracking ein, beispielsweise mithilfe von Webhooks, um zeitnah Daten zu erfolgreich bezahlten Artikeln zu erhalten und diese dem Nutzer zu übertragen.

Hinweis

Wie Sie den Verkauf von Artikeln im Spiel und online implementieren, erfahren Sie im Integrationsleitfaden.

Warenkorb und Bezahlvorgang

Lebenszyklus von Bestellungen

Den Lebenszyklus von Bestellungen zu verstehen, hilft Ihnen dabei, Bestellungen nachzuverfolgen und die Logik nach dem Kauf (z. B. die Lieferung der Artikel) korrekt umzusetzen.

Der Auftrag durchläuft die folgenden Status:

StatusBeschreibungHinweise
newDie Bestellung wurde angelegt. Das System wartet auf die Zahlungsbestätigung.Erläuterungen zum Transaktionsstatus finden Sie in der Pay-Station-API-Dokumentation.
paidBestellung wurde bezahlt (die Transaktion wurde in den Status done versetzt), und der Artikel kann dem Nutzer gewährt werden. Die Bestellung verbleibt im Status new, bis die Zahlung bestätigt wurd.
doneArtikel wurde dem Nutzer gewährt. —
canceledDie Zahlung wurder erstattet. Die Bestellung wechselt in diesen Status, sobald sich der Transaktionsstatus in refunded ändert.
expiredWird 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. Sollte ein Nutzer versuchen, eine abgelaufene Bestellung zu bezahlen, wird im Zahlungsportal der Fehlercode 2002 angezeigt, und die Zahlung schlägt fehl.

Lebenszyklus von Bestellungen

Hinweis

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.

Warenkorb (clientseitig)

Mit den Aufrufen aus diesem Abschnitt können Sie den Warenkorb clientseitig verwalten.

Operationen

Warenkorb (serverseitig)

Mit den Aufrufen aus diesem Abschnitt können Sie den Warenkorb serverseitig verwalten.

Operationen

Zahlung (clientseitig)

Mit den Aufrufen aus diesem Abschnitt können Sie einen Zahlungstoken clientseitig erstellen.

Operationen

Zahlung (serverseitig)

Mit den Aufrufen aus diesem Abschnitt können Sie einen Zahlungstoken serverseitig erstellen.

Operationen

Bestellung

Mit den Aufrufen aus diesem Abschnitt können Sie Bestellinformationen abrufen

Operationen

Kostenlose Artikel

Use calls from this section to grant free items to users.

Operationen

Übersicht

Mithilfe von Kauflimits können Sie begrenzen, wie viele Artikel ein einzelner Nutzer oder alle Nutzer erwerben können. Zudem können Sie festlegen, dass das Limit nach einer bestimmten Zeitspanne zurückgesetzt wird.

Limits werden aufseiten von Xsolla gespeichert und auf der Ebene der einzelnen Artikel im Kundenportal oder über das Objekt limits in den folgenden API-Aufrufen konfiguriert:

Informationen zu den Limits werden in den folgenden API-Aufrufen zum Abrufen des Artikelkatalogs im Objekt items.limits zurückgegeben:

Mit den API-Aufrufen im Unterabschnitt Verwaltung der Gruppe Limits können Sie den aktuellen Status der Limits abrufen und diese für einen bestimmten Nutzer aktualisieren – beispielsweise den Zähler nach Abschluss einer Quest zurücksetzen oder die verbleibende Menge manuell anpassen.

Hinweis

Ausführliche Informationen zur Konfiguration von Limits im Katalog finden Sie im Abschnitt Kauflimits für Artikel.

Verwaltung

Operationen

Administrator

Operationen

Vorbestellungen

Operationen

Händler

Operationen

Katalog

Diese API ermöglicht es, jede Art von verkäuflichen oder bestimmten Artikeln zu erhalten.

Operationen

Gängige Regionen

Mithilfe regionaler Verkaufsbeschränkungen können Sie die Verfügbarkeit von Artikeln in bestimmten Ländern oder Ländergruppen steuern. So können Sie beispielsweise ein Spiel aufgrund von Lizenzbeschränkungen nur in bestimmten Ländern verkaufen.

Die Beschränkungen werden über Regionen definiert. Jede Region fasst ein oder mehrere Länder unter einer einzigen Kennung (region_id) zusammen. Sie können einen Artikel einer oder mehreren Regionen zuordnen.

Die Verfügbarkeit eines Artikels wird wie folgt bestimmt:

  • Wenn für einen Artikel keine Regionen angegeben sind, ist der Artikel in allen Ländern erhältlich.
  • Wenn für einen Artikel Regionen angegeben sind und das Land des Nutzers zu einer dieser Regionen gehört, ist der Artikel für diesen Nutzer verfügbar.
  • Wenn für einen Artikel Regionen angegeben sind und das Land des Nutzers zu keiner dieser Regionen gehört, ist der Artikel für diesen Nutzer nicht verfügbar.

Das Land des Nutzers wird im Parameter country übermittelt, wenn der Katalog über API-Aufrufe aus dem Unterbereich Katalog angefordert wird. Wird der Parameter nicht übermittelt, wird das Land anhand der IP-Adresse des Nutzers ermittelt.

Das Land des Nutzers wird zweimal mit den Regionen des Artikels abgeglichen: beim Anfordern des Katalogs und beim Anlegen einer Bestellung. Nicht verfügbare Artikel werden nicht in die Katalogantwort aufgenommen, und eine Bestellung mit einem solchen Artikel wird nicht angelegt.

Mit API-Aufrufen aus dem Unterabschnitt Gängige Regionen können Sie Regionen erstellen, aktualisieren und löschen.

Einrichtung regionaler Verkaufsbeschränkungen (Ablauf):

  1. Erstellen Sie eine Region mithilfe des API-Aufrufs Region erstellen, geben Sie dabei die Liste der Länder an. In der Antwort ist eine region_id enthalten, die im nächsten Schritt benötigt wird.
  2. Verknüpfen Sie einen virtuellen Gegenstand mit der Region, indem Sie beim Erstellen oder Aktualisieren des Artikels die region_id im regions-Array übermitteln.
  3. Zeigen Sie dem Nutzer den Katalog mithilfe von API-Aufrufen aus dem Unterabschnitt Katalog an, beispielsweise mit dem API-Aufruf Liste virtueller Gegenstände abrufen. Das Land des Nutzers wird anhand des Parameters country ermittelt oder, falls dieser nicht angegeben ist, anhand der IP-Adresse des Nutzers. Artikel, die im Land des Nutzers nicht verfügbar sind, fehlen in der Katalogantwort.
  4. Wenn der Nutzer zur Bezahlung eines Artikels oder des Warenkorbs übergeht, muss eine Bestellung angelegt werden:

In der Antwort ist ein Token zum Öffnen des Zahlungsportals enthalten.

Hinweis

Xsolla 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.

  1. Implementieren Sie das Öffnen des Zahlungsportals, damit die Bestellung bezahlt werden kann.

Gängige Regionen

Operationen

Webhooks

Operationen

Administrator

Operationen

Administrator

Operationen

Katalog

Operationen