Creates an inventory Group record for a company.

POST

/api/v1/inventoryGroups

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

Header Params

Body Params application/json

Example

{
    "code": "Group-001",
    "title": "Group 001",
    "translation": {
        "title": {
            "el": "Ομάδα 001",
            "en": "Group 001",
            "ro": null,
            "de": null,
            "fr": null,
            "it": null,
            "bg": null,
            "sq": null,
            "es": null,
            "ru": null,
            "pl": null
        }
    },
    "lines": [
        {
            "mediaItem": null,
            "message": null,
            "quantity": 10,
            "color": "Red",
            "translation": {
                "message": {
                    "el": "Μήνυμα 001",
                    "en": "Message 001",
                    "ro": null,
                    "de": null,
                    "fr": null,
                    "it": null,
                    "bg": null,
                    "sq": null,
                    "es": null,
                    "ru": null,
                    "pl": null
                }
            }
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://platform.shopranos.eu/api/v1/inventoryGroups' \
--header 'x-companyId: b3e68ad4-06c8-4e70-965b-c02b38f66ef2' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": "Group-001",
    "title": "Group 001",
    "translation": {
        "title": {
            "el": "Ομάδα 001",
            "en": "Group 001",
            "ro": null,
            "de": null,
            "fr": null,
            "it": null,
            "bg": null,
            "sq": null,
            "es": null,
            "ru": null,
            "pl": null
        }
    },
    "lines": [
        {
            "mediaItem": null,
            "message": null,
            "quantity": 10,
            "color": "Red",
            "translation": {
                "message": {
                    "el": "Μήνυμα 001",
                    "en": "Message 001",
                    "ro": null,
                    "de": null,
                    "fr": null,
                    "it": null,
                    "bg": null,
                    "sq": null,
                    "es": null,
                    "ru": null,
                    "pl": null
                }
            }
        }
    ]
}'

Responses

🟢200OK

application/json

Body

Example

{}

🟢201The inventory Group record was successfully created.

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

Modified at 2025-03-26 10:28:58

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

Creates an inventory Group record for a company.