Products | Struct Docs

Get ids of all products in the system

get

By default, ids for archived products are not returned

Authorizations

AuthorizationstringRequired

Query parameters

includeArchivedbooleanOptional

Include archived products

Default: false

Responses

200

OK

application/json

integer · int32[]Optional

get

/v1/products/ids

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

200

OK

Get basic model for a product

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product to return

Responses

200

OK

application/json

Represents the root information always present on a product

Idinteger · int32Optional

Unique id of the product

Createdstring · date-timeOptional

Timestamp of the product creation

CreatedBystring · nullableOptional

Username of the user who created the product

LastModifiedstring · date-timeOptional

Timestamp of the last product update

LastModifiedBystring · nullableOptional

Username of the user who made the last change to the product

VariationDefinitionUidstring · uuid · nullableOptional

Variation definition reference. For more information, Struct.App.Api.Models.ProductStructure.VariationDefinition for more information

IsArchivedbooleanOptional

Indicates whether the product is archived

ArchiveReasonstring · uuid · nullableOptional

The uid of the archive reason selected when the product was archived

ProductStructureUidstring · uuidOptional

The uid of the product structure used for this product

WorkflowStateUidstring · uuid · nullableOptional

The uid of the workflow state of the product

get

/v1/products/{id}

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

200

OK

{
  "Id": 2011,
  "Name": {
    "en-GB": "Mascot work pants",
    "da-DK": "Mascot arbejdsbukser"
  },
  "Created": "2026-05-03T22:40:48.7140606+01:00",
  "CreatedBy": "Struct",
  "LastModified": "2026-05-03T22:40:48.7140766+01:00",
  "LastModifiedBy": "Struct",
  "VariationDefinitionUid": "6283cad9-3d03-412f-a5b7-eb7293097ac0",
  "IsArchived": false,
  "ArchiveReason": "b3e9bc68-cacd-4dce-8b2b-e8a0acf2e679",
  "ProductStructureUid": "1fcd275f-83bf-4ede-814e-d34fe9d39459",
  "WorkflowStateUid": "6f55eac5-345b-483f-8448-5586af525ac4",
  "BusinessUnits": [],
  "Classifications": []
}

Delete a product

delete

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product to delete

Responses

200

OK

No content

delete

/v1/products/{id}

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

200

OK

No content

Update a product

patch

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

Body

Update model containing the updates to make on a product. 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 product

ProductStructureUidstring · uuid · nullableOptional

Product structure to set on product

VariationDefinitionUidstring · uuid · nullableOptional

Variation definition to set on product

IsArchivedboolean · nullableOptional

Indicate whether the product shall be archived or un-archived

ArchiveReasonstring · uuid · nullableOptional

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

WorkflowStateUidstring · uuid · nullableOptional

Workflow state to set on the product

Responses

200

OK

No content

patch

/v1/products/{id}

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

{
  "ProductStructureUid": "d5b64069-67bc-42d0-ad69-6ba8260f9505",
  "VariationDefinitionUid": "6597d829-09c0-4430-b597-df22e0193653",
  "IsArchived": null,
  "ArchiveReason": "a42c0d32-407e-42c8-a7f6-729509c9f263",
  "ClassificationsUpdate": {
    "Classifications": [
      {
        "CategoryId": 27,
        "IsPrimary": true,
        "OwnerReference": null,
        "SortOrder": 0
      },
      {
        "CategoryId": 49,
        "IsPrimary": false,
        "OwnerReference": null,
        "SortOrder": 1
      }
    ],
    "UpdateMethod": {},
    "RemoveWhereOwnerReferenceIs": null
  },
  "WorkflowStateUid": "5da4ae98-5f36-4a41-a090-289e200b95d5",
  "BusinessUnits": null,
  "Values": {
    "Description": [
      {
        "CultureCode": "en-GB",
        "Data": "Apples flagship phone"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Apples flagskib"
      }
    ]
  }
}

200

OK

No content

Get basic model for a range of products

post

Authorizations

AuthorizationstringRequired

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

Represents the root information always present on a product

Idinteger · int32Optional

Unique id of the product

Createdstring · date-timeOptional

Timestamp of the product creation

CreatedBystring · nullableOptional

Username of the user who created the product

LastModifiedstring · date-timeOptional

Timestamp of the last product update

LastModifiedBystring · nullableOptional

Username of the user who made the last change to the product

VariationDefinitionUidstring · uuid · nullableOptional

Variation definition reference. For more information, Struct.App.Api.Models.ProductStructure.VariationDefinition for more information

IsArchivedbooleanOptional

Indicates whether the product is archived

ArchiveReasonstring · uuid · nullableOptional

The uid of the archive reason selected when the product was archived

ProductStructureUidstring · uuidOptional

The uid of the product structure used for this product

WorkflowStateUidstring · uuid · nullableOptional

The uid of the workflow state of the product

post

/v1/products/batch

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

[
  1
]

200

OK

[
  {
    "Id": 2011,
    "Name": {
      "en-GB": "Mascot work pants",
      "da-DK": "Mascot arbejdsbukser"
    },
    "Created": "2026-05-03T22:40:48.7224687+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2026-05-03T22:40:48.7224831+01:00",
    "LastModifiedBy": "Struct",
    "VariationDefinitionUid": "fc3b5e13-d9a7-4d38-89a8-9334bdbd5adc",
    "IsArchived": false,
    "ArchiveReason": "287f8772-f57b-431a-8b40-594188316ff3",
    "ProductStructureUid": "905e58b0-6e6b-4ec1-8d67-fd7903d208df",
    "WorkflowStateUid": "0e614097-cc42-4935-85bc-985b2439c81c",
    "BusinessUnits": [],
    "Classifications": []
  },
  {
    "Id": 2012,
    "Name": {
      "en-GB": "Apple Iphone",
      "da-DK": "Apple Iphone"
    },
    "Created": "2026-01-23T22:40:48.7224866+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-12-04T22:40:48.7224874+01:00",
    "LastModifiedBy": "Struct",
    "VariationDefinitionUid": "fc3b5e13-d9a7-4d38-89a8-9334bdbd5adc",
    "IsArchived": false,
    "ArchiveReason": "e3abbac7-0918-4b34-a8f8-97d2276e055d",
    "ProductStructureUid": "905e58b0-6e6b-4ec1-8d67-fd7903d208df",
    "WorkflowStateUid": "f041dd72-036a-4593-812d-c1ffe17b5a93",
    "BusinessUnits": [],
    "Classifications": []
  },
  {
    "Id": 2013,
    "Name": {
      "en-GB": "Samsung 8K series TV",
      "da-DK": "Samsung 8K serie"
    },
    "Created": "2025-11-09T22:40:48.7224891+01:00",
    "CreatedBy": "Struct",
    "LastModified": "2025-11-09T22:40:48.7224899+01:00",
    "LastModifiedBy": "Struct",
    "VariationDefinitionUid": "fc3b5e13-d9a7-4d38-89a8-9334bdbd5adc",
    "IsArchived": false,
    "ArchiveReason": "a105a3b0-cc40-4a07-ae42-9062f96c24e4",
    "ProductStructureUid": "905e58b0-6e6b-4ec1-8d67-fd7903d208df",
    "WorkflowStateUid": "c9c6cb3e-4a65-44e5-b131-f4e0122dc9e3",
    "BusinessUnits": [],
    "Classifications": []
  }
]

Get basic models for products

get

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

Authorizations

AuthorizationstringRequired

Query parameters

includeArchivedbooleanOptional

Include archived products

Default: false

limitinteger · int32Optional

Number of products to return

Default: 1000

afterIdinteger · int32Optional

Only return products with id larger than this value

Responses

200

OK

application/json

Result set of products from a product 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/products

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

200

OK

{
  "Products": [
    {
      "Id": 18,
      "Name": {
        "en-GB": "Mascot work pants",
        "da-DK": "Mascot arbejdsbukser"
      },
      "Created": "2026-05-03T22:40:48.7240334+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2026-05-03T22:40:48.7240367+01:00",
      "LastModifiedBy": "Struct",
      "VariationDefinitionUid": "5fcd6eeb-b25b-44b3-9017-66d348029258",
      "IsArchived": false,
      "ArchiveReason": "f28c4a97-2481-43b4-81ea-eef1415a5d94",
      "ProductStructureUid": "3b692017-1c96-4e35-940e-46c88ec6d9c0",
      "WorkflowStateUid": "40ad1aae-b260-4c20-83fe-f8071c1ae989",
      "BusinessUnits": [
        {
          "AccessPolicy": "OWNER",
          "BusinessUnitUid": "89831104-46ce-4c7e-9990-ac3f1e8efeb8"
        },
        {
          "AccessPolicy": "NON_OWNER",
          "BusinessUnitUid": "da25a741-6bfb-4676-ac19-d59ad0c31d00"
        }
      ],
      "Classifications": []
    },
    {
      "Id": 19,
      "Name": {
        "en-GB": "Apple Iphone",
        "da-DK": "Apple Iphone"
      },
      "Created": "2026-01-23T22:40:48.7240426+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2025-12-04T22:40:48.7240434+01:00",
      "LastModifiedBy": "Struct",
      "VariationDefinitionUid": "5fcd6eeb-b25b-44b3-9017-66d348029258",
      "IsArchived": false,
      "ArchiveReason": "6e665c78-88b0-4275-93a6-2c0d06a9d1ff",
      "ProductStructureUid": "3b692017-1c96-4e35-940e-46c88ec6d9c0",
      "WorkflowStateUid": "b23c2ac5-63dc-46c1-8a5f-5beab960edc8",
      "BusinessUnits": [],
      "Classifications": []
    },
    {
      "Id": 20,
      "Name": {
        "en-GB": "Samsung 8K series TV",
        "da-DK": "Samsung 8K serie"
      },
      "Created": "2025-11-09T22:40:48.7240450+01:00",
      "CreatedBy": "Struct",
      "LastModified": "2025-11-09T22:40:48.7240458+01:00",
      "LastModifiedBy": "Struct",
      "VariationDefinitionUid": "5fcd6eeb-b25b-44b3-9017-66d348029258",
      "IsArchived": false,
      "ArchiveReason": "bba82829-926c-4de7-bea1-9effd33e90a8",
      "ProductStructureUid": "3b692017-1c96-4e35-940e-46c88ec6d9c0",
      "WorkflowStateUid": "acb8a15d-37f4-4861-9f05-98aad100a4bf",
      "BusinessUnits": [],
      "Classifications": []
    }
  ],
  "Total": 20102,
  "Remaining": 20100,
  "LastId": 20
}

Create new products

post

A maximum of 5000 products can be created in one request

Authorizations

AuthorizationstringRequired

Bodyobject[]

Model used to create a new product

ProductStructureUidstring · uuidOptional

Product structure to use for product

VariationDefinitionUidstring · uuid · nullableOptional

Variation definition to use for product

WorkflowStateUidstring · uuid · nullableOptional

Workflow state to set on the product

Responses

200

OK

application/json

integer · int32[]Optional

post

/v1/products

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

[
  {
    "ProductStructureUid": "f8e8706c-5ecc-470e-955c-320c65014893",
    "VariationDefinitionUid": "441adbbc-3eab-453b-b986-cbe46993b1f9",
    "Classifications": [
      {
        "CategoryId": 27,
        "IsPrimary": true,
        "OwnerReference": null,
        "SortOrder": 0
      }
    ],
    "WorkflowStateUid": "673f7ea7-5e7f-4da7-ab47-e0cfe9ce191e",
    "BusinessUnits": null,
    "Values": {
      "Name": "Samsung QE65Q950T",
      "PrimaryImage": "3013",
      "ExtraImage": [
        "2566",
        "5155",
        "5664"
      ],
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "The best Samsung TV ever produced"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Det allerbedste TV Samsung har at byde på"
        }
      ]
    }
  },
  {
    "ProductStructureUid": "f8e8706c-5ecc-470e-955c-320c65014893",
    "VariationDefinitionUid": "441adbbc-3eab-453b-b986-cbe46993b1f9",
    "Classifications": [
      {
        "CategoryId": 58,
        "IsPrimary": true,
        "OwnerReference": null,
        "SortOrder": 0
      }
    ],
    "WorkflowStateUid": "5a92135c-8291-41bf-8fb5-7960d364e525",
    "BusinessUnits": null,
    "Values": {
      "Name": "Apple Iphone 12 Pro",
      "PrimaryImage": "222",
      "ExtraImage": [
        "5654",
        "789",
        "2589"
      ],
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "Apples flagship phone"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Apples flagskib"
        }
      ]
    }
  }
]

200

OK

[
  1
]

Delete multiple products

delete

Authorizations

AuthorizationstringRequired

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

No content

delete

/v1/products

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

[
  1
]

200

OK

No content

Update multiple products

patch

Authorizations

AuthorizationstringRequired

Bodyobject[]

Update model for a product

ProductIdinteger · int32Optional

Id of product to update

Responses

200

OK

No content

patch

/v1/products

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

[
  {
    "ProductId": 20111,
    "UpdateModel": {
      "ProductStructureUid": "569e08d5-eea1-4ef9-aa87-98e52df0709e",
      "VariationDefinitionUid": "041e43c7-216b-4094-a1d3-bc4ae3bd8999",
      "IsArchived": null,
      "ArchiveReason": "14530c5a-7562-47fe-95d2-22d3748fad37",
      "ClassificationsUpdate": null,
      "WorkflowStateUid": "2f94ae5d-c124-480e-b154-c958a5602c77",
      "BusinessUnits": null,
      "Values": {
        "Name": "Samsung QE65Q950T",
        "PrimaryImage": "3013"
      }
    }
  },
  {
    "ProductId": 5635,
    "UpdateModel": {
      "ProductStructureUid": "a483e38c-a002-45f4-a051-791d6a9e9f4b",
      "VariationDefinitionUid": "9ebc5011-c035-488a-8989-3af335838c10",
      "IsArchived": null,
      "ArchiveReason": "524c12a6-d4a6-4a78-a760-dd5f4e0d8656",
      "ClassificationsUpdate": {
        "Classifications": [
          {
            "CategoryId": 27,
            "IsPrimary": true,
            "OwnerReference": null,
            "SortOrder": 0
          },
          {
            "CategoryId": 49,
            "IsPrimary": false,
            "OwnerReference": null,
            "SortOrder": 1
          }
        ],
        "UpdateMethod": {},
        "RemoveWhereOwnerReferenceIs": null
      },
      "WorkflowStateUid": "2242a4f1-6be6-4fa7-96eb-4729ea208eae",
      "BusinessUnits": null,
      "Values": {}
    }
  },
  {
    "ProductId": 18863,
    "UpdateModel": {
      "ProductStructureUid": "6f07285d-e32c-4887-8626-20f9ebd258e8",
      "VariationDefinitionUid": "26cf307e-a794-4eb8-ac52-5de00396ced5",
      "IsArchived": null,
      "ArchiveReason": "71a88c7a-edfa-47a0-bfce-76d8e82a5707",
      "ClassificationsUpdate": {
        "Classifications": [
          {
            "CategoryId": 27,
            "IsPrimary": true,
            "OwnerReference": null,
            "SortOrder": 0
          },
          {
            "CategoryId": 49,
            "IsPrimary": false,
            "OwnerReference": null,
            "SortOrder": 1
          }
        ],
        "UpdateMethod": {},
        "RemoveWhereOwnerReferenceIs": null
      },
      "WorkflowStateUid": "a7347bca-dea1-477e-86b7-ed653e09adfd",
      "BusinessUnits": null,
      "Values": {
        "Description": [
          {
            "CultureCode": "en-GB",
            "Data": "Apples flagship phone"
          },
          {
            "CultureCode": "da-DK",
            "Data": "Apples flagskib"
          }
        ]
      }
    }
  }
]

200

OK

No content

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

get

Authorizations

AuthorizationstringRequired

Path parameters

identifierAliasstringRequired

Alias of identifier type

Responses

200

OK

application/json

Other propertiesinteger · int32Optional

get

/v1/products/identifiers/{identifierAlias}

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

200

OK

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

Get the internal id of a product based on its identifier

get

Authorizations

AuthorizationstringRequired

Path parameters

identifierAliasstringRequired

Alias of identifier type

identifierstringRequired

Identifier value

Responses

200

OK

application/json

integer · int32Optional

get

/v1/products/identifiers/{identifierAlias}/{identifier}

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

200

OK

Get internal ids of multiple products from their identifier

post

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

POST /v1/products/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 product

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

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 product

ProductIdinteger · int32Optional

Id of product

get

/v1/products/{id}/attributevalues

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

200

OK

{
  "ProductId": 2011,
  "Values": {
    "Name": "Samsung QE65Q950T",
    "PrimaryImage": "3013",
    "ExtraImage": [
      "2566",
      "5155",
      "5664"
    ],
    "Description": [
      {
        "CultureCode": "en-GB",
        "Data": "The best Samsung TV ever produced"
      },
      {
        "CultureCode": "da-DK",
        "Data": "Det allerbedste TV Samsung har at byde på"
      }
    ]
  }
}

Get attribute values for multiple products

post

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

Authorizations

AuthorizationstringRequired

Body

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

ProductIdsinteger · int32[] · nullableOptional

Ids of products 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 product

ProductIdinteger · int32Optional

Id of product

post

/v1/products/batch/attributevalues

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

{
  "ProductIds": [
    1
  ],
  "IncludeValues": 1,
  "Scopes": [
    "text"
  ],
  "Aliases": [
    "text"
  ],
  "Uids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "LimitToCultureCodes": [
    "text"
  ],
  "LimitToSegments": [
    "text"
  ],
  "GlobalListValueReferencesOnly": true,
  "FromTimestamp": "2026-02-26T05:03:50.512Z"
}

200

OK

[
  {
    "ProductId": 2011,
    "Values": {
      "Name": "Samsung QE65Q950T",
      "PrimaryImage": "3013",
      "ExtraImage": [
        "2566",
        "5155",
        "5664"
      ],
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "The best Samsung TV ever produced"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Det allerbedste TV Samsung har at byde på"
        }
      ]
    }
  },
  {
    "ProductId": 54698,
    "Values": {
      "Name": "Apple Iphone 12 Pro",
      "PrimaryImage": "222",
      "ExtraImage": [
        "5654",
        "789",
        "2589"
      ],
      "Description": [
        {
          "CultureCode": "en-GB",
          "Data": "Apples flagship phone"
        },
        {
          "CultureCode": "da-DK",
          "Data": "Apples flagskib"
        }
      ]
    }
  }
]

Get category classifications for a product

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

Responses

200

OK

application/json

Holds information on products placement in categories

CategoryIdinteger · int32Optional

Id of category the product is placed in

IsPrimarybooleanOptional

Indication whether this classification is the primary classification for the product

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 products 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 · int32 · nullableOptional

Sort order of the product in this category

IsMasterCataloguebooleanOptional

Indication whether this classification is the master catalogue for the product

CatalogueUidstring · uuidOptional

The catalogue uid of the category the product is classified in

IsDynamicCategorybooleanOptional

Indication whether this classification is a dynamic category

get

/v1/products/{id}/classifications

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

200

OK

[
  {
    "CategoryId": 12,
    "IsPrimary": true,
    "OwnerReference": null,
    "SortOrder": 1,
    "IsMasterCatalogue": false,
    "CatalogueUid": "00000000-0000-0000-0000-000000000000",
    "IsDynamicCategory": false
  },
  {
    "CategoryId": 1202,
    "IsPrimary": false,
    "OwnerReference": null,
    "SortOrder": 3,
    "IsMasterCatalogue": false,
    "CatalogueUid": "00000000-0000-0000-0000-000000000000",
    "IsDynamicCategory": false
  },
  {
    "CategoryId": 27,
    "IsPrimary": false,
    "OwnerReference": null,
    "SortOrder": 12,
    "IsMasterCatalogue": false,
    "CatalogueUid": "00000000-0000-0000-0000-000000000000",
    "IsDynamicCategory": false
  }
]

Update category classifications of a product

post

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

Bodyobject[]

Model for adding or updating a classification of a product

CategoryIdinteger · int32Optional

Id of category the product is placed in

IsPrimarybooleanOptional

Indication whether this classification is the primary classification for the product

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 products 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 · int32 · nullableOptional

Sort order of the product in this category

Responses

200

OK

No content

400

Bad Request

application/json

post

/v1/products/{id}/classifications

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

[
  {
    "CategoryId": 27,
    "IsPrimary": true,
    "OwnerReference": null,
    "SortOrder": 0
  },
  {
    "CategoryId": 49,
    "IsPrimary": false,
    "OwnerReference": null,
    "SortOrder": 1
  }
]

No content

Remove category classifications from a product

delete

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

No content

delete

/v1/products/{id}/classifications

DELETE /v1/products/{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 products

post

Authorizations

AuthorizationstringRequired

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

post

/v1/products/batch/classifications

POST /v1/products/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,
      "IsPrimary": true,
      "OwnerReference": null,
      "SortOrder": 1,
      "IsMasterCatalogue": false,
      "CatalogueUid": "00000000-0000-0000-0000-000000000000",
      "IsDynamicCategory": false
    },
    {
      "CategoryId": 1202,
      "IsPrimary": false,
      "OwnerReference": null,
      "SortOrder": 3,
      "IsMasterCatalogue": false,
      "CatalogueUid": "00000000-0000-0000-0000-000000000000",
      "IsDynamicCategory": false
    },
    {
      "CategoryId": 27,
      "IsPrimary": false,
      "OwnerReference": null,
      "SortOrder": 12,
      "IsMasterCatalogue": false,
      "CatalogueUid": "00000000-0000-0000-0000-000000000000",
      "IsDynamicCategory": false
    }
  ],
  "2325": [
    {
      "CategoryId": 12,
      "IsPrimary": true,
      "OwnerReference": null,
      "SortOrder": 2,
      "IsMasterCatalogue": false,
      "CatalogueUid": "00000000-0000-0000-0000-000000000000",
      "IsDynamicCategory": false
    },
    {
      "CategoryId": 27,
      "IsPrimary": false,
      "OwnerReference": null,
      "SortOrder": 3,
      "IsMasterCatalogue": false,
      "CatalogueUid": "00000000-0000-0000-0000-000000000000",
      "IsDynamicCategory": false
    }
  ],
  "69866": [
    {
      "CategoryId": 27,
      "IsPrimary": true,
      "OwnerReference": null,
      "SortOrder": 1,
      "IsMasterCatalogue": false,
      "CatalogueUid": "00000000-0000-0000-0000-000000000000",
      "IsDynamicCategory": false
    }
  ]
}

Add category classifications to a batch of products

post

Authorizations

AuthorizationstringRequired

Body

Responses

200

OK

No content

post

/v1/products/classifications

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

{
  "30211": [
    {
      "CategoryId": 27,
      "IsPrimary": true,
      "OwnerReference": null,
      "SortOrder": 0
    },
    {
      "CategoryId": 11,
      "IsPrimary": false,
      "OwnerReference": null,
      "SortOrder": 1
    }
  ],
  "30212": [
    {
      "CategoryId": 27,
      "IsPrimary": true,
      "OwnerReference": null,
      "SortOrder": 0
    }
  ]
}

200

OK

No content

Remove category classifications from a batch of products

delete

Authorizations

AuthorizationstringRequired

Bodyobject[]

Model for removing classifications for a product

ProductIdinteger · int32Optional

Id to remove classifications from

CategoryIdsinteger · int32[] · nullableOptional

Categories to remove product from

Responses

200

OK

No content

delete

/v1/products/classifications

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

[
  {
    "ProductId": 302,
    "CategoryIds": [
      23,
      55
    ]
  },
  {
    "ProductId": 56684,
    "CategoryIds": [
      88
    ]
  }
]

200

OK

No content

Get ids of variants of a product

get

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

Query parameters

includeArchivedbooleanOptional

Return ids of archived variants as well

Default: false

Responses

200

OK

application/json

integer · int32[]Optional

get

/v1/products/{id}/variants

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

200

OK

Get ids of variants for a batch of products

post

Authorizations

AuthorizationstringRequired

Query parameters

includeArchivedbooleanOptional

Return ids of archived variants as well

Default: false

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

Other propertiesinteger · int32[]Optional

post

/v1/products/batch/variants

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

[
  1
]

200

OK

Get ids of variant groups associated to a product

get

#Available from v.3.11.0

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

Query parameters

includeArchivedbooleanOptional

Return ids of archived variant groups as well

Default: false

Responses

200

OK

application/json

integer · int32[]Optional

get

/v1/products/{id}/variantgroups

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

200

OK

Get ids of variant groups for a batch of products

post

#Available from v.3.11.0

Authorizations

AuthorizationstringRequired

Query parameters

includeArchivedbooleanOptional

Return ids of archived variant groups as well

Default: false

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

application/json

Other propertiesinteger · int32[]Optional

post

/v1/products/batch/variantgroups

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

[
  1
]

200

OK

Get references to a product

get

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

Responses

200

OK

application/json

Model holding references from other entities to a product

ProductIdinteger · int32Optional

Id of the referenced product

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of global list values referencing this product

get

/v1/products/{id}/references

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

200

OK

{
  "ProductId": 12,
  "ReferencingCategories": [
    {
      "EntityId": 100,
      "AttributeUid": "c812e24c-50fd-46b4-bcf8-30825ebb5ecb"
    },
    {
      "EntityId": 101,
      "AttributeUid": "c812e24c-50fd-46b4-bcf8-30825ebb5ecb"
    }
  ],
  "ReferencingProducts": [
    {
      "EntityId": 100010,
      "AttributeUid": "23f47419-b075-4f4d-9a37-c43fa3e9ce97"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "23f47419-b075-4f4d-9a37-c43fa3e9ce97"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "2f02d8b7-e7f0-4fd0-b55e-e45dc4b7ab2f"
    }
  ],
  "ReferencingVariantGroups": [],
  "ReferencingVariants": [
    {
      "EntityId": 100,
      "AttributeUid": "23f47419-b075-4f4d-9a37-c43fa3e9ce97"
    }
  ],
  "ReferencingAssets": [],
  "ReferencingGlobalListValues": [
    "06ab7b17-b00c-4c95-af47-fb8387f0064e",
    "a0fef412-42db-4486-9ffb-127d0fb8edd0"
  ]
}

Get references to a batch of products

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 product

ProductIdinteger · int32Optional

Id of the referenced product

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of global list values referencing this product

post

/v1/products/batch/references

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

[
  1
]

200

OK

[
  {
    "ProductId": 12,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "35a0d313-7e27-49f7-98e8-3fcb37f0879a"
      },
      {
        "EntityId": 101,
        "AttributeUid": "35a0d313-7e27-49f7-98e8-3fcb37f0879a"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 100010,
        "AttributeUid": "4fb8772c-6d54-4d61-afba-db8d8e4a3405"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "4fb8772c-6d54-4d61-afba-db8d8e4a3405"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "4436ecbd-fde5-4370-8fa5-f0fe8972e167"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 100,
        "AttributeUid": "4fb8772c-6d54-4d61-afba-db8d8e4a3405"
      }
    ],
    "ReferencingAssets": [],
    "ReferencingGlobalListValues": [
      "6d4a3ed8-adeb-4acb-804c-3379181f77c5",
      "ba977f7b-72c1-4f9f-9e30-302afea9ffe1"
    ]
  },
  {
    "ProductId": 20,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "35a0d313-7e27-49f7-98e8-3fcb37f0879a"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 23553,
        "AttributeUid": "4fb8772c-6d54-4d61-afba-db8d8e4a3405"
      },
      {
        "EntityId": 5656,
        "AttributeUid": "4fb8772c-6d54-4d61-afba-db8d8e4a3405"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 568323,
        "AttributeUid": "4436ecbd-fde5-4370-8fa5-f0fe8972e167"
      }
    ],
    "ReferencingAssets": [],
    "ReferencingGlobalListValues": [
      "b6fb1b0c-2739-4a82-97ce-6f9fb3ec1175",
      "cf73c35c-eb9e-482e-8bf2-9f2b4cf530a5"
    ]
  }
]

Get ids of products 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/products/search

POST /v1/products/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 products 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/products/search/paged

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

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

GET /v1/products/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 product

get

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product 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/products/{id}/enrichmentinsights

GET /v1/products/{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 products

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

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

[
  1
]

200

OK

[
  {
    "EnrichmentInsightSetupUid": "fdd264e1-1526-49bf-8e54-8576322b966a",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "fdd264e1-1526-49bf-8e54-8576322b966a",
    "EntityId": 1974043,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

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

post

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

enrichmentInsightUidstringRequired

Query parameters

enrichmentInsightUidstring · uuidOptional

Uid of enrichment insight to get for batch of products

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

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

[
  1
]

200

OK

[
  {
    "EnrichmentInsightSetupUid": "befbc8aa-59b9-46d0-b8ca-cb5bd50feb65",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "befbc8aa-59b9-46d0-b8ca-cb5bd50feb65",
    "EntityId": 1974043,
    "Completeness": 100,
    "MissingData": [],
    "Ignored": false
  }
]

Enable or disable an enrichment insight for a product

patch

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of product

enrichmentInsightSetupUidstring · uuidRequired

Uid of enrichment insight to toggle ignore for

ignorebooleanRequired

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

Responses

200

OK

No content

patch

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

PATCH /v1/products/{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 products

patch

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

enrichmentInsightSetupUidstringRequired

ignorestringRequired

Query parameters

enrichmentInsightSetupUidstring · uuidOptional

Uid of enrichment insight to toggle ignore for

ignorebooleanOptional

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

Bodyinteger · int32[]

integer · int32[]Optional

Responses

200

OK

No content

patch

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

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

[
  1
]

200

OK

No content

hashtagGet ids of all products in the system

hashtagGet basic model for a product

hashtagDelete a product

hashtagUpdate a product

hashtagGet basic model for a range of products

hashtagGet basic models for products

hashtagCreate new products

hashtagDelete multiple products

hashtagUpdate multiple products

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

hashtagGet the internal id of a product based on its identifier

hashtagGet internal ids of multiple products from their identifier

hashtagGet attribute values for a product

hashtagGet attribute values for multiple products

hashtagGet category classifications for a product

hashtagUpdate category classifications of a product

hashtagRemove category classifications from a product

hashtagGet category classifications for a batch of products

hashtagAdd category classifications to a batch of products

hashtagRemove category classifications from a batch of products

hashtagGet ids of variants of a product

hashtagGet ids of variants for a batch of products

hashtagGet ids of variant groups associated to a product

hashtagGet ids of variant groups for a batch of products

hashtagGet references to a product

hashtagGet references to a batch of products

hashtagGet ids of products matching certain criteria

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

hashtagGet all available query fields in the PIM installation

hashtagGet Enrichment Insights for a product

hashtagGet Enrichment Insights for a batch of products

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

hashtagEnable or disable an enrichment insight for a product

hashtagEnable or disable an enrichment insight for a batch of products

Get ids of all products in the system

Get basic model for a product

Delete a product

Update a product

Get basic model for a range of products

Get basic models for products

Create new products

Delete multiple products

Update multiple products

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

Get the internal id of a product based on its identifier

Get internal ids of multiple products from their identifier

Get attribute values for a product

Get attribute values for multiple products

Get category classifications for a product

Update category classifications of a product

Remove category classifications from a product

Get category classifications for a batch of products

Add category classifications to a batch of products

Remove category classifications from a batch of products

Get ids of variants of a product

Get ids of variants for a batch of products

Get ids of variant groups associated to a product

Get ids of variant groups for a batch of products

Get references to a product

Get references to a batch of products

Get ids of products matching certain criteria

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

Get all available query fields in the PIM installation

Get Enrichment Insights for a product

Get Enrichment Insights for a batch of products

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

Enable or disable an enrichment insight for a product

Enable or disable an enrichment insight for a batch of products