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

GET

/api/inventoryLevels/{variantId}/total

Purpose:
This endpoint retrieves the total aggregated quantity of a specified item variant (variantId) across all associated locations for a given company.

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.

Error Scenarios:

If the x-companyId header is missing or invalid, a 400 Bad Request response will be returned.

If the specified variantId does not exist, a 404 Not Found response will be returned.

If the user lacks the required permissions, a 403 Forbidden response will be returned.

Responses:

200 OK: The total quantity was successfully calculated and returned.

400 Bad Request: The request was malformed or missing required parameters.

403 Forbidden: The user does not have permission to perform this operation.

404 Not Found: The specified variantId was not found.

Request

Path 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/var-123456789/total' \
--header 'x-companyId: b3e68ad4-06c8-4e70-965b-c02b38f66ef2'

Responses

🟢200OK

application/json

Body

Example

{
    "totalQuantity": 0
}

Modified at 2025-10-01 06:37:53

Adjust reserved stock for a cart in eshop

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