Skip to main content
The Availability & Stock API supplements catalog data with stock and availability information. This lets the frontend show whether a product and its variant is currently available or considered sold out, with corresponding notices output directly on product lists or product detail pages. In addition, the remaining reservation time for a shopping cart position of an item can be queried. For the requests, an x-session must be sent along. More about this here.

​
Supported methods

List of all supported methods:
CommandEndpointsGETPUTPOSTDELETE
Show stock level of a productinventory/load
Show reservation of a cart positioninventory/loadReservation

​
Methods for stock

These methods can be used to retrieve stock information about products as well as details about ongoing reservations in the shopping cart. In addition, they enable availability and delivery notices and show the remaining reservation time of a position.

​
GET inventory/load

This call can be used to retrieve the current stock status of a product (quantity, state, notices). The information can be used to display stock levels or delivery notices. Example call of the product with the product ID 191-98487 
GET https://<your-shop>.de/api/v1/inventory/load?productId=191-98487

​
Parameter overview

​
Body parameters

ParameterTypeDescription
productIdstringRequired field
ID of the product whose inventory should be loaded.

​
Example response

{
  "active": true,
  "amount": 33,
  "deliveryText": "Only a few items left in stock",
  "messageLimit": 5,
  "soldOut": false,
  "splitDelivery": false,
  "state": "yellow"
}

​
GET inventory/loadReservation

This call can be used to retrieve the current reservation duration for a specific shopping cart position (remaining time and expiration time). With the help of this information, for example, expiration notices can be controlled. Example call of a reservation with the shopping cart position ID f28e67292c99759e5fb9 
GET https://<your-shop>.de/api/v1/inventory/loadReservation?basketItemId=f28e67292c99759e5fb9

​
Parameter overview

​
Header parameters

ParameterDescription
x-sessionRequired field
ID of the current session.
More information: Storefront API Basics

​
Body parameters

ParameterTypeDescription
basketItemIdstringRequired field
ID of the shopping cart position whose reservation is being queried.

​
Example response

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