Zum Inhalt springen
/
Status des Artikelimports...

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

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

Status des Artikelimports abrufenServer-sideAdmin

Anfrage

Ruft Informationen darüber ab, wie weit der Import von Artikeln in das Projekt fortgeschritten ist. Der API-Aufruf ruft Daten zum letzten Import ab, der über die API oder das Kundenportal durchgeführt wurde.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v1/admin/projects/44056/connectors/import_items/import/status

Antworten

Der Importstatus wurde erfolgreich abgerufen.

Bodyapplication/json
date_completedstring

Der Zeitstempel für den Abschluss des Importvorgangs. Datum und Uhrzeit sind in der Zeitzone GMT+3 angegeben. Wenn der Import aufgrund eines Fehlers unterbrochen wurde und keine Artikel importiert wurden, wird ein leerer String zurückgegeben.

Beispiel: "2024-11-19T15:27:31+03:00"
date_createdstring

Der Zeitstempel für die Erstellung des Importvorgangs. Datum und Uhrzeit sind in der Zeitzone GMT+3 angegeben.

Beispiel: "2024-11-19T14:27:31+03:00"
date_updatedstring

Der Zeitstempel für den Zeitpunkt, als der Import aufgrund eines Fehlers unterbrochen wurde. Datum und Uhrzeit sind in der Zeitzone GMT+3 angegeben.

Beispiel: "2024-11-19T15:27:31+03:00"
errorstring

Beschreibung des allgemeinen Importfehlers.

error_codestring

Der Code des allgemeinen Importfehlers.

progressinteger

Der Fortschritt der Importvorgangs in Prozent.

Beispiel: 100
resultobject

Ein Objekt mit Daten zu den Importergebnissen und Importfehlern für bestimmte Artikel-SKU.

Beispiel: {"errors_by_sku":[{"error_code":4055,"error_message":"[0401-4055]: Item default price not set","sku":"com.xsolla.sword_1","type":"virtual_items"},{"error_code":1817,"error_message":"[0410-1817]: SKU can't be empty","sku":"","type":null}],"errors_count":2,"total_entities_count":10}
statusstring

Importstatus.

Enum WertBeschreibung
done

Import war erfolgreich.

error

Aufgrund von Fehlern konnte der Import nicht oder nur teilweise abgeschlossen werden.

initialized

Der Import wurde gestartet.

process

Der Import läuft.

Beispiel: "error"
Antwort
application/json
{
  "date_completed": "2024-11-19T15:27:31+03:00",
  "date_created": "2024-11-19T14:27:31+03:00",
  "date_updated": "2024-11-19T15:27:31+03:00",
  "error": null,
  "error_code": null,
  "progress": 100,
  "result": {
    "errors_by_sku": [ … ],
    "errors_count": 2,
    "total_entities_count": 10
  },
  "status": "error"
}

Artikel aus JSON-Datei importierenServer-sideAdmin

Anfrage

Importiert Artikel aus einer JSON-Datei über die angegebene URL in den Shop. Weitere Informationen zum Import aus einer JSON-Datei finden Sie in der Dokumentation.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/json
connector_external_idstringerforderlich

Ein Fixwert, der den Vorgangstyp für den Artikelimport festlegt.

Wert"import_items"
file_urlstringerforderlich

Die URL einer Datei mit Daten im JSON-Format. Die Datei sollte auf einem öffentlich zugänglichen Speicherdienst gehostet sein. Die Dateivorlage steht im Kundenportal unter Store > Virtuelle Gegenstände > Katalog verwalten > Artikel importieren (JSON) zum Download bereit.

Beispiel: "https://my-bucket.s3.amazonaws.com/items.json"
modestring

Importaktionen:

Standard "create_and_update"
Enum WertBeschreibung
create

Neue Artikel hinzufügen.

create_and_update

Neue Artikel hinzufügen und vorhandene aktualisieren.

sync

Neue Artikel hinzufügen, vorhandene aktualisieren und fehlende Artikel deaktivieren.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v1/projects/44056/import/from_external_file \
  -H 'Content-Type: application/json' \
  -d '{
    "connector_external_id": "import_items",
    "file_url": "https://my-bucket.s3.amazonaws.com/items.json",
    "mode": "create"
  }'

Antworten

Die Datei wurde erfolgreich importiert und wird nun verarbeitet.

Bodyapplication/json
import_idstring

Importvorgangs-ID. Senden Sie diese ID Ihrem Customer Success Manager oder per E-Mail an csm@xsolla.com, wenn beim Importieren der JSON-Datei Probleme mit dem Bericht auftreten.

Beispiel: "af9f3638a16e11ef880da2cd677d2d24"
Antwort
application/json
{
  "import_id": "af9f3638a16e11ef880da2cd677d2d24"
}