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

GET

/api/v1/inventoryGroups

This endpoint retrieves a list of inventory Groups based on the provided search criteria.
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/v1/inventoryGroups' \
--header 'x-companyId: b3e68ad4-06c8-4e70-965b-c02b38f66ef2'

Responses

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

application/json

Body

Example

[
    {
        "id": "string",
        "companyId": "string",
        "code": "string",
        "title": "string",
        "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-03-26 10:28:58

Deletes an inventory Group record for a company.

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