Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Products

Products are the central element of the system. Product entities contain attribute data, classifications in categories and variants. The data model for products are described by product structures.

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

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

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-11-16T18:51:56.2116696+00:00",
  "CreatedBy": "Struct",
  "LastModified": "2026-11-16T18:51:56.2116711+00:00",
  "LastModifiedBy": "Struct",
  "VariationDefinitionUid": "5d78af57-1807-4b1e-90e1-eab8898e5be2",
  "IsArchived": false,
  "ArchiveReason": "a4fe2a06-a8e9-4f37-9a42-802a7a68055a",
  "ProductStructureUid": "5a39b801-4904-4001-8576-5956eccf0d5c",
  "WorkflowStateUid": "4c469d04-fde5-451a-8541-44d8f489016b",
  "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": "cd487a91-51a5-412a-9d85-ea50c977c59c",
  "VariationDefinitionUid": "f869a265-bcfb-49d4-b847-9277213d75a9",
  "IsArchived": null,
  "ArchiveReason": "a4d97711-0abb-4e5b-9bd8-5f70f0810ddd",
  "ClassificationsUpdate": {
    "Classifications": [
      {
        "CategoryId": 27,
        "IsPrimary": true,
        "OwnerReference": null,
        "SortOrder": 0
      },
      {
        "CategoryId": 49,
        "IsPrimary": false,
        "OwnerReference": null,
        "SortOrder": 1
      }
    ],
    "UpdateMethod": {},
    "RemoveWhereOwnerReferenceIs": null
  },
  "WorkflowStateUid": "1d29b5d5-8ec4-4797-b22f-bcc93b7e8939",
  "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-11-16T18:51:56.2139354+00:00",
    "CreatedBy": "Struct",
    "LastModified": "2026-11-16T18:51:56.2139365+00:00",
    "LastModifiedBy": "Struct",
    "VariationDefinitionUid": "56a391dc-4e57-4127-ac68-4f618b0fb8d5",
    "IsArchived": false,
    "ArchiveReason": "93a6afcf-53d9-4bac-befc-12d532562945",
    "ProductStructureUid": "33b92a37-2008-4188-8b8b-5409a90b682b",
    "WorkflowStateUid": "7da1f451-cd69-4294-8d41-0de8a315f1f7",
    "BusinessUnits": [],
    "Classifications": []
  },
  {
    "Id": 2012,
    "Name": {
      "en-GB": "Apple Iphone",
      "da-DK": "Apple Iphone"
    },
    "Created": "2026-08-08T18:51:56.2139375+00:00",
    "CreatedBy": "Struct",
    "LastModified": "2026-06-19T18:51:56.2139376+00:00",
    "LastModifiedBy": "Struct",
    "VariationDefinitionUid": "56a391dc-4e57-4127-ac68-4f618b0fb8d5",
    "IsArchived": false,
    "ArchiveReason": "e44f5a6c-7e81-4fd9-a6a7-12f41558e662",
    "ProductStructureUid": "33b92a37-2008-4188-8b8b-5409a90b682b",
    "WorkflowStateUid": "3d8f4d34-a2ac-46a9-b0ab-69eda9fe3d0d",
    "BusinessUnits": [],
    "Classifications": []
  },
  {
    "Id": 2013,
    "Name": {
      "en-GB": "Samsung 8K series TV",
      "da-DK": "Samsung 8K serie"
    },
    "Created": "2026-05-25T18:51:56.2139380+00:00",
    "CreatedBy": "Struct",
    "LastModified": "2026-05-25T18:51:56.2139381+00:00",
    "LastModifiedBy": "Struct",
    "VariationDefinitionUid": "56a391dc-4e57-4127-ac68-4f618b0fb8d5",
    "IsArchived": false,
    "ArchiveReason": "0875c6d7-eac6-4c67-9e24-3d4dd1ebba8c",
    "ProductStructureUid": "33b92a37-2008-4188-8b8b-5409a90b682b",
    "WorkflowStateUid": "c5cf9d3a-10bc-4cdd-ae34-7882eb77b9ad",
    "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-11-16T18:51:56.2144954+00:00",
      "CreatedBy": "Struct",
      "LastModified": "2026-11-16T18:51:56.2144964+00:00",
      "LastModifiedBy": "Struct",
      "VariationDefinitionUid": "e41ba49f-3843-4410-810d-82274529c9d9",
      "IsArchived": false,
      "ArchiveReason": "2f202f2f-59a7-4c51-8588-a7b512fb97a2",
      "ProductStructureUid": "d5608af0-4d1c-4ebd-ac21-6b336def57d2",
      "WorkflowStateUid": "89c8d121-f441-443a-bcce-d4d35546f80e",
      "BusinessUnits": [
        {
          "AccessPolicy": "OWNER",
          "BusinessUnitUid": "b916589c-6039-462f-aa37-edf22e3c2a1f"
        },
        {
          "AccessPolicy": "NON_OWNER",
          "BusinessUnitUid": "9a1c9706-7d20-4197-9964-4eabbd020243"
        }
      ],
      "Classifications": []
    },
    {
      "Id": 19,
      "Name": {
        "en-GB": "Apple Iphone",
        "da-DK": "Apple Iphone"
      },
      "Created": "2026-08-08T18:51:56.2145005+00:00",
      "CreatedBy": "Struct",
      "LastModified": "2026-06-19T18:51:56.2145006+00:00",
      "LastModifiedBy": "Struct",
      "VariationDefinitionUid": "e41ba49f-3843-4410-810d-82274529c9d9",
      "IsArchived": false,
      "ArchiveReason": "8828aafc-d82f-43b1-8d45-971256f7531b",
      "ProductStructureUid": "d5608af0-4d1c-4ebd-ac21-6b336def57d2",
      "WorkflowStateUid": "1ac0c688-aa92-443c-9015-d8c058e76d99",
      "BusinessUnits": [],
      "Classifications": []
    },
    {
      "Id": 20,
      "Name": {
        "en-GB": "Samsung 8K series TV",
        "da-DK": "Samsung 8K serie"
      },
      "Created": "2026-05-25T18:51:56.2145010+00:00",
      "CreatedBy": "Struct",
      "LastModified": "2026-05-25T18:51:56.2145011+00:00",
      "LastModifiedBy": "Struct",
      "VariationDefinitionUid": "e41ba49f-3843-4410-810d-82274529c9d9",
      "IsArchived": false,
      "ArchiveReason": "3685a78c-f78b-49d7-b93a-fda8076ca183",
      "ProductStructureUid": "d5608af0-4d1c-4ebd-ac21-6b336def57d2",
      "WorkflowStateUid": "6ccd665e-5fd0-432c-84c4-0358ee5511dd",
      "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 · Struct.App.Api.Models.Product.CreateProductModel[]

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": "71c110a3-1368-48ff-8c18-7fe6e656d9af",
    "VariationDefinitionUid": "cd3241dd-2458-4529-9226-6e816e5cca52",
    "Classifications": [
      {
        "CategoryId": 27,
        "IsPrimary": true,
        "OwnerReference": null,
        "SortOrder": 0
      }
    ],
    "WorkflowStateUid": "3ffcb8b9-2c3a-4e6a-b105-d1f08edbe078",
    "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": "71c110a3-1368-48ff-8c18-7fe6e656d9af",
    "VariationDefinitionUid": "cd3241dd-2458-4529-9226-6e816e5cca52",
    "Classifications": [
      {
        "CategoryId": 58,
        "IsPrimary": true,
        "OwnerReference": null,
        "SortOrder": 0
      }
    ],
    "WorkflowStateUid": "c4940c07-78e9-4e9d-b07a-966f3461bfba",
    "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 · Struct.App.Api.Models.Product.BatchUpdateProductModel[]

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": "47613412-1872-4bd2-a4df-1fbeadeb1e31",
      "VariationDefinitionUid": "88ca0752-a2f6-462c-a01d-0cc7eefdd315",
      "IsArchived": null,
      "ArchiveReason": "bb30ffa0-6651-4707-a011-45da5829e6af",
      "ClassificationsUpdate": null,
      "WorkflowStateUid": "630c894b-fa0b-40c9-9893-74c0e82a84e6",
      "BusinessUnits": null,
      "Values": {
        "Name": "Samsung QE65Q950T",
        "PrimaryImage": "3013"
      }
    }
  },
  {
    "ProductId": 5635,
    "UpdateModel": {
      "ProductStructureUid": "bb9bfb5e-92b0-4a46-87cd-8bb5e7348c99",
      "VariationDefinitionUid": "1a006a5a-aa1f-4760-9a3f-e15b91716d76",
      "IsArchived": null,
      "ArchiveReason": "5aa6f2de-5449-4430-a446-c79d08b358f1",
      "ClassificationsUpdate": {
        "Classifications": [
          {
            "CategoryId": 27,
            "IsPrimary": true,
            "OwnerReference": null,
            "SortOrder": 0
          },
          {
            "CategoryId": 49,
            "IsPrimary": false,
            "OwnerReference": null,
            "SortOrder": 1
          }
        ],
        "UpdateMethod": {},
        "RemoveWhereOwnerReferenceIs": null
      },
      "WorkflowStateUid": "20473c38-a637-408c-b589-35acae105b5d",
      "BusinessUnits": null,
      "Values": {}
    }
  },
  {
    "ProductId": 18863,
    "UpdateModel": {
      "ProductStructureUid": "f3950434-b6cf-4c5b-8bd5-cf18454b3f27",
      "VariationDefinitionUid": "dad5c3c1-b758-468f-b2f4-0de2b6a6e0f0",
      "IsArchived": null,
      "ArchiveReason": "d6d27775-9d88-4d0d-892c-17517423acfa",
      "ClassificationsUpdate": {
        "Classifications": [
          {
            "CategoryId": 27,
            "IsPrimary": true,
            "OwnerReference": null,
            "SortOrder": 0
          },
          {
            "CategoryId": 49,
            "IsPrimary": false,
            "OwnerReference": null,
            "SortOrder": 1
          }
        ],
        "UpdateMethod": {},
        "RemoveWhereOwnerReferenceIs": null
      },
      "WorkflowStateUid": "90d46aa1-49f8-4dc0-9411-10ba7136f0b9",
      "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

1

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-01-01T00:00:00.000Z"
}
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 rendered attribute values for a product

get
Authorizations
AuthorizationstringRequired
Path parameters
idinteger · int32Required

Id of product

Query parameters
renderCultureCodestringOptional

Culture code to use for rendering localized attribute values. If not provided, invariant culture will be used

Responses
200

OK

application/json

Wraps rendered attribute values for a product

ProductIdinteger · int32Optional

Id of the product for which the attribute values are rendered

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

OK

{
  "ProductId": 2011,
  "RenderedValues": [
    {
      "AttributeAlias": "Name",
      "DisplayName": {
        "en-GB": "Name",
        "da-DK": "Navn"
      },
      "RenderedValues": [
        {
          "CultureCode": null,
          "Segment": null,
          "Dimension": null,
          "Value": "Samsung QE65Q950T",
          "Unit": null
        }
      ]
    },
    {
      "AttributeAlias": "Description",
      "DisplayName": {
        "en-GB": "Description",
        "da-DK": "Beskrivelse"
      },
      "RenderedValues": [
        {
          "CultureCode": "en-GB",
          "Segment": null,
          "Dimension": null,
          "Value": "The best Samsung TV ever produced",
          "Unit": null
        },
        {
          "CultureCode": "da-DK",
          "Segment": null,
          "Dimension": null,
          "Value": "Det allerbedste TV Samsung har at byde på",
          "Unit": null
        }
      ]
    },
    {
      "AttributeAlias": "ShortDescription",
      "DisplayName": {
        "en-GB": "Short Description",
        "da-DK": "Kort beskrivelse"
      },
      "RenderedValues": [
        {
          "CultureCode": "en-GB",
          "Segment": "EMEA",
          "Dimension": "Market",
          "Value": "Very nice TV",
          "Unit": null
        },
        {
          "CultureCode": "en-GB",
          "Segment": "ASIA",
          "Dimension": "Market",
          "Value": "Very good TV",
          "Unit": null
        },
        {
          "CultureCode": "da-DK",
          "Segment": "EMEA",
          "Dimension": "Market",
          "Value": "Meget lækkert TV",
          "Unit": null
        },
        {
          "CultureCode": "da-DK",
          "Segment": "ASIA",
          "Dimension": "Market",
          "Value": "Meget godt TV",
          "Unit": null
        }
      ]
    },
    {
      "AttributeAlias": "Weight",
      "DisplayName": {
        "en-GB": "Weight",
        "da-DK": "Vægt"
      },
      "RenderedValues": [
        {
          "CultureCode": null,
          "Segment": null,
          "Dimension": null,
          "Value": "15",
          "Unit": "kg"
        }
      ]
    }
  ]
}

Get rendered attribute values for multiple products

post

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

Authorizations
AuthorizationstringRequired
Body

Define which products 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

RenderCultureCodestring · nullableOptional

Culture code to use for rendering values (eg. to control decimal separator, datetime rendering etc.). If not provided, Invariant culture will be used

Responses
200

OK

application/json

Wraps rendered attribute values for a product

ProductIdinteger · int32Optional

Id of the product for which the attribute values are rendered

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

{
  "ProductIds": [
    1
  ],
  "IncludeValues": 1,
  "Scopes": [
    "text"
  ],
  "Aliases": [
    "text"
  ],
  "Uids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "LimitToCultureCodes": [
    "text"
  ],
  "LimitToSegments": [
    "text"
  ],
  "RenderCultureCode": "text"
}
200

OK

[
  {
    "ProductId": 2011,
    "RenderedValues": [
      {
        "AttributeAlias": "Name",
        "DisplayName": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "RenderedValues": [
          {
            "CultureCode": null,
            "Segment": null,
            "Dimension": null,
            "Value": "Samsung QE65Q950T",
            "Unit": null
          }
        ]
      },
      {
        "AttributeAlias": "Description",
        "DisplayName": {
          "en-GB": "Description",
          "da-DK": "Beskrivelse"
        },
        "RenderedValues": [
          {
            "CultureCode": "en-GB",
            "Segment": null,
            "Dimension": null,
            "Value": "The best Samsung TV ever produced",
            "Unit": null
          },
          {
            "CultureCode": "da-DK",
            "Segment": null,
            "Dimension": null,
            "Value": "Det allerbedste TV Samsung har at byde på",
            "Unit": null
          }
        ]
      },
      {
        "AttributeAlias": "ShortDescription",
        "DisplayName": {
          "en-GB": "Short Description",
          "da-DK": "Kort beskrivelse"
        },
        "RenderedValues": [
          {
            "CultureCode": "en-GB",
            "Segment": "EMEA",
            "Dimension": "Market",
            "Value": "Very nice TV",
            "Unit": null
          },
          {
            "CultureCode": "en-GB",
            "Segment": "ASIA",
            "Dimension": "Market",
            "Value": "Very good TV",
            "Unit": null
          },
          {
            "CultureCode": "da-DK",
            "Segment": "EMEA",
            "Dimension": "Market",
            "Value": "Meget lækkert TV",
            "Unit": null
          },
          {
            "CultureCode": "da-DK",
            "Segment": "ASIA",
            "Dimension": "Market",
            "Value": "Meget godt TV",
            "Unit": null
          }
        ]
      },
      {
        "AttributeAlias": "Weight",
        "DisplayName": {
          "en-GB": "Weight",
          "da-DK": "Vægt"
        },
        "RenderedValues": [
          {
            "CultureCode": null,
            "Segment": null,
            "Dimension": null,
            "Value": "15",
            "Unit": "kg"
          }
        ]
      }
    ]
  },
  {
    "ProductId": 2012,
    "RenderedValues": [
      {
        "AttributeAlias": "Name",
        "DisplayName": {
          "en-GB": "Name",
          "da-DK": "Navn"
        },
        "RenderedValues": [
          {
            "CultureCode": null,
            "Segment": null,
            "Dimension": null,
            "Value": "Philips SQ6532dd",
            "Unit": null
          }
        ]
      },
      {
        "AttributeAlias": "Description",
        "DisplayName": {
          "en-GB": "Description",
          "da-DK": "Beskrivelse"
        },
        "RenderedValues": [
          {
            "CultureCode": "en-GB",
            "Segment": null,
            "Dimension": null,
            "Value": "The best Philips TV ever produced",
            "Unit": null
          },
          {
            "CultureCode": "da-DK",
            "Segment": null,
            "Dimension": null,
            "Value": "Det allerbedste TV Philips har at byde på",
            "Unit": null
          }
        ]
      },
      {
        "AttributeAlias": "ShortDescription",
        "DisplayName": {
          "en-GB": "Short Description",
          "da-DK": "Kort beskrivelse"
        },
        "RenderedValues": [
          {
            "CultureCode": "en-GB",
            "Segment": "EMEA",
            "Dimension": "Market",
            "Value": "Very nice TV",
            "Unit": null
          },
          {
            "CultureCode": "en-GB",
            "Segment": "ASIA",
            "Dimension": "Market",
            "Value": "Very good TV",
            "Unit": null
          },
          {
            "CultureCode": "da-DK",
            "Segment": "EMEA",
            "Dimension": "Market",
            "Value": "Meget lækkert TV",
            "Unit": null
          },
          {
            "CultureCode": "da-DK",
            "Segment": "ASIA",
            "Dimension": "Market",
            "Value": "Meget godt TV",
            "Unit": null
          }
        ]
      },
      {
        "AttributeAlias": "Weight",
        "DisplayName": {
          "en-GB": "Weight",
          "da-DK": "Vægt"
        },
        "RenderedValues": [
          {
            "CultureCode": null,
            "Segment": null,
            "Dimension": null,
            "Value": "10",
            "Unit": "kg"
          }
        ]
      }
    ]
  }
]

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 · Struct.App.Api.Models.Product.SetClassificationModel[]

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
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 · Struct.App.Api.Models.Product.RemoveClassificationsModel[]

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

[
  12544,
  5353,
  56843,
  8865,
  1556
]

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

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

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

[
  12544,
  5353,
  56843,
  8865,
  1556
]

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

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

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": "c335510a-c2e2-4a4b-b840-788408b5c607"
    },
    {
      "EntityId": 101,
      "AttributeUid": "c335510a-c2e2-4a4b-b840-788408b5c607"
    }
  ],
  "ReferencingProducts": [
    {
      "EntityId": 100010,
      "AttributeUid": "df92d73d-6edb-471f-adac-cad3cf84c109"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "df92d73d-6edb-471f-adac-cad3cf84c109"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "8f7d0fe2-3c0c-4a93-8f9d-87c1d1c3dd59"
    }
  ],
  "ReferencingVariantGroups": [],
  "ReferencingVariants": [
    {
      "EntityId": 100,
      "AttributeUid": "df92d73d-6edb-471f-adac-cad3cf84c109"
    }
  ],
  "ReferencingAssets": [],
  "ReferencingGlobalListValues": [
    "2c8cdf77-271a-489d-8f86-723437957610",
    "1c9177c7-0e83-4335-b86b-dd18a598c987"
  ]
}

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": "22ec061e-28f5-4529-a018-1de11469b3ca"
      },
      {
        "EntityId": 101,
        "AttributeUid": "22ec061e-28f5-4529-a018-1de11469b3ca"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 100010,
        "AttributeUid": "87369fd1-7fee-4d9d-927f-9cb10bd39db7"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "87369fd1-7fee-4d9d-927f-9cb10bd39db7"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "9dde85e2-ab79-4845-8f30-a74f387fef0f"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 100,
        "AttributeUid": "87369fd1-7fee-4d9d-927f-9cb10bd39db7"
      }
    ],
    "ReferencingAssets": [],
    "ReferencingGlobalListValues": [
      "faa33621-adae-4fd7-b084-31e1cad2f765",
      "16e1ebf4-fb94-4f84-9e0f-a7c94869762b"
    ]
  },
  {
    "ProductId": 20,
    "ReferencingCategories": [
      {
        "EntityId": 100,
        "AttributeUid": "22ec061e-28f5-4529-a018-1de11469b3ca"
      }
    ],
    "ReferencingProducts": [
      {
        "EntityId": 23553,
        "AttributeUid": "87369fd1-7fee-4d9d-927f-9cb10bd39db7"
      },
      {
        "EntityId": 5656,
        "AttributeUid": "87369fd1-7fee-4d9d-927f-9cb10bd39db7"
      }
    ],
    "ReferencingVariantGroups": [],
    "ReferencingVariants": [
      {
        "EntityId": 568323,
        "AttributeUid": "9dde85e2-ab79-4845-8f30-a74f387fef0f"
      }
    ],
    "ReferencingAssets": [],
    "ReferencingGlobalListValues": [
      "1387f9df-96fa-4dd0-8b9d-a085040d2040",
      "e6066518-36de-44d3-b271-e91d697a0272"
    ]
  }
]

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: 552

{
  "IncludeArchived": false,
  "QueryModel": {
    "SubQueries": [
      {
        "Filters": [
          {
            "FieldUid": "6a5d7f84-1d34-4f96-b5c3-7a6e1d2b4c90_NA_NA",
            "QueryOperator": {},
            "FilterValue": "DK"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "SimpleQueryModel"
      },
      {
        "Filters": [
          {
            "FieldUid": "89b4cda9-d803-4812-9862-51167c809f2c_en-GB_NA",
            "QueryOperator": {},
            "FilterValue": "red"
          },
          {
            "FieldUid": "89b4cda9-d803-4812-9862-51167c809f2c_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 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: 729

{
  "Page": 1,
  "PageSize": 10,
  "FieldUids": [
    "Id",
    "89b4cda9-d803-4812-9862-51167c809f2c_en-GB_NA"
  ],
  "SortByFieldUid": "89b4cda9-d803-4812-9862-51167c809f2c_en-GB_NA",
  "SortDescending": true,
  "IncludeArchived": false,
  "QueryModel": {
    "SubQueries": [
      {
        "Filters": [
          {
            "FieldUid": "6a5d7f84-1d34-4f96-b5c3-7a6e1d2b4c90_NA_NA",
            "QueryOperator": {},
            "FilterValue": "DK"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "SimpleQueryModel"
      },
      {
        "Filters": [
          {
            "FieldUid": "89b4cda9-d803-4812-9862-51167c809f2c_en-GB_NA",
            "QueryOperator": {},
            "FilterValue": "red"
          },
          {
            "FieldUid": "89b4cda9-d803-4812-9862-51167c809f2c_en-GB_NA",
            "QueryOperator": {},
            "FilterValue": "blue"
          }
        ],
        "BooleanOperator": {},
        "QueryModelType": "SimpleQueryModel"
      }
    ],
    "BooleanOperator": {},
    "QueryModelType": "BooleanQueryModel"
  }
}
200

OK

{
  "TotalHits": 55,
  "Page": 1,
  "PageSize": 3,
  "TotalPages": 19,
  "ItemListHeaders": [
    {
      "FieldUid": "Id",
      "FieldName": "Internal Id",
      "FieldType": "string",
      "SupportsSearching": true,
      "SupportsSorting": true
    },
    {
      "FieldUid": "89b4cda9-d803-4812-9862-51167c809f2c_en-GB_NA",
      "FieldName": "Name (en-GB)",
      "FieldType": "string",
      "SupportsSearching": true,
      "SupportsSorting": true
    }
  ],
  "ListItems": [
    {
      "Id": 10021,
      "ShownValues": [
        "10021",
        "Samsung QE65Q950T"
      ]
    },
    {
      "Id": 20311,
      "ShownValues": [
        "20311",
        "Apple Iphone 15 Pro"
      ]
    },
    {
      "Id": 234032,
      "ShownValues": [
        "234032",
        "Red T-Shirt"
      ]
    }
  ]
}

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": "PIM_Name_1",
    "Name": "Internal Name (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "PIM_Name_3",
    "Name": "Internal Name (da-DK)",
    "SupportsSorting": false
  },
  {
    "Uid": "89b4cda9-d803-4812-9862-51167c809f2c_en-GB_NA",
    "Name": "Name (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "89b4cda9-d803-4812-9862-51167c809f2c_da-DK_NA",
    "Name": "Name (da-DK)",
    "SupportsSorting": false
  },
  {
    "Uid": "7f2c7c6e-6d7f-4be0-b239-8db011f4c7a1_en-GB_NA",
    "Name": "Description (en-GB)",
    "SupportsSorting": false
  },
  {
    "Uid": "7f2c7c6e-6d7f-4be0-b239-8db011f4c7a1_da-DK_NA",
    "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": "01b4c950-f779-4aa7-9d5c-67a1ba48388d",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "01b4c950-f779-4aa7-9d5c-67a1ba48388d",
    "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": "135a2f89-a300-48a2-9b0e-c0e8af5dc1cd",
    "EntityId": 1974035,
    "Completeness": 50,
    "MissingData": [
      {
        "Type": "AttributeInsightsDataReference",
        "DataReference": "f9a52541-5712-406b-b4b6-04a94399e00f_9_NA"
      }
    ],
    "Ignored": false
  },
  {
    "EnrichmentInsightSetupUid": "135a2f89-a300-48a2-9b0e-c0e8af5dc1cd",
    "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
PreviousPermissions
NextProduct Structures

Last updated