Categories | Struct Docs

Get ids of all categories in the system

get

Categories are used to organize products within catalogues. Categories can be nested in a hierarchy structure of any depth. The catalogue data model defines attributes which can hold data for each category. Attributes can be attached to categories in the master catalogue to define a structure of attributes available to products depending on their category placement in the master catalogue.

Authorizations

AuthorizationstringRequired

Responses

200

OK

application/json

integer · int32[]Optional

get

/v1/categories/ids

GET /v1/categories/ids HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

Get basic models for categories

get

No more than 5000 categories can be requested at a time. If no limit is provided, the default limit of 1000 will be used

Authorizations

AuthorizationstringRequired

Query parameters

limitinteger · int32Optional

Number of categories to return

Default: 1000

afterIdinteger · int32Optional

Only get categories with id larger than this id

Responses

200

OK

application/json

Result set of categories from a category query

Totalinteger · int32Optional

The total number of items

Remaininginteger · int32Optional

The remaining items that lie after the last id of the item in this result set

LastIdinteger · int32Optional

The id of the last item in this result set

get

/v1/categories

GET /v1/categories HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Categories": [
    {
      "Id": 10,
      "ParentId": null,
      "SortOrder": 1,
      "CatalogueUid": "c20d0037-09cb-4668-bc75-00e2e5b98f8e",
      "Created": "2025-09-25T22:40:48.5054322+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2025-09-25T22:40:48.5054399+01:00",
      "LastModifiedBy": "Struct",
      "HasChildren": true,
      "Name": {
        "en-GB": "Electronics",
        "da-DK": "Elektronik"
      },
      "Dynamic": false,
      "QuerySetup": null,
      "WorkflowStateUid": "0b780b73-ad40-481a-ad68-c838ef63ff61",
      "BusinessUnits": []
    },
    {
      "Id": 11,
      "ParentId": null,
      "SortOrder": 2,
      "CatalogueUid": "c20d0037-09cb-4668-bc75-00e2e5b98f8e",
      "Created": "2025-09-25T22:40:48.5054434+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2025-09-25T22:40:48.5054440+01:00",
      "LastModifiedBy": "Struct",
      "HasChildren": true,
      "Name": {
        "en-GB": "Clothing",
        "da-DK": "Tøj"
      },
      "Dynamic": false,
      "QuerySetup": null,
      "WorkflowStateUid": "3a114b65-c4d0-4546-b868-232a3d05838b",
      "BusinessUnits": []
    },
    {
      "Id": 12,
      "ParentId": null,
      "SortOrder": 3,
      "CatalogueUid": "c20d0037-09cb-4668-bc75-00e2e5b98f8e",
      "Created": "2025-09-25T22:40:48.5054452+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2025-09-25T22:40:48.5054458+01:00",
      "LastModifiedBy": "Struct",
      "HasChildren": true,
      "Name": {
        "en-GB": "Wine",
        "da-DK": "Vin"
      },
      "Dynamic": false,
      "QuerySetup": null,
      "WorkflowStateUid": "3572aa18-89d9-4cc6-935a-e31ebe52dde1",
      "BusinessUnits": []
    }
  ],
  "Total": 223,
  "Remaining": 220,
  "LastId": 12
}

Create new categories

post

A maximum of 5000 categories can be created in one request

Authorizations

AuthorizationstringRequired

Bodyobject[]

Model for creating a new category

CatalogueUidstring · uuidOptional

Uid of catalogue to add category to

ParentIdinteger · int32 · nullableOptional

Id of parent id to place category underneath (set as null, of category shall be at root level of catalogue)

SortOrderinteger · int32 · nullableOptional

Sort order of category compared to other categories at the same level i the catalogue

Dynamicboolean · nullableOptional

Set if products for this category is found by search query set on category

WorkflowStateUidstring · uuid · nullableOptional

Workflow state to set on the category

Responses

201

Created

application/json

400

Bad Request

application/json

post

/v1/categories

POST /v1/categories HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1431

[
  {
    "CatalogueUid": "1ebd05f5-b7a7-4a88-a6d3-d0c5155da267",
    "ParentId": null,
    "SortOrder": 1,
    "Dynamic": null,
    "QuerySetup": null,
    "WorkflowStateUid": "537a74ab-2a62-4020-80a9-24a52f98bada",
    "BusinessUnits": null,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Electronics"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Elektronik"
        }
      ],
      "HeaderImage": "3013",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest electronics"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor elektronik"
        }
      ]
    }
  },
  {
    "CatalogueUid": "1ebd05f5-b7a7-4a88-a6d3-d0c5155da267",
    "ParentId": null,
    "SortOrder": 2,
    "Dynamic": null,
    "QuerySetup": null,
    "WorkflowStateUid": "46b0e5cd-aaef-46f7-90f8-e950d7f2bd25",
    "BusinessUnits": null,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Clothing"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Tøj"
        }
      ],
      "HeaderImage": "3014",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest clothing"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor tøj"
        }
      ]
    }
  },
  {
    "CatalogueUid": "1ebd05f5-b7a7-4a88-a6d3-d0c5155da267",
    "ParentId": null,
    "SortOrder": 3,
    "Dynamic": null,
    "QuerySetup": null,
    "WorkflowStateUid": "9c3ce1cd-0453-4926-b88e-9a42740f4765",
    "BusinessUnits": null,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Wine"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Vin"
        }
      ],
      "HeaderImage": "3015",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest wine"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor vin"
        }
      ]
    }
  }
]

[
  1
]

Delete multiple categories

delete

Authorizations

AuthorizationstringRequired

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

No content

delete

/v1/categories

DELETE /v1/categories HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

No content

Update multiple categories

patch

A maximum of 5000 categories can be updated in one request

Authorizations

AuthorizationstringRequired

Body

Responses

200

OK

No content

400

Bad Request

application/json

patch

/v1/categories

PATCH /v1/categories HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 817

{
  "10": {
    "SortOrder": 1,
    "MoveCommand": null,
    "QuerySetup": null,
    "WorkflowStateUid": "93473e15-af13-408f-a430-8164e800a188",
    "BusinessUnits": null,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Wine"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Vin"
        }
      ],
      "HeaderImage": "3015",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest wine"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor vin"
        }
      ]
    }
  },
  "11": {
    "SortOrder": 2,
    "MoveCommand": null,
    "QuerySetup": null,
    "WorkflowStateUid": "dd5201f0-22ce-47c2-a401-b3afa6d5c6b5",
    "BusinessUnits": null,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Clothing"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Tøj"
        }
      ],
      "HeaderImage": "3014",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest clothing"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor tøj"
        }
      ]
    }
  }
}

No content

Get basic model for a category

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category

Responses

200

OK

application/json

Defines general information on a category

Idinteger · int32Optional

Id of category

ParentIdinteger · int32 · nullableOptional

Id of category's parent category. Null, if this category is placed in the root of its catalogue

SortOrderinteger · int32Optional

Sortorder of the category compared to other categories at the same level in the catalogue

CatalogueUidstring · uuidOptional

The unique id of the catalogue, this category resides in

Createdstring · date-timeOptional

Timestamp of the creation of category

CreatedBystring · nullableOptional

Username of user who created this category

LastModifiedstring · date-timeOptional

Timestamp of last modification of category

LastModifiedBystring · nullableOptional

Username of user who did the last modification

HasChildrenbooleanOptional

Indicates whether this category has any sub categories

DynamicbooleanOptional

Indicates whether this category is dynamic (classification handled by PIM)

WorkflowStateUidstring · uuid · nullableOptional

The uid of the workflow state of the category

get

/v1/categories/{id}

GET /v1/categories/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "Id": 10,
  "ParentId": null,
  "SortOrder": 1,
  "CatalogueUid": "ab1c2956-bb0a-400b-95a3-33ebb89c7ee9",
  "Created": "2025-09-25T22:40:48.5149560+01:00",
  "CreatedBy": "Struct",
  "LastModified": "2025-09-25T22:40:48.5149710+01:00",
  "LastModifiedBy": "Struct",
  "HasChildren": true,
  "Name": {
    "en-GB": "Electronics",
    "da-DK": "Elektronik"
  },
  "Dynamic": false,
  "QuerySetup": null,
  "WorkflowStateUid": "3ae3f169-2c74-421f-825f-d4f2655193d0",
  "BusinessUnits": []
}

Delete a category

delete

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category to delete

Responses

200

OK

No content

delete

/v1/categories/{id}

DELETE /v1/categories/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Update category

patch

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category to update

Body

Model representing a category update

SortOrderinteger · int32 · nullableOptional

Set to update sort order of category compared to other categories at the same level in the catalogue (set as null if you do not want to update this)

WorkflowStateUidstring · uuid · nullableOptional

Workflow state to set on the category

Responses

200

OK

No content

patch

/v1/categories/{id}

PATCH /v1/categories/{id} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 397

{
  "SortOrder": 2,
  "MoveCommand": null,
  "QuerySetup": null,
  "WorkflowStateUid": "46cbac32-3a58-4699-9ca8-587310a0dc84",
  "BusinessUnits": null,
  "Values": {
    "Name": [
      {
        "CultureCode": "en-GB",
        "Data": "Wine"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Vin"
      }
    ],
    "HeaderImage": "3015",
    "Description": [
      {
        "CultureCode": "en-GB",
        "Data": "See all the latest and greatest wine"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Se alt det nyeste indenfor vin"
      }
    ]
  }
}

200

OK

No content

Get basic model for a batch of categories

post

#Available from v.3.2.0

Authorizations

AuthorizationstringRequired

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

Defines general information on a category

Idinteger · int32Optional

Id of category

ParentIdinteger · int32 · nullableOptional

Id of category's parent category. Null, if this category is placed in the root of its catalogue

SortOrderinteger · int32Optional

Sortorder of the category compared to other categories at the same level in the catalogue

CatalogueUidstring · uuidOptional

The unique id of the catalogue, this category resides in

Createdstring · date-timeOptional

Timestamp of the creation of category

CreatedBystring · nullableOptional

Username of user who created this category

LastModifiedstring · date-timeOptional

Timestamp of last modification of category

LastModifiedBystring · nullableOptional

Username of user who did the last modification

HasChildrenbooleanOptional

Indicates whether this category has any sub categories

DynamicbooleanOptional

Indicates whether this category is dynamic (classification handled by PIM)

WorkflowStateUidstring · uuid · nullableOptional

The uid of the workflow state of the category

post

/v1/categories/batch

POST /v1/categories/batch HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

[
  {
    "Id": 10,
    "ParentId": null,
    "SortOrder": 1,
    "CatalogueUid": "0290bd09-f3c5-4b8f-a3a0-0d19965f2b99",
    "Created": "2025-09-25T22:40:48.5185574+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5185700+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Electronics",
      "da-DK": "Elektronik"
    },
    "Dynamic": false,
    "QuerySetup": null,
    "WorkflowStateUid": "4d64c8af-54bf-4e21-86b9-9100e711a4f5",
    "BusinessUnits": []
  },
  {
    "Id": 11,
    "ParentId": null,
    "SortOrder": 2,
    "CatalogueUid": "0290bd09-f3c5-4b8f-a3a0-0d19965f2b99",
    "Created": "2025-09-25T22:40:48.5185731+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5185736+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Clothing",
      "da-DK": "Tøj"
    },
    "Dynamic": false,
    "QuerySetup": null,
    "WorkflowStateUid": "e043217f-b974-4ce8-809e-7b6e357c6e2c",
    "BusinessUnits": []
  },
  {
    "Id": 12,
    "ParentId": null,
    "SortOrder": 3,
    "CatalogueUid": "0290bd09-f3c5-4b8f-a3a0-0d19965f2b99",
    "Created": "2025-09-25T22:40:48.5185745+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5185750+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Wine",
      "da-DK": "Vin"
    },
    "Dynamic": true,
    "QuerySetup": {
      "ProductQuery": {
        "SubQueries": [
          {
            "Filters": [
              {
                "FieldUid": "OnlineDate",
                "QueryOperator": {},
                "FilterValue": ">-30d"
              }
            ],
            "BooleanOperator": {},
            "QueryModelType": "SimpleQueryModel"
          },
          {
            "Filters": [
              {
                "FieldUid": "Color.BaseColor",
                "QueryOperator": {},
                "FilterValue": "d671ca19-961e-4fa5-af6b-7ab8d1b967a7"
              },
              {
                "FieldUid": "Color.BaseColor",
                "QueryOperator": {},
                "FilterValue": "c5e97e8d-687b-4bc8-86e1-3b6c1b5d9c1a"
              }
            ],
            "BooleanOperator": {},
            "QueryModelType": "SimpleQueryModel"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "BooleanQueryModel"
      },
      "VariantGroupQuery": null
    },
    "WorkflowStateUid": "b08652c9-6046-4715-9a80-5faacdc276c3",
    "BusinessUnits": []
  }
]

Get child categories of a specific category

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category to get children for

Responses

200

OK

application/json

Defines general information on a category

Idinteger · int32Optional

Id of category

ParentIdinteger · int32 · nullableOptional

Id of category's parent category. Null, if this category is placed in the root of its catalogue

SortOrderinteger · int32Optional

Sortorder of the category compared to other categories at the same level in the catalogue

CatalogueUidstring · uuidOptional

The unique id of the catalogue, this category resides in

Createdstring · date-timeOptional

Timestamp of the creation of category

CreatedBystring · nullableOptional

Username of user who created this category

LastModifiedstring · date-timeOptional

Timestamp of last modification of category

LastModifiedBystring · nullableOptional

Username of user who did the last modification

HasChildrenbooleanOptional

Indicates whether this category has any sub categories

DynamicbooleanOptional

Indicates whether this category is dynamic (classification handled by PIM)

WorkflowStateUidstring · uuid · nullableOptional

The uid of the workflow state of the category

get

/v1/categories/{id}/children

GET /v1/categories/{id}/children HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Id": 10,
    "ParentId": null,
    "SortOrder": 1,
    "CatalogueUid": "da606300-56a4-4cc0-a457-058ef648504f",
    "Created": "2025-09-25T22:40:48.5199629+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5199688+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Electronics",
      "da-DK": "Elektronik"
    },
    "Dynamic": false,
    "QuerySetup": null,
    "WorkflowStateUid": "83dd39d4-514b-48f5-9420-8eee91deb92f",
    "BusinessUnits": []
  },
  {
    "Id": 11,
    "ParentId": null,
    "SortOrder": 2,
    "CatalogueUid": "da606300-56a4-4cc0-a457-058ef648504f",
    "Created": "2025-09-25T22:40:48.5199714+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5199721+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Clothing",
      "da-DK": "Tøj"
    },
    "Dynamic": false,
    "QuerySetup": null,
    "WorkflowStateUid": "f78ed4ef-c021-4c91-81c0-3b858b532f7e",
    "BusinessUnits": []
  },
  {
    "Id": 12,
    "ParentId": null,
    "SortOrder": 3,
    "CatalogueUid": "da606300-56a4-4cc0-a457-058ef648504f",
    "Created": "2025-09-25T22:40:48.5199791+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5199797+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Wine",
      "da-DK": "Vin"
    },
    "Dynamic": true,
    "QuerySetup": {
      "ProductQuery": {
        "SubQueries": [
          {
            "Filters": [
              {
                "FieldUid": "OnlineDate",
                "QueryOperator": {},
                "FilterValue": ">-30d"
              }
            ],
            "BooleanOperator": {},
            "QueryModelType": "SimpleQueryModel"
          },
          {
            "Filters": [
              {
                "FieldUid": "Color.BaseColor",
                "QueryOperator": {},
                "FilterValue": "d671ca19-961e-4fa5-af6b-7ab8d1b967a7"
              },
              {
                "FieldUid": "Color.BaseColor",
                "QueryOperator": {},
                "FilterValue": "c5e97e8d-687b-4bc8-86e1-3b6c1b5d9c1a"
              }
            ],
            "BooleanOperator": {},
            "QueryModelType": "SimpleQueryModel"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "BooleanQueryModel"
      },
      "VariantGroupQuery": null
    },
    "WorkflowStateUid": "e11a3c2d-ec1e-4780-9626-063522a6c060",
    "BusinessUnits": []
  }
]

Get child categories for a range categories

post

Authorizations

AuthorizationstringRequired

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

Defines general information on a category

Idinteger · int32Optional

Id of category

ParentIdinteger · int32 · nullableOptional

Id of category's parent category. Null, if this category is placed in the root of its catalogue

SortOrderinteger · int32Optional

Sortorder of the category compared to other categories at the same level in the catalogue

CatalogueUidstring · uuidOptional

The unique id of the catalogue, this category resides in

Createdstring · date-timeOptional

Timestamp of the creation of category

CreatedBystring · nullableOptional

Username of user who created this category

LastModifiedstring · date-timeOptional

Timestamp of last modification of category

LastModifiedBystring · nullableOptional

Username of user who did the last modification

HasChildrenbooleanOptional

Indicates whether this category has any sub categories

DynamicbooleanOptional

Indicates whether this category is dynamic (classification handled by PIM)

WorkflowStateUidstring · uuid · nullableOptional

The uid of the workflow state of the category

post

/v1/categories/batch/children

POST /v1/categories/batch/children HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

[
  {
    "Id": 10,
    "ParentId": 1,
    "SortOrder": 1,
    "CatalogueUid": "17d4d83c-4b0a-402c-91e6-40060cf39aa4",
    "Created": "2025-09-25T22:40:48.5211357+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5211389+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Electronics",
      "da-DK": "Elektronik"
    },
    "Dynamic": false,
    "QuerySetup": null,
    "WorkflowStateUid": "e728da53-71f8-4653-9f51-648aa315e5e2",
    "BusinessUnits": []
  },
  {
    "Id": 11,
    "ParentId": 1,
    "SortOrder": 2,
    "CatalogueUid": "17d4d83c-4b0a-402c-91e6-40060cf39aa4",
    "Created": "2025-09-25T22:40:48.5211412+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5211418+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Clothing",
      "da-DK": "Tøj"
    },
    "Dynamic": false,
    "QuerySetup": null,
    "WorkflowStateUid": "18b919d7-48b3-4218-9860-46b31ab59434",
    "BusinessUnits": []
  },
  {
    "Id": 12,
    "ParentId": 2,
    "SortOrder": 3,
    "CatalogueUid": "17d4d83c-4b0a-402c-91e6-40060cf39aa4",
    "Created": "2025-09-25T22:40:48.5211431+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-09-25T22:40:48.5211437+01:00",
    "LastModifiedBy": "Struct",
    "HasChildren": true,
    "Name": {
      "en-GB": "Wine",
      "da-DK": "Vin"
    },
    "Dynamic": true,
    "QuerySetup": {
      "ProductQuery": {
        "SubQueries": [
          {
            "Filters": [
              {
                "FieldUid": "OnlineDate",
                "QueryOperator": {},
                "FilterValue": ">-30d"
              }
            ],
            "BooleanOperator": {},
            "QueryModelType": "SimpleQueryModel"
          },
          {
            "Filters": [
              {
                "FieldUid": "Color.BaseColor",
                "QueryOperator": {},
                "FilterValue": "d671ca19-961e-4fa5-af6b-7ab8d1b967a7"
              },
              {
                "FieldUid": "Color.BaseColor",
                "QueryOperator": {},
                "FilterValue": "c5e97e8d-687b-4bc8-86e1-3b6c1b5d9c1a"
              }
            ],
            "BooleanOperator": {},
            "QueryModelType": "SimpleQueryModel"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "BooleanQueryModel"
      },
      "VariantGroupQuery": null
    },
    "WorkflowStateUid": "c81837c9-62a4-4fd8-a938-247203e1fecc",
    "BusinessUnits": []
  }
]

Get ids of products in a category

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category to get products for

Query parameters

includeArchivedbooleanOptional

Include archived products

Default: false

Responses

200

OK

application/json

integer · int32[]Optional

get

/v1/categories/{id}/products

GET /v1/categories/{id}/products HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

Get ids of products in a categories

post

Authorizations

AuthorizationstringRequired

Body

Wrapper for product children batch query

CategoryIdsinteger · int32[] · nullableOptional

Category ids to request products for

IncludeArchivedbooleanOptional

Indicate whether archibed products shall also be included

Responses

200

OK

application/json

Other propertiesinteger · int32[]Optional

post

/v1/categories/batch/products

POST /v1/categories/batch/products HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "CategoryIds": [
    1
  ],
  "IncludeArchived": true
}

200

OK

Get the number of products in a category

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category to get product count for

Query parameters

includeArchivedbooleanOptional

Include archived products in count

Default: false

Responses

200

OK

application/json

integer · int32Optional

get

/v1/categories/{id}/products/count

GET /v1/categories/{id}/products/count HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

Get the number of products in a batch of categories

post

Authorizations

AuthorizationstringRequired

Body

Wrapper for product children batch query

CategoryIdsinteger · int32[] · nullableOptional

Category ids to request products for

IncludeArchivedbooleanOptional

Indicate whether archibed products shall also be included

Responses

200

OK

application/json

Other propertiesinteger · int32Optional

post

/v1/categories/batch/products/count

POST /v1/categories/batch/products/count HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "CategoryIds": [
    1
  ],
  "IncludeArchived": true
}

200

OK

{
  "10": 233,
  "11": 107,
  "12": 2036
}

Get all identifiers and their internal ids for a specific identifier type

get

Use to get a map from an identifier to the internal id of a category in the system. Identifiers are based on attribute values that hold references to external systems. Thus, the identifier can be the id of the category in an external system. You can then use this map to know which category id to update or delete based on the id of the corresponding category in the external system

Authorizations

AuthorizationstringRequired

Path parameters

identifierAliasstringRequired

Alias of identifier type

Responses

200

OK

application/json

Other propertiesinteger · int32Optional

get

/v1/categories/identifiers/{identifierAlias}

GET /v1/categories/identifiers/{identifierAlias} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "AX_Electronics": 10,
  "AX_Clothing": 11,
  "AX_Wine": 13
}

Get the internal id of a category based on its identifier

get

Use to get a map from an identifier to the internal id of a category in the system. Identifiers are based on attribute values that hold references to external systems. Thus, the identifier can be the id of the category in an external system. You can then use this map to know which category id to update or delete based on the id of the corresponding category in the external system

Authorizations

AuthorizationstringRequired

Path parameters

identifierAliasstringRequired

Alias of identifier type

identifierstringRequired

Identifier value

Responses

200

OK

application/json

integer · int32Optional

get

/v1/categories/identifiers/{identifierAlias}/{identifier}

GET /v1/categories/identifiers/{identifierAlias}/{identifier} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

Get internal ids of multiple categories from their identifier

post

Use to get a map from an identifier to the internal id of a category in the system. Identifiers are based on attribute values that hold references to external systems. Thus, the identifier can be the id of the category in an external system. You can then use this map to know which category id to update or delete based on the id of the corresponding category in the external system

Authorizations

AuthorizationstringRequired

Body

Provide an identifier alias along with an array of identifiers to get the internal entity ids matching those identifiers

IdentifierAliasstring · nullableOptional

The alias of the identifier

Identifiersstring[] · nullableOptional

Array of identifiers to return internal ids for

Responses

200

OK

application/json

Other propertiesinteger · int32Optional

post

/v1/categories/batch/identifiers

POST /v1/categories/batch/identifiers HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "IdentifierAlias": "text",
  "Identifiers": [
    "text"
  ]
}

200

OK

{
  "AX_Electronics": 10,
  "AX_Clothing": 11,
  "AX_Wine": 13,
  "AX_Food": null
}

Get attribute values for the category

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category

Query parameters

globalListValueReferencesOnlybooleanOptional

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

Default: false

Responses

200

OK

application/json

Category attribute values container

CategoryIdinteger · int32Optional

Id of category

404

Not Found

application/json

get

/v1/categories/{id}/attributevalues

GET /v1/categories/{id}/attributevalues HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "CategoryId": 10,
  "Values": {
    "Name": [
      {
        "CultureCode": "en-GB",
        "Data": "Electronics"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Elektronik"
      }
    ],
    "HeaderImage": "3013",
    "Description": [
      {
        "CultureCode": "en-GB",
        "Data": "See all the latest and greatest electronics"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Se alt det nyeste indenfor elektronik"
      }
    ]
  }
}

patch

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category

Body

Other propertiesanyOptional

Responses

200

OK

No content

patch

/v1/categories/{id}/attributevalues

PATCH /v1/categories/{id}/attributevalues HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "Name": [
    {
      "CultureCode": "en-GB",
      "Data": "Electronics"
    },
    {
      "CultureCode": "da-DK",
      "Data": "Elektronik"
    }
  ],
  "HeaderImage": "3013",
  "Description": [
    {
      "CultureCode": "en-GB",
      "Data": "See all the latest and greatest electronics"
    },
    {
      "CultureCode": "da-DK",
      "Data": "Se alt det nyeste indenfor elektronik"
    }
  ]
}

200

OK

No content

Get attribute values for multiple categories

post

No more than 5000 categories can be requested at a time.

Authorizations

AuthorizationstringRequired

Body

Define which categories to fetch data for and what data to fetch

CategoryIdsinteger · int32[] · nullableOptional

Ids of categories to return

IncludeValuesinteger · enumOptional

Defines which attribute values to return

1 = All: Return all attribute values
2 = Scopes: Return values for scopes specified in request
3 = Aliases: Return values for attribute aliases specified in request
4 = ScopesAndAliases: Return values for attributes in specified scopes, plus values in the attributes specified by alias
5 = Uids: Return values for attribute uids specified in request

Possible values:

Scopesstring[] · nullableOptional

If IncludeValues is Scopes, define which scopes to return values for here

Aliasesstring[] · nullableOptional

If IncludeValues is Aliases, define aliases of the attributes to include values for

Uidsstring · uuid[] · nullableOptional

If IncludeValues is Uids, define uids of the attributes to include values for

LimitToCultureCodesstring[] · nullableOptional

Only return values for specific languages

LimitToSegmentsstring[] · nullableOptional

Only return values for specific dimension segments

GlobalListValueReferencesOnlybooleanOptional

Indicate if only uids of referenced to global list values shall be returned instead of the materialized values

FromTimestampstring · date-time · nullableOptional

Get attribute values back in time

Responses

200

OK

application/json

Category attribute values container

CategoryIdinteger · int32Optional

Id of category

400

Bad Request

application/json

post

/v1/categories/batch/attributevalues

POST /v1/categories/batch/attributevalues HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 260

{
  "CategoryIds": [
    1
  ],
  "IncludeValues": 1,
  "Scopes": [
    "text"
  ],
  "Aliases": [
    "text"
  ],
  "Uids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "LimitToCultureCodes": [
    "text"
  ],
  "LimitToSegments": [
    "text"
  ],
  "GlobalListValueReferencesOnly": true,
  "FromTimestamp": "2026-02-26T07:59:18.682Z"
}

[
  {
    "CategoryId": 10,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Electronics"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Elektronik"
        }
      ],
      "HeaderImage": "3013",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest electronics"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor elektronik"
        }
      ]
    }
  },
  {
    "CategoryId": 11,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Clothing"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Tøj"
        }
      ],
      "HeaderImage": "3014",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest clothing"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor tøj"
        }
      ]
    }
  },
  {
    "CategoryId": 11,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Wine"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Vin"
        }
      ],
      "HeaderImage": "3015",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest wine"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor vin"
        }
      ]
    }
  }
]

Update attribute values on multiple categories

patch

A maximum of 5000 categories can be updated in one request

Authorizations

AuthorizationstringRequired

Bodyobject[]

Category attribute values container

CategoryIdinteger · int32Optional

Id of category

Responses

200

OK

No content

patch

/v1/categories/attributevalues

PATCH /v1/categories/attributevalues HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 891

[
  {
    "CategoryId": 10,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Electronics"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Elektronik"
        }
      ],
      "HeaderImage": "3013",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest electronics"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor elektronik"
        }
      ]
    }
  },
  {
    "CategoryId": 11,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Clothing"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Tøj"
        }
      ],
      "HeaderImage": "3014",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest clothing"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor tøj"
        }
      ]
    }
  },
  {
    "CategoryId": 12,
    "Values": {
      "Name": [
        {
          "CultureCode": "en-GB",
          "Data": "Wine"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Vin"
        }
      ],
      "HeaderImage": "3015",
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "See all the latest and greatest wine"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Se alt det nyeste indenfor vin"
        }
      ]
    }
  }
]

200

OK

No content

Get product attributes on category

get

Authorizations

AuthorizationstringRequired

Query parameters

categoryIdinteger · int32Optional

Id of category to get attached attributes from

Responses

200

OK

application/json

Represents an attribute connection to a category in the master catalogue

AttributeUidstring · uuidOptional

Uid of attribute

CategoryIdinteger · int32Optional

Id of category to which the attribute is connected

Ownerinteger · int32Optional

Id of the category at which this connection originates (will be different from category id if this attachment is inherited from a higher level category)

EditableOnEntitiesinteger · enumOptional

Represents where attributes added to categories are editable on entities placed in that category

0 = ProductAndVariant: Attributes are editable on both products and variants
1 = Product: Attributes are editable on products only
2 = Variant: Attributes are editable on variants only
3 = None: Attributes are not editable on any entity

Possible values:

SortOrderinteger · int32 · nullableOptional

Sort order of the attribute

get

/v1/categories/productattributes

GET /v1/categories/productattributes HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "AttributeUid": "fcb89ac2-ce5f-40bd-aee8-2a04abb69f15",
    "CategoryId": 10,
    "Owner": 10,
    "EditableOnEntities": {},
    "SortOrder": null
  },
  {
    "AttributeUid": "75084425-8f7f-471f-963c-48a348c4702e",
    "CategoryId": 10,
    "Owner": 10,
    "EditableOnEntities": {},
    "SortOrder": null
  },
  {
    "AttributeUid": "fdd03133-60ec-43f8-a5da-af122e72eea3",
    "CategoryId": 10,
    "Owner": 10,
    "EditableOnEntities": {},
    "SortOrder": null
  }
]

Attach attribute to a category, which is to be visible to products in that category

post

Authorizations

AuthorizationstringRequired

Query parameters

categoryIdinteger · int32Optional

Id of category to attach attribute to

attributeUidstring · uuidOptional

Uid of attribute to attach

editableOnEntitiesinteger · enumOptional

Represents where attributes added to categories are editable on entities placed in that category

0 = ProductAndVariant: Attributes are editable on both products and variants
1 = Product: Attributes are editable on products only
2 = Variant: Attributes are editable on variants only
3 = None: Attributes are not editable on any entity

Possible values:

sortOrderinteger · int32Optional

Sort order of attribute on category

Responses

200

OK

No content

400

Bad Request

application/json

post

/v1/categories/productattributes

POST /v1/categories/productattributes HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Remove a product attribute from a category

delete

Authorizations

AuthorizationstringRequired

Query parameters

categoryIdinteger · int32Optional

Id of category the attribute is attached to

attributeUidstring · uuidOptional

Uid of attached attribute

Responses

200

OK

No content

delete

/v1/categories/productattributes

DELETE /v1/categories/productattributes HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Update attribute on a category

patch

Authorizations

AuthorizationstringRequired

Query parameters

categoryIdinteger · int32Optional

Id of category the attribute is attached to

attributeUidstring · uuidOptional

Uid of attached attribute

editableOnEntitiesinteger · enumOptional

Represents where attributes added to categories are editable on entities placed in that category

0 = ProductAndVariant: Attributes are editable on both products and variants
1 = Product: Attributes are editable on products only
2 = Variant: Attributes are editable on variants only
3 = None: Attributes are not editable on any entity

Possible values:

sortOrderinteger · int32Optional

Sort order of attribute on category

Responses

200

OK

No content

patch

/v1/categories/productattributes

PATCH /v1/categories/productattributes HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Get references to a category

get

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category

Responses

200

OK

application/json

Model holding references from other entities to a category

CategoryIdinteger · int32Optional

Id of the referenced category

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of global list values referencing this category

get

/v1/categories/{id}/references

GET /v1/categories/{id}/references HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

{
  "CategoryId": 12,
  "ReferencingCategories": [
    {
      "EntityId": 100,
      "AttributeUid": "ca4b398e-d622-43a0-a71f-6d96b30351f2"
    },
    {
      "EntityId": 101,
      "AttributeUid": "ca4b398e-d622-43a0-a71f-6d96b30351f2"
    }
  ],
  "ReferencingProducts": [
    {
      "EntityId": 100010,
      "AttributeUid": "f2dc690f-7dc6-4c1a-949a-ec4082102985"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "f2dc690f-7dc6-4c1a-949a-ec4082102985"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "0050c9f5-c9b3-4fe8-afdc-bfdc46f654fa"
    }
  ],
  "ReferencingVariantGroups": [],
  "ReferencingVariants": [
    {
      "EntityId": 100,
      "AttributeUid": "f2dc690f-7dc6-4c1a-949a-ec4082102985"
    }
  ],
  "ReferencingAssets": [],
  "ReferencingGlobalListValues": [
    "d6175cd5-260f-425d-a628-f528091217f1",
    "930370b3-4f01-4c1f-9f40-9cf04dde36e5"
  ]
}

Get references to a batch of categories

post

#Available from v.3.5.0 No more than 5000 values can be requested at a time.

Authorizations

AuthorizationstringRequired

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

Model holding references from other entities to a category

CategoryIdinteger · int32Optional

Id of the referenced category

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of global list values referencing this category

post

/v1/categories/batch/references

POST /v1/categories/batch/references HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

[
  {
    "CategoryId": 12,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "f9d6d644-5992-4090-a7cc-dea8891ec36b"
      },
      {
        "EntityId": 101,
        "AttributeUid": "f9d6d644-5992-4090-a7cc-dea8891ec36b"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 100010,
        "AttributeUid": "3f9fe511-a70a-45cb-924b-0b9bde11a80d"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "3f9fe511-a70a-45cb-924b-0b9bde11a80d"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "92023b14-fb4e-46e7-8cf2-0ac8057fb644"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 100,
        "AttributeUid": "3f9fe511-a70a-45cb-924b-0b9bde11a80d"
      }
    ],
    "ReferencingAssets": [],
    "ReferencingGlobalListValues": [
      "f49f080d-db06-45e5-8c8c-a09009087931",
      "b7fc107d-b031-4d65-ac6b-f43362c70858"
    ]
  },
  {
    "CategoryId": 20,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "f9d6d644-5992-4090-a7cc-dea8891ec36b"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 23553,
        "AttributeUid": "3f9fe511-a70a-45cb-924b-0b9bde11a80d"
      },
      {
        "EntityId": 5656,
        "AttributeUid": "3f9fe511-a70a-45cb-924b-0b9bde11a80d"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 568323,
        "AttributeUid": "92023b14-fb4e-46e7-8cf2-0ac8057fb644"
      }
    ],
    "ReferencingAssets": [],
    "ReferencingGlobalListValues": [
      "861dcf4d-e9e3-4297-9c45-3d2d26e3564f",
      "d4e50b2b-7c20-4411-9c56-33e0fefe7b46"
    ]
  }
]

Get Enrichment Insights for a category

get

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category to get insights for

Responses

200

OK

application/json

Model representing an entity's enrichment insight

EnrichmentInsightSetupUidstring · uuidOptional

Uid of enrichment insight

EntityIdinteger · int32Optional

Id of entity

Completenessinteger · int32 · nullableOptional

Completeness in percentage (0 - 100). Is null, if ignored is true

IgnoredbooleanOptional

Indicates whether the completeness is ignored for this entity and this enrichment insight

get

/v1/categories/{id}/enrichmentinsights

GET /v1/categories/{id}/enrichmentinsights HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "EnrichmentInsightSetupUid": "b9ab083f-d622-4eba-b273-4a9bf26a3a03",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "731a399b-f61c-48d4-b1c0-251a20d7125a",
    "EntityId": 1974035,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Get Enrichment Insights for a batch of categories

post

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

Model representing an entity's enrichment insight

EnrichmentInsightSetupUidstring · uuidOptional

Uid of enrichment insight

EntityIdinteger · int32Optional

Id of entity

Completenessinteger · int32 · nullableOptional

Completeness in percentage (0 - 100). Is null, if ignored is true

IgnoredbooleanOptional

Indicates whether the completeness is ignored for this entity and this enrichment insight

post

/v1/categories/batch/enrichmentinsights

POST /v1/categories/batch/enrichmentinsights HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

[
  {
    "EnrichmentInsightSetupUid": "32a8bd89-070c-4313-903c-b2bcd53387c5",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "32a8bd89-070c-4313-903c-b2bcd53387c5",
    "EntityId": 1974043,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Get insights for a batch of categories and a specific Enrichment Insight

post

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

enrichmentInsightUidstring · uuidRequired

Uid of enrichment insight to get for batch of categories

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

Model representing an entity's enrichment insight

EnrichmentInsightSetupUidstring · uuidOptional

Uid of enrichment insight

EntityIdinteger · int32Optional

Id of entity

Completenessinteger · int32 · nullableOptional

Completeness in percentage (0 - 100). Is null, if ignored is true

IgnoredbooleanOptional

Indicates whether the completeness is ignored for this entity and this enrichment insight

post

/v1/categories/batch/enrichmentinsights/{enrichmentInsightUid}

POST /v1/categories/batch/enrichmentinsights/{enrichmentInsightUid} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

[
  {
    "EnrichmentInsightSetupUid": "8ee97d42-e0db-4da7-a0d1-13ca15e8680b",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "8ee97d42-e0db-4da7-a0d1-13ca15e8680b",
    "EntityId": 1974043,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Enable or disable an enrichment insight for a category

patch

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of category

enrichmentInsightSetupUidstring · uuidRequired

Uid of enrichment insight to toggle ignore for

ignorebooleanRequired

Indicate whether to ignore the insight for the given enrichment insight and category

Responses

200

OK

No content

patch

/v1/categories/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}

PATCH /v1/categories/{id}/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore} HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Enable or disable an enrichment insight for a batch of categories

patch

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

enrichmentInsightSetupUidstring · uuidRequired

Uid of enrichment insight to toggle ignore for

ignorebooleanRequired

Indicate whether to ignore the insight for the given enrichment insight and categories

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

No content

patch

/v1/categories/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore}

PATCH /v1/categories/batch/enrichmentinsights/{enrichmentInsightSetupUid}/{ignore} HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 3

[
  1
]

200

OK

No content

Get ids of categories matching certain criteria

post

Authorizations

AuthorizationstringRequired

Body

Search model used for searching products or variants in PIM

IncludeArchivedbooleanOptional

Include archived items in result

Responses

200

OK

application/json

integer · int32[]Optional

post

/v1/categories/search

POST /v1/categories/search HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 503

{
  "IncludeArchived": false,
  "QueryModel": {
    "SubQueries": [
      {
        "Filters": [
          {
            "FieldUid": "ReleasedInCountries_NA_NA",
            "QueryOperator": {},
            "FilterValue": "DK"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "SimpleQueryModel"
      },
      {
        "Filters": [
          {
            "FieldUid": "Color.BaseColor.Name_en-GB_NA",
            "QueryOperator": {},
            "FilterValue": "red"
          },
          {
            "FieldUid": "Color.BaseColor.Name_en-GB_NA",
            "QueryOperator": {},
            "FilterValue": "blue"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "SimpleQueryModel"
      }
    ],
    "BooleanOperator": {},
    "QueryModelType": "BooleanQueryModel"
  }
}

200

OK

Get paged result of categories matching certain criteria. Result mapped with headers and item results

post

Authorizations

AuthorizationstringRequired

Body

Extended search model used for searching products or variants in PIM with support for paging and sorting

Pageinteger · int32Optional

PageSizeinteger · int32 · nullableOptional

FieldUidsstring[] · nullableOptional

SortByFieldUidstring · nullableOptional

SortDescendingboolean · nullableOptional

IncludeArchivedbooleanOptional

Include archived items in result

Responses

200

OK

application/json

TotalHitsinteger · int32Optional

Pageinteger · int32Optional

PageSizeinteger · int32Optional

TotalPagesinteger · int32Optional

post

/v1/categories/search/paged

POST /v1/categories/search/paged HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 362

{
  "Page": 1,
  "PageSize": 10,
  "FieldUids": [
    "Id",
    "PIM_Name_1"
  ],
  "SortByFieldUid": "Id",
  "SortDescending": true,
  "IncludeArchived": false,
  "QueryModel": {
    "SubQueries": [
      {
        "Filters": [
          {
            "FieldUid": "ReleasedInCountries_NA_NA",
            "QueryOperator": {},
            "FilterValue": "DK"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "SimpleQueryModel"
      }
    ],
    "BooleanOperator": {},
    "QueryModelType": "BooleanQueryModel"
  }
}

200

OK

{
  "TotalHits": 1,
  "Page": 1,
  "PageSize": 1,
  "TotalPages": 1,
  "ItemListHeaders": [
    {
      "FieldUid": "text",
      "FieldName": "text",
      "FieldType": "text",
      "SupportsSearching": true,
      "SupportsSorting": true
    }
  ],
  "ListItems": [
    {
      "Id": 1,
      "ShownValues": [
        "text"
      ]
    }
  ]
}

Get all available query fields in the PIM installation

get

Authorizations

AuthorizationstringRequired

Responses

200

OK

application/json

Representation of a queryable field in PIM

Uidstring · nullableOptional

Unique id of field in PIM

Namestring · nullableOptional

The display name of the field

SupportsSortingbooleanOptional

If true field can be used for sorting

get

/v1/categories/queryablefields

GET /v1/categories/queryablefields HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "PIM_CategoryIds",
    "Name": "CategoryIds",
    "SupportsSorting": false
  },
  {
    "Uid": "Name_en-GB",
    "Name": "Name (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "Name_da-DK",
    "Name": "Name (da-DK)",
    "SupportsSorting": false
  },
  {
    "Uid": "Description_en-GB",
    "Name": "Description (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "Description_da-DK",
    "Name": "Description (da-DK)",
    "SupportsSorting": false
  }
]

hashtagGet ids of all categories in the system

hashtagGet basic models for categories

hashtagCreate new categories

hashtagDelete multiple categories

hashtagUpdate multiple categories

hashtagGet basic model for a category

hashtagDelete a category

hashtagUpdate category

hashtagGet basic model for a batch of categories

hashtagGet child categories of a specific category

hashtagGet child categories for a range categories

hashtagGet ids of products in a category

hashtagGet ids of products in a categories

hashtagGet the number of products in a category

hashtagGet the number of products in a batch of categories

hashtagGet all identifiers and their internal ids for a specific identifier type

hashtagGet the internal id of a category based on its identifier

hashtagGet internal ids of multiple categories from their identifier

hashtagGet attribute values for the category

hashtagGet attribute values for multiple categories

hashtagUpdate attribute values on multiple categories

hashtagGet product attributes on category

hashtagAttach attribute to a category, which is to be visible to products in that category

hashtagRemove a product attribute from a category

hashtagUpdate attribute on a category

hashtagGet references to a category

hashtagGet references to a batch of categories

hashtagGet Enrichment Insights for a category

hashtagGet Enrichment Insights for a batch of categories

hashtagGet insights for a batch of categories and a specific Enrichment Insight

hashtagEnable or disable an enrichment insight for a category

hashtagEnable or disable an enrichment insight for a batch of categories

hashtagGet ids of categories matching certain criteria

hashtagGet paged result of categories matching certain criteria. Result mapped with headers and item results

hashtagGet all available query fields in the PIM installation

Get ids of all categories in the system

Get basic models for categories

Create new categories

Delete multiple categories

Update multiple categories

Get basic model for a category

Delete a category

Update category

Get basic model for a batch of categories

Get child categories of a specific category

Get child categories for a range categories

Get ids of products in a category

Get ids of products in a categories

Get the number of products in a category

Get the number of products in a batch of categories

Get all identifiers and their internal ids for a specific identifier type

Get the internal id of a category based on its identifier

Get internal ids of multiple categories from their identifier

Get attribute values for the category

Get attribute values for multiple categories

Update attribute values on multiple categories

Get product attributes on category

Attach attribute to a category, which is to be visible to products in that category

Remove a product attribute from a category

Update attribute on a category

Get references to a category

Get references to a batch of categories

Get Enrichment Insights for a category

Get Enrichment Insights for a batch of categories

Get insights for a batch of categories and a specific Enrichment Insight

Enable or disable an enrichment insight for a category

Enable or disable an enrichment insight for a batch of categories

Get ids of categories matching certain criteria

Get paged result of categories matching certain criteria. Result mapped with headers and item results

Get all available query fields in the PIM installation