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 Verfügbarkeit-&-Lager API ergänzt Katalogdaten um Bestands- und Verfügbarkeitsinformationen. Damit lässt sich im Frontend anzeigen, ob ein Produkt und dessen Variante aktuell verfügbar ist oder als ausverkauft gilt, und entsprechende Hinweise können direkt an Produktlisten oder auf Produktdetailseiten ausgegeben werden. Darüber hinaus kann die verbleibende Reservierungsdauer für eine Warenkorb-Position eines Artikels abgefragt werden. Für die Anfragen muss zwingend eine x-session mitgegeben werden. Mehr dazu hier.

Unterstützte Methoden

Angabe aller Unterstützten Methoden:
BefehlEndpunkteGETPUTPOSTDELETE
Lagerbestand eines Produkts anzeigeninventory/load
Reservierung einer Warenkorbposition anzeigeninventory/loadReservation

Methoden für den Lagerbestand

Mithilfe dieser Methoden können Bestandsinformationen zu Produkten sowie Details zu laufenden Reservierungen im Warenkorb abgerufen werden. Darüber hinaus ermöglichen sie Verfügbarkeits- und Lieferhinweise und zeigen die verbleibende Reservierungszeit einer Position an.

GET inventory/load

Mit diesem Aufruf kann der aktuelle Lagerstatus eines Produkts (Menge, Zustand, Hinweise) abgerufen werden. Die Informationen können zur Anzeige von Lagerbeständen oder Lieferhinweisen verwendet werden. Beispiel-Aufruf des Produkts mit der Produkt-ID 191-98487
GET https://<ihr-shop>.de/api/v1/inventory/load?productId=191-98487

Parameterübersicht

Body-Parameter

ParameterTypBeschreibung
productIdstringPflichtfeld
ID des Produkts, dessen Inventar geladen werden soll.

Beispiel-Response

{
  "active": true,
  "amount": 33,
  "deliveryText": "Nur noch wenige Stück auf Lager",
  "messageLimit": 5,
  "soldOut": false,
  "splitDelivery": false,
  "state": "yellow"
}

GET inventory/loadReservation

Mit diesem Aufruf kann man die aktuelle Reservierungsdauer für eine bestimmte Warenkorb-Position abrufen (Restlaufzeit und Ablaufzeitpunkt). Mithilfe dieser Information können beispielsweise Hinweise zum Ablauf gesteuert werden. Beispiel-Aufruf einer Reservierung mit der Warenkorb-Positions-ID f28e67292c99759e5fb9
GET https://<ihr-shop>.de/api/v1/inventory/loadReservation?basketItemId=f28e67292c99759e5fb9

Parameterübersicht

Header-Parameter

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

Body-Parameter

ParameterTypBeschreibung
basketItemIdstringPflichtfeld
ID der Warenkorb-Position, deren Reservierung abgefragt wird.

Beispiel-Response

{
  "duration": 531,
  "reservedUntil": "2025-11-03T11:08:40Z"
}