Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

Die Storefront API Gutscheine ermöglicht es, Gutscheincodes in der Storefront einzulösen und zu entfernen. Die API prüft dabei automatisch, ob ein Code gültig ist, und liefert nach der Einlösung die aktualisierten Warenkorbwerte (z. B. Rabatte und Summen) sowie bei Bedarf Hinweise/Fehlermeldungen zurück.

​
Unterstützte Methoden

Angabe aller Unterstützten Methoden
BefehlEndpunkteGETPUTPOSTDELETE
Gutschein Daten auslesenvoucher/get
Gutschein einlösenvoucher/redeem
Gutschein löschenvoucher/delete

​
Methoden für Gutscheine

Diese Methoden ermöglichen das Prüfen, Einlösen und Entfernen von Gutscheinen direkt im Warenkorb oder im Checkout.

​
GET voucher/get

Dieser Aufruf liest Stammdaten zu einem Gutscheincode aus (z.B. Wert, Währung, Mindestbestellwert). Diese Informationen können im Warenkorb und Checkout verwendet werden, um einen Gutschein vor dem Einlösen zu prüfen und Infos wie Betrag und Bedingungen anzuzeigen. Beispiel-Aufruf für den Gutschein mit der Gutscheinnummer 7G3M-L2UU-CK1B-A2J2: 
GET https://<ihr-shop>.de/api/v1/voucher/get?id=7G3M-L2UU-CK1B-A2J2

​
Parameterübersicht

​
Body-Parameter

ParameterTypBeschreibung
idStringPflichtfeld
Gutscheincode, der abgefragt werden soll.

​
Beispiel-Response

{
  "currency": "EUR",
  "id": "7G3M-L2UU-CK1B-A2J2",
  "minOrderValue": 0,
  "taxId": "19",
  "value": 10.5
}

​
POST voucher/redeem

Dieser Aufruf löst einen Gutscheincode für den aktuellen Warenkorb ein und liefert Informationen zum eingelösten Gutschein und zum verbleibenden Wert. Dieser Befehl kann verwendet werden, um im Warenkorb oder Checkout den Gutschein zu verrechnen oder den eingelösten Betrag und ggf. den Restwert anzuzeigen. Beispiel-Aufruf für die Einlösung des Gutscheins 7G3M-L2UU-CK1B-A2J2: 
POST https://<ihr-shop>.de/api/v1/voucher/redeem

​
Beispiel-Request

{
  "id": "7G3M-L2UU-CK1B-A2J2"
}

​
Parameterübersicht

​
Header-Parameter

ParameterBeschreibung
x-sessionPflichtfeld
ID der aktuellen Session.
Mehr Informationen dazu: Storefront API Basics

​
Body-Parameter

ParamterTypBeschreibung
idstringPflichtfeld
Gutscheincode, der einzulösen ist.

​
Beispiel-Response

{
  "info": {
    "totalUsedValue": 0,
    "totalValue": 10.5,
    "vouchers": [
      {
        "currency": "EUR",
        "id": "7G3M-L2UU-CK1B-A2J2",
        "taxId": "19",
        "usedValue": 0,
        "value": 10.5
      }
    ]
  }
}

​
Fehlercodes

FehlercodeBeschreibung
invalidVoucherIdDie angegebene ID ist kein gültiger Gutscheincode.
deactivatedDer Gutschein wurde deaktiviert.
expiredDer Gutschein ist abgelaufen.
notYetValidDer Gutschein ist noch nicht gültig.
maxCountExceededDie maximale Anzahl an einlösbaren Gutscheinen pro Bestellung wurde erreicht.
valueSpentDer Gesamtwert des Gutscheins ist bereits verbraucht.
currencyMismatchDie Gutscheinwährung passt nicht zur Shop-Währung.
invalidCustomerDer Gutschein darf von diesem Kunden nicht eingelöst werden.
invalidSubshopDer Gutschein darf in diesem Subshop nicht eingelöst werden.

​
DELETE voucher/delete

Dieser Aufruf entfernt einen eingelösten Gutscheincode aus dem aktuellen Warenkorb und aktualisiert die Gutscheinübersicht. Dieser Befehl kann verwendet werden, um im Warenkorb oder Checkout eine versehentlich eingelöste oder nicht gewünschte Gutscheinanwendung rückgängig zu machen. Beispiel-Aufruf für das Entfernen des Gutscheins mit dem Code 7G3M-L2UU-CK1B-A2J2: 
DELETE https://<ihr-shop>.de/api/v1/voucher/delete

​
Beispiel-Request

{
  "id": "7G3M-L2UU-CK1B-A2J2"
}

​
Parameterübersicht

​
Header-Parameter

ParameterBeschreibung
x-sessionPflichtfeld
ID der aktuellen Session.
Mehr Informationen dazu: Storefront API Basics

​
Body-Parameter

ParameterTypBeschreibung
idStringPflichtcode
Gutscheincode, der entfernt werden soll.

​
Beispiel-Response

{
  "info": {
    "totalUsedValue": 0,
    "totalValue": 0,
    "vouchers": []
  }
}

​
Fehlercodes

FehlercodeBeschreibung
invalidVoucherIdDie angegebene ID ist kein gültiger Gutscheincode.