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 Checkout stellt Funktionen für den Bestell- und Checkout-Prozess bereit. Darüber werden die Schritte abgedeckt, die typischerweise zwischen Warenkorb und Bestellabschluss stattfinden. Dazu gehören:
  • Ermitteln und Auswählen von Versandarten
  • Ermitteln und Auswählen von Zahlungsarten
  • Berechnung von Gesamtsummen (inklusive Berücksichtigung von Rabatten, Aufschlägen und weiteren preisrelevanten Bestandteilen)
  • Prüfen und Übernehmen von checkout-relevanten Daten (z. B. Liefer-/Rechnungsdaten, Voraussetzungen und Bedingungen für den Bestellabschluss)
  • Auslösen des Bestellabschlusses und Übergang in den jeweiligen Zahlungsfluss (je nach Zahlungsart)
Darüber hinaus ermöglicht die Schnittstelle den Zugriff auf alle relevanten Einstellungen und Regeln für den Bestellprozess, z. B. Mindestbestellwerte, Mindermengenzuschläge und weitere checkout-relevante Einschränkungen oder Zuschlagslogiken, sodass diese im Frontend korrekt berücksichtigt und angezeigt werden können.
Diese Storefront API befindet sich aktuell noch im Aufbau und steht derzeit nur in einem begrenzten Funktionsumfang zur Verfügung. Welche Informationen und Endpunkte momentan enthalten sind, ist der unten stehenden Schnittstellenbeschreibung zu entnehmen. Die Weiterentwicklung dieser Schnittstelle wird kontinuierlich fortgesetzt.

​
Unterstützte Methoden

Angabe aller unterstützten Methoden.
BefehlEndpunkteGETPUTPOSTDELETE
Checkout-Status abrufencheckout/status
Art des Kontos setzencheckout/setAccountType

​
Methoden für den Checkout

Folgende Methoden liefern Informationen zum aktuellen Checkout-Prozess der aktiven Session.

​
GET checkout/status

Der folgende Aufruf liefert die Gesamtkosten für den Checkout-Prozess (einschließlich Mindermengenzuschlag „surcharge“, Versand- und Zahlungsartenkosten, Gutscheine etc.). Er kann beispielsweise verwendet werden, um die Gesamtsumme im Checkout zu aktualisieren, ohne die Seite neu zu laden. 
GET https://<ihr-shop>.de/api/v1/checkout/status

​
Parameterübersicht

​
Header-Parameter

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

​
Beispiel-Response

{
   "currency" : "EUR",
   "paymentCost" : 0,
   "shippingCost" : 0,
   "surchargeCost" : 0,
   "total" : 14.9,
   "totalGross" : 14.9,
   "totalNet" : 12.52,
   "totalTax" : 2.38,
   "totalVoucher" : 0,
   "totalWeight" : 0
}

​
POST checkout/setAccountType

Der folgende Aufruf setzt die Art des Kontos, welches für die Bestellung im Checkout verwendet wird. Damit wird festgelegt, ob der Kunde als Neukunde, Bestandskunde oder Gast bestellt. 
POST https://<ihr-shop>.de/api/v1/checkout/setAccountType

​
Beispiel-Request

{
    "accountType": "guest"
}

​
Parameterübersicht

​
Header-Parameter

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

​
Body-Parameter

ParameterTypBeschreibung
accountTypestringPflichtfeld
Art des Kundenkontos.
Gültige Werte:
- “new” - Neukunde
- “registered” - Registrierter Kunde
- “guest” - Bestellung ohne Registrierung