VariantGroups

Variant groups are used to contain data for a group of variants on a product. Variant group entities contain attribute data, classifications in categories and variants. The data model for variant groups are described by product structures.

Get ids of all variant groups in the system

get

By default, ids for archived variant groups are not returned

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

includeArchivedbooleanOptional

Include archived variant groups

Default: false

Responses

200

OK

application/json

integer · int32[]Optional

get

/v1/variantgroups/ids

HTTPcURLJavaScriptPython

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

200

OK

[
  10021,
  20311,
  234032,
  23134,
  53451,
  32433,
  23481
]

Get basic model for a variant group

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group to return

Responses

200

OK

application/json

Represents the root information always present on a variant group

Idinteger · int32Optional

Unique id of the variant group

Createdstring · date-timeOptional

Timestamp of the variant group creation

CreatedBystring · nullableOptional

Username of the user who created the variant group

LastModifiedstring · date-timeOptional

Timestamp of the last variant group update

LastModifiedBystring · nullableOptional

Username of the user who made the last change to the variant group

IsArchivedbooleanOptional

Indicates whether the variant group is archived

ArchiveReasonstring · uuid · nullableOptional

The uid of the archive reason selected when the variant group was archived

ProductIdinteger · int32Optional

The id of the product to which the variant group is associated

SortOrderinteger · int32Optional

The sortorder of the variant group in relation to its associated product

WorkflowStateUidstring · uuid · nullableOptional

The uid of the workflow state of the variant group

get

/v1/variantgroups/{id}

HTTPcURLJavaScriptPython

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

200

OK

{
  "Id": 2011,
  "Name": {
    "en-GB": "Red",
    "da-DK": "Rød"
  },
  "Created": "2026-05-03T22:40:49.0819850+01:00",
  "CreatedBy": "Struct",
  "LastModified": "2026-05-03T22:40:49.0820000+01:00",
  "LastModifiedBy": "Struct",
  "IsArchived": false,
  "ArchiveReason": "11367d87-9e1b-4e9e-b7ab-bb7e269151c6",
  "ProductId": 1254,
  "SortOrder": 1,
  "WorkflowStateUid": "7ae92d73-d768-418d-9a57-4c96efcdaade",
  "BusinessUnits": []
}

Delete a variant group

delete

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group to delete

Responses

200

OK

No content

delete

/v1/variantgroups/{id}

HTTPcURLJavaScriptPython

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

200

OK

No content

Update a variant group

patch

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group

Body

application/json

Update model containing the updates to make on a variant group. Note that properties with null values will be ignored and will not cause an update. This means you should only set properties that shall be updated on the variant group

IsArchivedboolean · nullableOptional

Indicate whether the variant group shall be archived or un-archived

ArchiveReasonstring · uuid · nullableOptional

Reference to the archive reason when archiving variant group (if IsArchived is true)

WorkflowStateUidstring · uuid · nullableOptional

Workflow state to set on the variant group

Responses

200

OK

No content

patch

/v1/variantgroups/{id}

HTTPcURLJavaScriptPython

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

{
  "IsArchived": null,
  "ArchiveReason": "5f3c75f7-2941-4f58-ba0a-d0be34ef4b55",
  "Classifications": [
    {
      "CategoryId": 392,
      "OwnerReference": "ERP",
      "SortOrder": 2
    },
    {
      "CategoryId": 23,
      "OwnerReference": null,
      "SortOrder": 1
    }
  ],
  "WorkflowStateUid": "cd7fe14a-750a-4a41-b301-56ed4bff4ea7",
  "BusinessUnits": null,
  "Values": {
    "Description": [
      {
        "CultureCode": "en-GB",
        "Data": "Nice red T-shirt"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Lækker rød T-shirt"
      }
    ]
  }
}

200

OK

No content

Get basic model for a range of variant groups

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

Represents the root information always present on a variant group

Idinteger · int32Optional

Unique id of the variant group

Createdstring · date-timeOptional

Timestamp of the variant group creation

CreatedBystring · nullableOptional

Username of the user who created the variant group

LastModifiedstring · date-timeOptional

Timestamp of the last variant group update

LastModifiedBystring · nullableOptional

Username of the user who made the last change to the variant group

IsArchivedbooleanOptional

Indicates whether the variant group is archived

ArchiveReasonstring · uuid · nullableOptional

The uid of the archive reason selected when the variant group was archived

ProductIdinteger · int32Optional

The id of the product to which the variant group is associated

SortOrderinteger · int32Optional

The sortorder of the variant group in relation to its associated product

WorkflowStateUidstring · uuid · nullableOptional

The uid of the workflow state of the variant group

post

/v1/variantgroups/batch

HTTPcURLJavaScriptPython

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

[
  1
]

200

OK

[
  {
    "Id": 2011,
    "Name": {
      "en-GB": "Red",
      "da-DK": "Rød"
    },
    "Created": "2026-05-03T22:40:49.0847560+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2026-05-03T22:40:49.0847606+01:00",
    "LastModifiedBy": "Struct",
    "IsArchived": false,
    "ArchiveReason": "f80909a1-5543-48af-b05f-eddad147362d",
    "ProductId": 1254,
    "SortOrder": 1,
    "WorkflowStateUid": "adde64eb-1d15-4067-9c6c-23a48a2cc621",
    "BusinessUnits": []
  },
  {
    "Id": 2012,
    "Name": {
      "en-GB": "Green",
      "da-DK": "Grøn"
    },
    "Created": "2026-01-23T22:40:49.0847626+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-12-04T22:40:49.0847634+01:00",
    "LastModifiedBy": "Struct",
    "IsArchived": false,
    "ArchiveReason": "0c10541c-5565-49d4-b365-9ea53fd4b6a3",
    "ProductId": 1254,
    "SortOrder": 2,
    "WorkflowStateUid": "76fca1bc-6b79-4005-af71-924c344a3d7f",
    "BusinessUnits": []
  },
  {
    "Id": 2013,
    "Name": {
      "en-GB": "Blue",
      "da-DK": "Blå"
    },
    "Created": "2025-11-09T22:40:49.0847650+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-11-09T22:40:49.0847658+01:00",
    "LastModifiedBy": "Struct",
    "IsArchived": false,
    "ArchiveReason": "008a5569-8cc8-488f-ac52-e162f89239ca",
    "ProductId": 1254,
    "SortOrder": 3,
    "WorkflowStateUid": "dbf9adec-9aed-40be-a114-4de3381838ca",
    "BusinessUnits": []
  }
]

Get basic models for variant groups

get

No more than 5000 variant groups can be requested at a time. If no limit is provided, the default limit of 1000 will be used. By default, archived variant groups are not returned

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

includeArchivedbooleanOptional

Include archived variant groups

Default: false

limitinteger · int32Optional

Number of variant groups to return

Default: 1000

afterIdinteger · int32Optional

Only return variant groups with id larger than this value

Responses

200

OK

application/json

Result set of variant groups from a variant group 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/variantgroups

HTTPcURLJavaScriptPython

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

200

OK

{
  "VariantGroups": [
    {
      "Id": 18,
      "Name": {
        "en-GB": "Red",
        "da-DK": "Rød"
      },
      "Created": "2026-05-03T22:40:49.0861895+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2026-05-03T22:40:49.0861951+01:00",
      "LastModifiedBy": "Struct",
      "IsArchived": false,
      "ArchiveReason": "6c12f818-25ea-4476-9800-df9015988965",
      "ProductId": 1254,
      "SortOrder": 1,
      "WorkflowStateUid": "5ff00007-dde8-49b7-9de8-167d5196fff4",
      "BusinessUnits": []
    },
    {
      "Id": 19,
      "Name": {
        "en-GB": "Green",
        "da-DK": "Grøn"
      },
      "Created": "2026-01-23T22:40:49.0861985+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2025-12-04T22:40:49.0861993+01:00",
      "LastModifiedBy": "Struct",
      "IsArchived": false,
      "ArchiveReason": "36ee72a0-172e-4f06-892d-a6e07db42c64",
      "ProductId": 1254,
      "SortOrder": 2,
      "WorkflowStateUid": "73f9ab44-82f8-4c23-9ea1-ec2c9f940c9f",
      "BusinessUnits": []
    },
    {
      "Id": 20,
      "Name": {
        "en-GB": "Blue",
        "da-DK": "Blå"
      },
      "Created": "2025-11-09T22:40:49.0862012+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2025-11-09T22:40:49.0862020+01:00",
      "LastModifiedBy": "Struct",
      "IsArchived": false,
      "ArchiveReason": "20ba1aeb-ed8f-4da1-9f0f-2b64d74ae6ce",
      "ProductId": 1254,
      "SortOrder": 3,
      "WorkflowStateUid": "dee9ffa9-6d0d-4b89-a237-4db3fb329d4d",
      "BusinessUnits": []
    }
  ],
  "Total": 2003,
  "Remaining": 2000,
  "LastId": 20
}

Create new variant groups

post

A maximum of 5000 variant groups can be created in one request

Authorizations

ApiKey

AuthorizationstringRequired

Bodyobject[]

application/json

Model used to create a new variant group

ProductIdinteger · int32Optional

Product to associate variant group to

WorkflowStateUidstring · uuid · nullableOptional

Workflow state to set on the variant group

Responses

200

OK

application/json

integer · int32[]Optional

post

/v1/variantgroups

HTTPcURLJavaScriptPython

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

[
  {
    "ProductId": 2331,
    "Classifications": [
      {
        "CategoryId": 392,
        "OwnerReference": "ERP",
        "SortOrder": 2
      },
      {
        "CategoryId": 23,
        "OwnerReference": null,
        "SortOrder": 1
      }
    ],
    "WorkflowStateUid": "037b8eb3-8315-4dd5-86d0-24a5741d455d",
    "BusinessUnits": null,
    "Values": {
      "Name": "Red T-Shirt",
      "PrimaryImage": "3013",
      "ExtraImage": [
        "2566",
        "5155",
        "5664"
      ],
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "Nice red T-shirt"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Lækker rød T-shirt"
        }
      ]
    }
  },
  {
    "ProductId": 2331,
    "Classifications": [
      {
        "CategoryId": 392,
        "OwnerReference": "ERP",
        "SortOrder": 2
      }
    ],
    "WorkflowStateUid": "7e5a905c-a47e-4d71-8170-3109f839a019",
    "BusinessUnits": null,
    "Values": {
      "Name": "Apple Iphone 12 Pro",
      "PrimaryImage": "222",
      "ExtraImage": [
        "5654",
        "789",
        "2589"
      ],
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "Nice blue T-shirt"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Lækker blå T-shirt"
        }
      ]
    }
  }
]

200

OK

[
  1
]

Delete multiple variant groups

delete

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

No content

delete

/v1/variantgroups

HTTPcURLJavaScriptPython

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

[
  1
]

200

OK

No content

Update multiple variant groups

patch

Authorizations

ApiKey

AuthorizationstringRequired

Bodyobject[]

application/json

Update model for a variant group

VariantGroupIdinteger · int32Optional

Id of variant group to update

Responses

200

OK

No content

patch

/v1/variantgroups

HTTPcURLJavaScriptPython

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

[
  {
    "VariantGroupId": 20111,
    "UpdateModel": {
      "IsArchived": null,
      "ArchiveReason": "4a35c6ec-f459-4b98-83e7-bd6d45f82c50",
      "Classifications": null,
      "WorkflowStateUid": "f3cc4545-a251-4d86-8d7a-e392797bef56",
      "BusinessUnits": null,
      "Values": {
        "Name": "Red T-Shirt",
        "PrimaryImage": "3013"
      }
    }
  },
  {
    "VariantGroupId": 5635,
    "UpdateModel": {
      "IsArchived": null,
      "ArchiveReason": "dfaee4a4-4d50-4862-8890-9c8bc5a66ff3",
      "Classifications": [
        {
          "CategoryId": 392,
          "OwnerReference": "ERP",
          "SortOrder": 2
        },
        {
          "CategoryId": 23,
          "OwnerReference": null,
          "SortOrder": 1
        }
      ],
      "WorkflowStateUid": "290aa9e0-257d-4489-a354-8513a18b3bd7",
      "BusinessUnits": null,
      "Values": {}
    }
  },
  {
    "VariantGroupId": 18863,
    "UpdateModel": {
      "IsArchived": null,
      "ArchiveReason": "820ff4b3-a8e1-4700-ba2a-3936b6fba4d1",
      "Classifications": [
        {
          "CategoryId": 392,
          "OwnerReference": "ERP",
          "SortOrder": 2
        },
        {
          "CategoryId": 23,
          "OwnerReference": null,
          "SortOrder": 1
        }
      ],
      "WorkflowStateUid": "8b907d07-26f5-425f-ade8-bbf7ecadce88",
      "BusinessUnits": null,
      "Values": {
        "Description": [
          {
            "CultureCode": "en-GB",
            "Data": "Nice red T-shirt"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Lækker rød T-shirt"
          }
        ]
      }
    }
  }
]

200

OK

No content

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

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

identifierAliasstringRequired

Alias of identifier type

Responses

200

OK

application/json

Other propertiesinteger · int32Optional

get

/v1/variantgroups/identifiers/{identifierAlias}

HTTPcURLJavaScriptPython

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

200

OK

{
  "5796359512359": 10000,
  "5756525697563": 11012,
  "5756326985442": 15133
}

Get the internal id of a variant group based on its identifier

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

identifierAliasstringRequired

Alias of identifier type

identifierstringRequired

Identifier value

Responses

200

OK

application/json

integer · int32Optional

get

/v1/variantgroups/identifiers/{identifierAlias}/{identifier}

HTTPcURLJavaScriptPython

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

200

OK

1

Get internal ids of multiple variant groups from their identifier

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

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/variantgroups/batch/identifiers

HTTPcURLJavaScriptPython

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

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

200

OK

{
  "5796359512359": 10000,
  "5756525697563": 11012,
  "5756326985442": 15133,
  "5799645384354": null
}

Get attribute values for a variant group

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group

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

Attribute values for a variant group

VariantGroupIdinteger · int32Optional

Id of variant group

404

Not Found

application/json

get

/v1/variantgroups/{id}/attributevalues

HTTPcURLJavaScriptPython

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

{
  "VariantGroupId": 2011,
  "Values": {
    "Name": "Red T-shirt",
    "PrimaryImage": "3013",
    "ExtraImage": [
      "2566",
      "5155",
      "5664"
    ],
    "Description": [
      {
        "CultureCode": "en-GB",
        "Data": "Very nice and beautiful T-shirt"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Flot og lækker T-shirt"
      }
    ]
  }
}

Get attribute values for multiple variant groups

post

No more than 5000 variant groups can be requested at a time.

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

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

VariantGroupIdsinteger · int32[] · nullableOptional

Ids of variant groups 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

Attribute values for a variant group

VariantGroupIdinteger · int32Optional

Id of variant group

post

/v1/variantgroups/batch/attributevalues

HTTPcURLJavaScriptPython

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

{
  "VariantGroupIds": [
    1
  ],
  "IncludeValues": 1,
  "Scopes": [
    "text"
  ],
  "Aliases": [
    "text"
  ],
  "Uids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "LimitToCultureCodes": [
    "text"
  ],
  "LimitToSegments": [
    "text"
  ],
  "GlobalListValueReferencesOnly": true,
  "FromTimestamp": "2026-03-16T16:00:24.556Z"
}

200

OK

[
  {
    "VariantGroupId": 2011,
    "Values": {
      "Name": "Red T-shirt",
      "PrimaryImage": "3013",
      "ExtraImage": [
        "2566",
        "5155",
        "5664"
      ],
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "Very nice and beautiful T-shirt"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Flot og lækker T-shirt"
        }
      ]
    }
  },
  {
    "VariantGroupId": 54698,
    "Values": {
      "Name": "Green T-shirt",
      "PrimaryImage": "222",
      "ExtraImage": [
        "5654",
        "789",
        "2589"
      ],
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "Very nice T-shirt in premium quality"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Flot og lækker T-shirt i premium kvalitet"
        }
      ]
    }
  }
]

Get category classifications for a variant group

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group

Responses

200

OK

application/json

Holds information on variant group placement in categories

CategoryIdinteger · int32Optional

Id of category the variant group is placed in

OwnerReferencestring · nullableOptional

A reference to where this classification comes from. If the classification is made in the PIM interface, this will be null. When creating or updating classifications of variant groups through API this can be set to any value. Thus, classifications made from the API can be distinguished from those made directly in the UI

SortOrderinteger · int32Optional

Sort order of the variant group in this category

get

/v1/variantgroups/{id}/classifications

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "CategoryId": 12,
    "OwnerReference": null,
    "SortOrder": 1
  },
  {
    "CategoryId": 1202,
    "OwnerReference": null,
    "SortOrder": 3
  },
  {
    "CategoryId": 27,
    "OwnerReference": "ERP",
    "SortOrder": 12
  }
]

Add category classifications to a variant group

post

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group

Bodyobject[]

application/json

Holds information on variant group placement in categories

CategoryIdinteger · int32Optional

Id of category the variant group is placed in

OwnerReferencestring · nullableOptional

A reference to where this classification comes from. If the classification is made in the PIM interface, this will be null. When creating or updating classifications of variant groups through API this can be set to any value. Thus, classifications made from the API can be distinguished from those made directly in the UI

SortOrderinteger · int32Optional

Sort order of the variant group in this category

Responses

200

OK

No content

post

/v1/variantgroups/{id}/classifications

HTTPcURLJavaScriptPython

POST /v1/variantgroups/{id}/classifications HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 112

[
  {
    "CategoryId": 25,
    "OwnerReference": "ERP",
    "SortOrder": 30
  },
  {
    "CategoryId": 27,
    "OwnerReference": null,
    "SortOrder": 21
  }
]

200

OK

No content

Remove category classifications from a variant group

delete

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

No content

delete

/v1/variantgroups/{id}/classifications

HTTPcURLJavaScriptPython

DELETE /v1/variantgroups/{id}/classifications HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 11

[
  265,
  88,
  27
]

200

OK

No content

Get category classifications for a batch of variant groups

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

post

/v1/variantgroups/batch/classifications

HTTPcURLJavaScriptPython

POST /v1/variantgroups/batch/classifications HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

[
  2003,
  2325,
  69866
]

200

OK

{
  "2003": [
    {
      "CategoryId": 12,
      "OwnerReference": "ERP",
      "SortOrder": 1
    },
    {
      "CategoryId": 1202,
      "OwnerReference": null,
      "SortOrder": 3
    },
    {
      "CategoryId": 27,
      "OwnerReference": null,
      "SortOrder": 12
    }
  ],
  "2325": [
    {
      "CategoryId": 12,
      "OwnerReference": "ERP",
      "SortOrder": 2
    },
    {
      "CategoryId": 27,
      "OwnerReference": null,
      "SortOrder": 3
    }
  ],
  "69866": [
    {
      "CategoryId": 27,
      "OwnerReference": null,
      "SortOrder": 1
    }
  ]
}

Add category classifications to a batch of variant groups

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Responses

200

OK

No content

post

/v1/variantgroups/classifications

HTTPcURLJavaScriptPython

POST /v1/variantgroups/classifications HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 186

{
  "2001": [
    {
      "CategoryId": 25,
      "OwnerReference": "ERP",
      "SortOrder": 30
    },
    {
      "CategoryId": 27,
      "OwnerReference": null,
      "SortOrder": 21
    }
  ],
  "2011": [
    {
      "CategoryId": 25,
      "OwnerReference": "ERP",
      "SortOrder": 31
    }
  ]
}

200

OK

No content

Remove category classifications from a batch of variant groups

delete

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Other propertiesinteger · int32[]Optional

Responses

200

OK

No content

delete

/v1/variantgroups/classifications

HTTPcURLJavaScriptPython

DELETE /v1/variantgroups/classifications HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "1001": [
    10,
    21,
    22
  ],
  "1204": [
    301
  ]
}

200

OK

No content

Get ids of variants of a variant group

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group

Query parameters

includeArchivedbooleanOptional

Return ids of archived variants as well

Default: false

Responses

200

OK

application/json

integer · int32[]Optional

get

/v1/variantgroups/{id}/variants

HTTPcURLJavaScriptPython

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

200

OK

[
  12544,
  5353,
  56843,
  8865,
  1556
]

Get ids of variants for a batch of variant groups

post

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

includeArchivedbooleanOptional

Return ids of archived variants as well

Default: false

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

Other propertiesinteger · int32[]Optional

post

/v1/variantgroups/batch/variants

HTTPcURLJavaScriptPython

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

[
  1
]

200

OK

{
  "5646": [
    7424,
    5454,
    4404
  ],
  "10006": [
    12544,
    5353,
    56843,
    8865,
    1556
  ]
}

Get references to a variant group

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group

Responses

200

OK

application/json

Model holding references from other entities to a variant group

VariantGroupIdinteger · int32Optional

Id of the referenced variant group

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of global list values referencing this variant group

get

/v1/variantgroups/{id}/references

HTTPcURLJavaScriptPython

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

200

OK

{
  "VariantGroupId": 12,
  "ReferencingCategories": [
    {
      "EntityId": 100,
      "AttributeUid": "8f3c1584-1ad6-4fe4-9bae-612b1de5eb60"
    },
    {
      "EntityId": 101,
      "AttributeUid": "8f3c1584-1ad6-4fe4-9bae-612b1de5eb60"
    }
  ],
  "ReferencingProducts": [
    {
      "EntityId": 100010,
      "AttributeUid": "2e9fbaa0-d216-4593-886f-89a9f79a79e9"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "2e9fbaa0-d216-4593-886f-89a9f79a79e9"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "4b092c61-23bf-4c3e-8df9-53a5f421b637"
    }
  ],
  "ReferencingVariantGroups": [],
  "ReferencingVariants": [
    {
      "EntityId": 100,
      "AttributeUid": "2e9fbaa0-d216-4593-886f-89a9f79a79e9"
    }
  ],
  "ReferencingAssets": [],
  "ReferencingGlobalListValues": [
    "d177480d-3596-439e-898f-28610e25089c",
    "511effd0-3234-4326-b3a9-acd2ea5df666"
  ]
}

Get references to a batch of variant groups

post

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

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

application/json

Model holding references from other entities to a variant group

VariantGroupIdinteger · int32Optional

Id of the referenced variant group

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of global list values referencing this variant group

post

/v1/variantgroups/batch/references

HTTPcURLJavaScriptPython

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

[
  1
]

200

OK

[
  {
    "VariantGroupId": 12,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "9a3135f2-9977-4811-ac75-5da55afa948f"
      },
      {
        "EntityId": 101,
        "AttributeUid": "9a3135f2-9977-4811-ac75-5da55afa948f"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 100010,
        "AttributeUid": "6558ded3-a97c-4250-ae06-3c2e326a9c0c"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "6558ded3-a97c-4250-ae06-3c2e326a9c0c"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "aefb98e5-0183-49e9-8e78-131413354c56"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 100,
        "AttributeUid": "6558ded3-a97c-4250-ae06-3c2e326a9c0c"
      }
    ],
    "ReferencingAssets": [],
    "ReferencingGlobalListValues": [
      "112e5601-093d-4f86-9731-bcab4b43d8d6",
      "60d05bd8-22b0-4d97-b564-8073c7e286ba"
    ]
  },
  {
    "VariantGroupId": 20,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "9a3135f2-9977-4811-ac75-5da55afa948f"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 23553,
        "AttributeUid": "6558ded3-a97c-4250-ae06-3c2e326a9c0c"
      },
      {
        "EntityId": 5656,
        "AttributeUid": "6558ded3-a97c-4250-ae06-3c2e326a9c0c"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 568323,
        "AttributeUid": "aefb98e5-0183-49e9-8e78-131413354c56"
      }
    ],
    "ReferencingAssets": [],
    "ReferencingGlobalListValues": [
      "58ae4ba3-502f-49b9-a9fd-125b93a330c0",
      "bdc2e3c9-cb1b-4ba6-abab-4b957d285881"
    ]
  }
]

Get ids of variant groups matching certain criteria

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

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/variantgroups/search

HTTPcURLJavaScriptPython

POST /v1/variantgroups/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

[
  10021,
  20311,
  234032,
  23134,
  53451,
  32433,
  23481
]

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

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

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/variantgroups/search/paged

HTTPcURLJavaScriptPython

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

{
  "Page": 1,
  "PageSize": 10,
  "FieldUids": [
    "Id",
    "Color.BaseColor.Name_en-GB_NA"
  ],
  "SortByFieldUid": "Color.BaseColor.Name_en-GB_NA",
  "SortDescending": true,
  "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

{
  "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

ApiKey

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/variantgroups/queryablefields

HTTPcURLJavaScriptPython

GET /v1/variantgroups/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
  }
]

Get Enrichment Insights for a variant group

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group 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/variantgroups/{id}/enrichmentinsights

HTTPcURLJavaScriptPython

GET /v1/variantgroups/{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 variant groups

post

Authorizations

ApiKey

AuthorizationstringRequired

Bodyinteger · int32[]

application/json

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/variantgroups/batch/enrichmentinsights

HTTPcURLJavaScriptPython

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

[
  1
]

200

OK

[
  {
    "EnrichmentInsightSetupUid": "29ca30bc-2435-47a4-9501-611c1c566af9",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "29ca30bc-2435-47a4-9501-611c1c566af9",
    "EntityId": 1974043,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Get insights for a batch of variant groups and a specific Enrichment Insight

post

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

enrichmentInsightUidstring · uuidRequired

Uid of enrichment insight to get for batch of variant groups

Bodyinteger · int32[]

application/json

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/variantgroups/batch/enrichmentinsights/{enrichmentInsightUid}

HTTPcURLJavaScriptPython

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

[
  1
]

200

OK

[
  {
    "EnrichmentInsightSetupUid": "8df9689e-cb9c-44cc-a7d6-11905dc38414",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "8df9689e-cb9c-44cc-a7d6-11905dc38414",
    "EntityId": 1974043,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Enable or disable an enrichment insight for a variant group

patch

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of variant group

enrichmentInsightSetupUidstring · uuidRequired

Uid of enrichment insight to toggle ignore for

ignorebooleanRequired

Indicate whether to ignore the insight for the given enrichment insight and variant groups

Responses

200

OK

No content

patch

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

HTTPcURLJavaScriptPython

PATCH /v1/variantgroups/{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 variant groups

patch

Authorizations

ApiKey

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 variant groups

Bodyinteger · int32[]

application/json

integer · int32[]Optional

Responses

200

OK

No content

patch

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

HTTPcURLJavaScriptPython

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

[
  1
]

200

OK

No content