Retrieves the inventory level of the first location for a specified product variant.

GET

/api/inventoryLevels/default/{variantId}

Authorization Policies Required:

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

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

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

Responses

🟢200Success. The inventory level record was retrieved.

application/json

Body

Example

{
    "id": "f0ea3f16-5b88-45c2-b061-9599769e1ebe",
    "productVariantId": "d873c66c-df69-4ba6-8cce-d127adaee9a0",
    "productId": "50fca37a-f6ab-4131-bcd6-f660cfabc242",
    "companyId": "b3e68ad4-06c8-4e70-965b-c02b38f66ef2",
    "locationId": "70015911-5aee-4516-bd9f-168a1807445c",
    "quantity": 10,
    "expectedInventoryLines": [
        {
            "deliveryDate": "2025-02-18T07:54:25.6982708+00:00",
            "expectedQuantity": 10
        }
    ],
    "updateDate": "2025-02-18T07:54:25.6982747+00:00",
    "insertDate": "2025-02-18T07:54:25.6982749+00:00"
}

🟠400Missing or invalid `x-companyId` header, malformed request.

🟠401Unauthorized. The user is not authenticated.

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

🟠404The specified `variantId` does not exist

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

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

Get product quantities for products.