Dev Docs

Item Groups API

With this import, all necessary item groups that contain items can be imported. Each item can have assignments with different item groups.

If you need more information about item groups, please have a look for the user documentation.

Endpoint

The importconfigkey for the simple item group import is defaultimportitemgroupsV1.

Body

The valid json looks like that:

[

    {

        "_id": "{{__id}}",

        "itemGroupId": "{{itemGroupId}}",

        "itemGroupName": {

            "i18nVariants": {

                "de_DE": "{{name_de_de}}"

            }

        },

        "itemGroupParent": "{{itemGroupParent}}"

    }

]

Definition

Field

__id

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: The internal, unique ID for the item group.

itemGroupId

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: The unique ID for the item group, visible in the management console.

itemGroupName

Type: "TEXT" - string

Sample: "Daily Newspapers"

Description: The name of the item group.

itemGroupParent

Type: "NNNNN" - string

Sample: "12345" or "ABC-123"

Description: The ID of the parent item group.

Postman Collection

To have a quickstart, please download the postman ressources:

  • Postman Collection for Item Groups Import - DOWNLOAD

  • Postman Environment for Item Groups Import - DOWNLOAD