Zum Inhalt springen
/
Bundle aktualisieren

Shop Builder 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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/shop-builder/
https://store.xsolla.com/api/

Verwaltung

Operationen

Personalisierter Katalog

Diese API ermöglicht es, Regeln für Benutzerattribute festzulegen. Wenn der Nutzer alle Bedingungen einer konkreten Regel erfüllt, werden personalisierte Artikel angezeigt.

Für personalisierte Werbeaktionen siehe Abschnitt Werbeaktionen.

Um Attribute vor einem Kauf zu übermitteln, können Sie die Xsolla Login API verwenden oder die Attribute in der Eigenschaft user.attributes übermitteln, während Sie den Token mit der Pay Station API generieren.

Operationen

Verwaltung

Operationen

Bundle abrufenServer-sideAdmin

Anfrage

Ruft das Bundle 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.

Beispiel: 44056
skustringerforderlich

Bundle-SKU.

Beispiel: kg_1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/items/bundle/sku/kg_1

Antworten

Das angegebene Bundle wurde erfolgreich empfangen.

Bodyapplication/json
attributesArray of objects(Bundles_admin-attributes)

Liste der Attribute.

Beispiel: [{"external_id":"attribute_external_id","name":{"de":"Attributname","en":"Attribute name"},"values":[{"external_id":"value_1","name":{"de":"wert 1","en":"value 1"}},{"external_id":"value_2","name":{"de":"wert 2","en":"value 2"}}]}]
bundle_typestring(bundle_type)

Bündeltyp. Wird zurückgegeben, wenn der Artikeltyp ein Bündel ist.

Enum"standard""virtual_currency_package""partner_side_content"
contentArray of objects(Bundles_admin_content_response)
custom_attributesobject(json)(item-custom-attributes-response)

Ein JSON-Objekt mit Artikelattributen und ‑werten.

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

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

One of:

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.

groupsArray of objects(Bundles_groups_response)

Gruppen, zu denen der Artikel gehört.

Standard []
Beispiel: [{"external_id":"horror","name":{"en":"Horror"}}]
image_urlstring or null(Bundles_image_url)

Bild-URL.

Beispiel: "https://image.example.com"
is_enabledboolean(Bundles_is_enabled)

Ist diese Option deaktiviert, kann der Artikel weder gefunden noch gekauft werden.

Standard true
Beispiel: true
is_freeboolean(value-is_free)

Ist true eingestellt, ist der Artikel kostenlos.

Standard false
Beispiel: false
is_show_in_storeboolean(Bundles_is_show_in_store)

Artikel ist käuflich erhältlich.

Standard false
Beispiel: true
item_idinteger(Bundles_item_id)[ 1 .. 255 ] characters

Interne eindeutige Artikel-ID.

Beispiel: 1
limitsobject or null(admin-item-limit-response)

Artikelbeschränkungen.

long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

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:

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.

media_listArray of objects or null

Zusätzliche Medieninhalte des Bundles.

Beispiel: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)

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

One of:

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.

orderinteger(Bundles_order)

Priorität der Bundle-Reihenfolge in der Liste.

Standard 1
Beispiel: 1
periodsArray of objects(item-periods-response)

Artikelangebotszeitraum.

pricesArray of objects(Bundles_prices)

Preise in echten Währungen.

regionsArray of objects(Bundles_admin-regions)
skustring(Bundles_sku)[ 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.

Beispiel: "bundle_1"
total_content_priceobject or null(Bundles_total_content_price)

Preissumme der einzelnen Bundle-Inhalte.

typestring(Bundles_type)

Artikeltyp.

Beispiel: "bundle"
virtual_pricesArray of objects(Bundles_admin-response-virtual_price)
Antwort
application/json
{
  "attributes": [],
  "bundle_type": "standard",
  "content": [
    { … },
    { … },
    { … }
  ],
  "custom_attributes": {
    "purchased": 0,
    "type": "lootbox"
  },
  "description": {
    "en": "Empire bundle with items"
  },
  "groups": [
    { … }
  ],
  "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png",
  "is_enabled": true,
  "is_free": false,
  "is_show_in_store": true,
  "item_id": 610316,
  "limits": {
    "per_item": null,
    "per_user": { … },
    "recurrent_schedule": null
  },
  "long_description": {
    "en": "Empire bundle with some goods"
  },
  "media_list": [],
  "name": {
    "en": "Empire bundle"
  },
  "order": 1,
  "periods": [
    { … }
  ],
  "prices": [],
  "regions": [],
  "sku": "com.xsolla.EmpireBundle_1",
  "type": "bundle",
  "virtual_prices": [
    { … }
  ]
}

Bundle aktualisierenServer-sideAdmin

Anfrage

Aktualisiert ein Bundle.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
skustringerforderlich

Bundle-SKU.

Beispiel: kg_1
Bodyapplication/jsonerforderlich

Objekt mit Bundle-Daten.

attributesArray of objects(Bundles_admin-post-put-attributes)<= 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.
bundle_typestring(Bundles_bundle_type)

Bundle-Typ. Durch Angabe von standard erstellen Sie ein Bundle mit Artikeln, wobei die SKUs der im Bundle enthaltenen Artikel anzugeben ist. Durch Angabe von partner_side_content wird ein leeres Bundle erstellt, wobei die Artikel über einen Webhook hinzuzufügen sind. Dieser Typ wird nur für die Katalogpersonalisierung aufseiten des Partners verwendet.

Standard "standard"
Enum"standard""partner_side_content"
Beispiel: "standard"
contentArray of objects(Bundles_admin_content_request)non-empty
Beispiel: [{"quantity":1,"sku":"com.xsolla.kg_1"}]
custom_attributesobject(json)(item-custom-attributes)<= 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.

description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)erforderlich

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

One of:

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.

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.​enstring or null

Englisch

description.​esstring or null

Spanisch (Spanien)

description.​frstring or null

Französisch

description.​hestring or null

Hebräisch

description.​idstring or null

Indonesisch

description.​itstring or null

Italienisch

description.​jastring or null

Japanisch

description.​kmstring or null

Khmer

description.​kostring or null

Koreanisch

description.​lostring or null

Laotisch

description.​mystring or null

Birmanisch

description.​nestring or null

Nepalesisch

description.​phstring or null

Filipino

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

groupsArray of strings(Bundles_groups_request)

Gruppen, zu denen der Artikel gehört.

Hinweis: Der String-Wert bezieht sich auf die Gruppe `external_id`.
Standard []
Beispiel: ["honor"]
image_urlstring or null(Bundles_image_url)

Bild-URL.

Beispiel: "https://image.example.com"
is_enabledboolean(Bundles_is_enabled)

Ist diese Option deaktiviert, kann der Artikel weder gefunden noch gekauft werden.

Standard true
Beispiel: true
is_freeboolean(value-is_free)

Ist true eingestellt, ist der Artikel kostenlos.

Standard false
Beispiel: false
is_show_in_storeboolean(Bundles_is_show_in_store)

Artikel ist käuflich erhältlich.

Standard false
Beispiel: true
limitsobject(bundle-item-limit)

Artikelbeschränkungen.

long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)

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:

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.

media_listArray of objects or null

Zusätzliche Medieninhalte des Bundles.

Beispiel: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)erforderlich

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

One of:

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.

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.​enstring or null

Englisch

name.​esstring or null

Spanisch (Spanien)

name.​frstring or null

Französisch

name.​hestring or null

Hebräisch

name.​idstring or null

Indonesisch

name.​itstring or null

Italienisch

name.​jastring or null

Japanisch

name.​kmstring or null

Khmer

name.​kostring or null

Koreanisch

name.​lostring or null

Laotisch

name.​mystring or null

Birmanisch

name.​nestring or null

Nepalesisch

name.​phstring or null

Filipino

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

orderinteger(Bundles_order)

Priorität der Bundle-Reihenfolge in der Liste.

Standard 1
Beispiel: 1
periodsArray of objects or null(item-periods)

Artikelangebotszeitraum.

pricesArray of objects(Bundles_prices)

Preise in echten Währungen.

regionsArray of objects(Bundles_admin-regions)
skustring(Bundles_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$erforderlich

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

Beispiel: "bundle_1"
vc_pricesArray of objects or null
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/items/bundle/sku/kg_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "attributes": [
      {
        "external_id": "class",
        "name": {
          "en": "Class"
        },
        "values": [
          {
            "external_id": "soldier",
            "value": {
              "en": "Soldier"
            }
          },
          {
            "external_id": "officer",
            "value": {
              "en": "Officer"
            }
          }
        ]
      }
    ],
    "content": [
      {
        "quantity": 1,
        "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"
      }
    ],
    "custom_attributes": {
      "purchased": 0,
      "type": "lootbox"
    },
    "description": {
      "de": "Brustpanzer für Soldaten",
      "en": "Chest of armour for soldiers"
    },
    "groups": [
      "chests"
    ],
    "image_url": "https://picture.bundle-with-many-stuff.png",
    "is_enabled": true,
    "is_free": true,
    "limits": {
      "per_item": null,
      "per_user": null
    },
    "long_description": {
      "de": "Brustpanzer für Soldaten",
      "en": "Chest of armour for soldiers"
    },
    "media_list": [
      {
        "type": "image",
        "url": "https://test.com/image0"
      },
      {
        "type": "image",
        "url": "https://test.com/image1"
      }
    ],
    "name": {
      "de": "Brustpanzer",
      "en": "Chest of armour"
    },
    "order": 1,
    "periods": [
      {
        "date_from": "2020-08-11T10:00:00+03:00",
        "date_until": "2020-08-11T20:00:00+03:00"
      }
    ],
    "prices": [
      {
        "amount": "9.99",
        "currency": "USD",
        "is_default": true,
        "is_enabled": true
      },
      {
        "amount": "9.99",
        "currency": "EUR",
        "is_default": false,
        "is_enabled": true
      }
    ],
    "sku": "com.xsolla.armour_chest_1",
    "vc_prices": []
  }'

Antworten

Bundle wurde erfolgreich aktualisiert.

Body
Antwort
Kein Inhalt

Bundle im Katalog ausblendenServer-sideAdmin

Anfrage

Blendet ein Bundle in einem Katalog aus.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
skustringerforderlich

Bundle-SKU.

Beispiel: kg_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/items/bundle/sku/kg_1/hide

Antworten

Bundle wurde erfolgreich ausgeblendet.

Body
Antwort
Kein Inhalt

Katalog

Operationen

Warenkorb (clientseitig)

Operationen

Warenkorb (serverseitig)

Operationen

Zahlung (clientseitig)

Operationen

Zahlung (serverseitig)

Operationen

Bestellung

Operationen

Kostenlose Artikel

Operationen

Webhooks

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

Operationen

Katalog

Operationen

Berechtigung

Operationen

Verwaltung

Operationen

Allgemeines

Operationen

Gutscheine

Mit dieser API können Sie Gutscheine verwalten.

Operationen

Promocodes

Diese API ermöglicht die Verwaltung von Promocodes.

Operationen

Katalogsonderangebote

Mit dieser API können Sie Katalogsonderangebote verwalten.

Operationen

Rabatte

Mit dieser API können Sie Rabattaktionen verwalten.

Operationen

Boni

Diese API ermöglicht die Verwaltung von Bonusaktionen.

Operationen

Verwaltung

Operationen

Katalog

Operationen

Virtuelle Bezahlung

Operationen

Verwaltung

Operationen

Verwaltung

Operationen

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen