Zum Inhalt springen
/
Werbeaktion löschen

Subscriptions API (2.0)

Überblick

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

Diese API-Referenz beschreibt Endpunkte für die Verwaltung von Abonnements, Gutscheinen und Werbeaktionen. Weitere Informationen über Subscriptions finden Sie in der Produktanleitung und in der Begriffserläuterung.

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

Token

Operationen

Abo-Modelle

Operationen

Produkte

Operationen

Subscription management

Operationen

Zahlungen

Operationen

Werbeaktionen

Operationen

Werbeaktion anlegen

Anfrage

Ruft die Liste der Projekte des Händlers ab.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

Bodyapplication/jsonerforderlich
descriptionobject

Array der lokalisierten Werbeaktionsbeschreibungen.

labelobject

Array der lokalisierten Kennzeichnungen, die im Zahlungsportal angezeigt werden.

nameobject

Array der lokalisierten Bezeichnungen der Werbeaktion.

project_idintegererforderlich

Projekt-ID.

technical_namestringerforderlich

Arbeitstitel der Werbeaktion.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Promotion with 30% discount",
      "ru": "Акция со скидкой 30%"
    },
    "label": {
      "en": "30%",
      "ru": "30%"
    },
    "name": {
      "en": "30% discount",
      "ru": "скидка 30%"
    },
    "project_id": 12345,
    "technical_name": "Sale promotion"
  }'

Antworten

Created.

Bodyapplication/json
idinteger

ID der Werbeaktion.

Antwort
application/json
{
  "id": 17890
}

Werbeaktion löschen

Anfrage

Ruft die Liste der Projekte des Händlers ab enabled =false.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

promotion_idintegererforderlich

ID der Werbeaktion.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

Antworten

No Content (Kein Inhalt).

Werbeaktion anfordern

Anfrage

Ruft die Liste der Projekte des Händlers ab.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

promotion_idintegererforderlich

ID der Werbeaktion.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

Antworten

OK.

Bodyapplication/json
descriptionobject

Array der lokalisierten Werbeaktionsbeschreibungen.

labelobject

Array der lokalisierten Kennzeichnungen, die im Zahlungsportal angezeigt werden.

nameobject

Array der lokalisierten Bezeichnungen der Werbeaktion.

project_idinteger

Projekt-ID.

technical_namestring

Arbeitstitel der Werbeaktion.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
Antwort
application/json
{
  "description": {
    "en": "Promotion with 30% discount",
    "ru": "Акция со скидкой 30%"
  },
  "enabled": false,
  "id": 17890,
  "label": {
    "en": "30%",
    "ru": "30%"
  },
  "name": {
    "en": "30% discount",
    "ru": "Скидка 30%"
  },
  "project_id": 40544,
  "read_only": false,
  "show_banner": true,
  "technical_name": "Sale promotion"
}

Gutscheine

Operationen

Subscription management

Operationen