Zum Inhalt springen
/
Liste von Katalogsonderan...

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

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

Katalogsonderangebot deaktivierenServer-sideAdmin

Anfrage

Deaktiviert ein Katalogsonderangebot. Das erstellte Katalogsonderangebot ist standardmäßig deaktiviert. Das Angebot kann erst eingelöst werden, nachdem Sie es aktiviert haben. Verwenden Sie diesen Endpunkt, um eine Gutscheinaktion zu deaktivieren.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
external_idintegererforderlich

Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.

Beispiel: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/unique_catalog_offer/coupon_44056_1/deactivate

Antworten

Katalogsonderangebot wurde erfolgreich deaktiviert.

Antwort
Kein Inhalt

Liste von Katalogsonderangeboten abrufenServer-sideAdmin

Anfrage

Ruft die Liste der Katalogsonderangebote eines Projekts ab.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Abfrage
limitinteger>= 1

Begrenzung der Elementanzahl auf der Seite.

Beispiel: limit=50
offsetinteger>= 0

Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).

Beispiel: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/unique_catalog_offer?limit=50&offset=0'

Antworten

Die Liste der Gutscheine wurde erfolgreich abgerufen.

Bodyapplication/json
active_promotions_countinteger(active_promotions_count)

Anzahl der aktiven Werbeaktionen.

inactive_promotions_countinteger(inactive_promotions_count)

Anzahl der deaktivierten Werbeaktionen.

itemsArray of objects(Promotions_200-get-unique-catalog-offer-promotion-model)
total_promotions_countinteger(total_promotions_count)

Gesamtzahl der Werbeaktionen.

Antwort
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "items": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

Katalogsonderangebot erstellenServer-sideAdmin

Anfrage

Erstellt ein Katalogsonderangebot.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/json
date_endstring or null(date-time)(Promotions_coupon_date_end)

Datum, an dem Ihre Werbeaktion endet. Möglich ist null. Wenn für date_end der Wert null festgelegt ist, läuft die Werbeaktion zeitlich unbegrenzt.

Standard "2020-04-15T18:16:00+05:00"
date_startstring or null(date-time)(Promotions_coupon_date_start)

Datum, an dem Ihre Werbeaktion beginnt.

Standard "2020-04-15T18:16:00+05:00"
external_idstring(Promotions_coupon-external_id)erforderlich

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

Standard "coupon_external_id"
Beispiel: "coupon_external_id"
itemsArray of strings(Promotions_unique_catalog_offer_items)

Eine Liste der Artikel-SKU, die nach Inanspruchnahme des Katalogsonderangebots verfügbar sind.

Beispiel: ["booster_mega_1"]
nameobject(Promotions_coupon_name)erforderlich

Name der Werbeaktion. 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.

Standard {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Beispiel: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*stringzusätzliche Eigenschaft
redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Anzahl der Einlösungen pro Code.

Standard 10
Beispiel: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Begrenzt die Gesamtzahl der Gutscheine.

Standard 10
Beispiel: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Begrenzt, wie oft ein einzelner Nutzer Gutscheine einlösen darf.

Standard 10
Beispiel: 10
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v3/project/44056/admin/unique_catalog_offer \
  -H 'Content-Type: application/json' \
  -d '{
    "date_end": "2020-04-25T18:16:00+05:00",
    "date_start": "2020-04-15T18:16:00+05:00",
    "external_id": "offer_external_id",
    "items": [
      "elven_sword",
      "elven_boots"
    ],
    "name": {
      "de-DE": "Neujahrsangebot",
      "en-US": "New Year Offer"
    },
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Antworten

Katalogsonderangebot wurde erfolgreich erstellt.

Bodyapplication/json
external_idstring(Promotions_coupon-external_id)

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

Standard "coupon_external_id"
Beispiel: "coupon_external_id"
Antwort
application/json
{
  "external_id": "coupon_external_id"
}

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