Retrieve a list of inventory levels with optional cursor-based pagination.

GET

/api/inventoryLevels

This endpoint retrieves a list of inventory levels based on the provided search criteria.
If a x-cursor header is provided, the system will use cursor-based pagination to fetch subsequent results.
The response will include an x-next-cursor header to indicate if there are more pages of results available.
If a x-cursor header is not provided, the system will use offset-based pagination to fetch the first page of results.
The response will include an x-total-count header to indicate the total number of results available.
Authorization Policies Required:

md_inventory: Ensures the tenant has purchased or subscribed to the inventory module.

manage_inventory: Ensures the user has the required permissions to manage inventory.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://platform.shopranos.eu/api/inventoryLevels' \
--header 'x-companyId: b3e68ad4-06c8-4e70-965b-c02b38f66ef2'

Responses

🟢200Success. A list of inventory levels matching the search criteria is returned.

application/json

Body

Example

[
    {
        "id": "string",
        "productVariantId": "string",
        "productId": "string",
        "companyId": "string",
        "locationId": "string",
        "quantity": 0,
        "reserved": 0,
        "updateDate": "2019-08-24T14:15:22Z",
        "insertDate": "2019-08-24T14:15:22Z"
    }
]

🟠400Bad Request. Invalid search parameters or header values.

🟠401Unauthorized. The user is not authenticated.

🟠403Forbidden. Either the module is not purchased or the user lacks necessary permissions.

Modified at 2025-07-08 13:29:55

Calculates the total quantity of a specific item variant across all locations.

Creates an inventory level record for a specified product variant at a specific location.