> ## 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.

# Storefront API Stock

> Show product availability, sold-out status, and remaining cart reservation time in the storefront through the Storefront API stock endpoints.

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](https://websaleag-44ee7ea6.mintlify.app/schnittstellen/storefront-api/storefront-api-basics#3-session-handling).

***

## Supported methods

List of all supported methods:

| **Command**                         | **Endpoints**               | **GET**               | **PUT**             | **POST**            | **DELETE**          |
| ----------------------------------- | --------------------------- | --------------------- | ------------------- | ------------------- | ------------------- |
| Show stock level of a product       | `inventory/load`            | <Icon icon="check" /> | <Icon icon="ban" /> | <Icon icon="ban" /> | <Icon icon="ban" /> |
| Show reservation of a cart position | `inventory/loadReservation` | <Icon icon="check" /> | <Icon icon="ban" /> | <Icon icon="ban" /> | <Icon icon="ban" /> |

## 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`

```text theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
GET https://<your-shop>.de/api/v1/inventory/load?productId=191-98487
```

#### Parameter overview

#### Body parameters

| **Parameter** | **Type** | **Description**                                                             |
| ------------- | -------- | --------------------------------------------------------------------------- |
| `productId`   | string   | **Required field**<br />ID of the product whose inventory should be loaded. |

#### Example response

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "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`

```text theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
GET https://<your-shop>.de/api/v1/inventory/loadReservation?basketItemId=f28e67292c99759e5fb9
```

#### Parameter overview

#### Header parameters

| **Parameter** | **Description**                                                                                                                                                                                                      |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x-session`   | **Required field**<br />ID of the current session.   <br />More information: [Storefront API Basics](https://websaleag-44ee7ea6.mintlify.app/schnittstellen/storefront-api/storefront-api-basics#3-session-handling) |

#### Body parameters

| **Parameter**  | **Type** | **Description**                                                                              |
| -------------- | -------- | -------------------------------------------------------------------------------------------- |
| `basketItemId` | string   | **Required field**<br />ID of the shopping cart position whose reservation is being queried. |

#### Example response

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "duration": 531,
  "reservedUntil": "2025-11-03T11:08:40Z"
}
```