Attributes

Attributes are the central element in the system. They describe the data fields available on entities such as products, variants, categories and global list values. A range of attribute types exist to allow for flexible modelling of your data structure.

Get all attributes in the system

get

Authorizations

AuthorizationstringRequired

Responses

200

application/json

get

/v1/attributes

GET /v1/attributes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

[
  {
    "NumberOfDecimals": 2,
    "Unit": "kg",
    "RegEx": null,
    "RegExDescription": null,
    "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
    "Alias": "Weight",
    "BackofficeName": "Weight",
    "BackofficeDescription": "Add the net weight of the product",
    "Name": {
      "en-GB": "Weight",
      "da-DK": "Vægt"
    },
    "Description": {
      "en-GB": "Net weight of product",
      "da-DK": "Produktets nettovægt"
    },
    "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
    "AttributeScopes": [
      "e447468a-809c-475e-8862-6cbdda1e41e2"
    ],
    "Localized": false,
    "FallbackLanguage": null,
    "DimensionUid": "b5e23312-f037-4e42-94f0-b1e2581a4884",
    "FallbackSegment": "c0dfc578-462b-4c78-af39-cbf8ff7e91db",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "NumberAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  {
    "UseMultiRowInput": false,
    "InputHeight": null,
    "UseRichText": false,
    "RichTextToolbarOptions": [],
    "RegEx": null,
    "RegExDescription": null,
    "Unit": null,
    "ShowCharacterCount": true,
    "MaxLength": 500,
    "EnableAIAssistant": false,
    "Uid": "7e978dcb-fb0a-44c0-a71c-a4bb785db979",
    "Alias": "ProductName",
    "BackofficeName": "Product name",
    "BackofficeDescription": "Add the name of the product",
    "Name": {
      "en-GB": "Weight",
      "da-DK": "Vægt"
    },
    "Description": {
      "en-GB": "Name of product",
      "da-DK": "Produktets navn"
    },
    "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
    "AttributeScopes": [
      "6500cac1-7cfc-4d98-adaa-0766f32c412f"
    ],
    "Localized": true,
    "FallbackLanguage": null,
    "DimensionUid": "05483031-6ea3-41d9-b5a1-3858e1ddadbb",
    "FallbackSegment": "5ede37da-7579-46a9-a06c-c4a275e9b1ae",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "TextAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  {
    "AllowMultiselect": false,
    "UploadFolderUid": "8698ea87-15ff-44b7-9d41-ca8372b6cbf9",
    "AllowedSelectionTypes": [
      "image"
    ],
    "Uid": "e1b8cb77-d709-4768-ae32-28165ba40494",
    "Alias": "PrimaryImage",
    "BackofficeName": "Primary image",
    "BackofficeDescription": "Select the primary image to display for the product",
    "Name": {
      "en-GB": "Image",
      "da-DK": "Billede"
    },
    "Description": {
      "en-GB": "Image of product",
      "da-DK": "Produktets billede"
    },
    "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
    "AttributeScopes": [
      "9b2c807b-c4d2-43b9-bb0f-6d1a1694df45"
    ],
    "Localized": true,
    "FallbackLanguage": null,
    "DimensionUid": "9fad7e7e-8bc7-4a0a-9f17-df47ecb436ee",
    "FallbackSegment": "cc52be3f-33b4-4223-bfca-9d3c4920c4c1",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "AssetReferenceAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  }
]

Create an attribute

post

Authorizations

AuthorizationstringRequired

Body

Represents an attribute in Struct PIM which can be attached to product, variant or category data models

Uidstring · uuidOptional

Unique id of attribute

Aliasstring | nullableOptional

Unique alias of attribute. Max length is 50 characters and can only consist of letters a-z/A-Z and numbers 0-9 (but cannot start with a number)

BackofficeNamestring | nullableOptional

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescriptionstring | nullableOptional

The description of the attribute displayed to the editor in the PIM backoffice

AttributeGroupUidstring · uuid | nullableOptional

The id of the attribute group this attribute is placed within

AttributeScopesstring · uuid[] | nullableOptional

Unique ids of the attribute scopes this attribute is placed within

LocalizedbooleanOptional

Indicates whether values of this attribute are localized

FallbackLanguageinteger · int32 | nullableOptional

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUidstring · uuid | nullableOptional

Unique id of Dimension to segment values of this attribute on

FallbackSegmentstring · uuid | nullableOptional

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnlybooleanOptional

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

MandatorybooleanOptional

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Columnsinteger · int32Optional

The number of columns this attribute should span in the PIM backoffice (1-12)

UnchangeablebooleanOptional

Indicates whether this attribute cannot change its value, once it has a value assigned. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

AttributeTypestring | nullableRead-onlyOptional

Type of attribute

DisableRevisionLoggingbooleanOptional

Disable all revision logging for this attribute

DisableIndexingbooleanOptional

Disable indexing for this attribute

Responses

200

No content

400

Bad Request

application/json

post

/v1/attributes

POST /v1/attributes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 769

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "RegEx": null,
  "RegExDescription": null,
  "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
  "Alias": "Weight",
  "BackofficeName": "Weight",
  "BackofficeDescription": "Add the net weight of the product",
  "Name": {
    "en-GB": "Weight",
    "da-DK": "Vægt"
  },
  "Description": {
    "en-GB": "Net weight of product",
    "da-DK": "Produktets nettovægt"
  },
  "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
  "AttributeScopes": [
    "81402cea-4b95-4ea4-943d-9e4db92014b7"
  ],
  "Localized": false,
  "FallbackLanguage": null,
  "DimensionUid": "d68fe658-dd27-44ce-bcc6-df2b60f1d165",
  "FallbackSegment": "7d508d2b-03aa-4530-b775-eb2abd35cb30",
  "ReadOnly": false,
  "Mandatory": false,
  "Columns": 0,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false
}

No content

Update an attribute

put

Authorizations

AuthorizationstringRequired

Body

Represents an attribute in Struct PIM which can be attached to product, variant or category data models

Uidstring · uuidOptional

Unique id of attribute

Aliasstring | nullableOptional

Unique alias of attribute. Max length is 50 characters and can only consist of letters a-z/A-Z and numbers 0-9 (but cannot start with a number)

BackofficeNamestring | nullableOptional

The name of the attribute displayed to the editor in the PIM backoffice

BackofficeDescriptionstring | nullableOptional

The description of the attribute displayed to the editor in the PIM backoffice

AttributeGroupUidstring · uuid | nullableOptional

The id of the attribute group this attribute is placed within

AttributeScopesstring · uuid[] | nullableOptional

Unique ids of the attribute scopes this attribute is placed within

LocalizedbooleanOptional

Indicates whether values of this attribute are localized

FallbackLanguageinteger · int32 | nullableOptional

Indicates a fallback language in case attribute is localized and no value is added to a specific language

DimensionUidstring · uuid | nullableOptional

Unique id of Dimension to segment values of this attribute on

FallbackSegmentstring · uuid | nullableOptional

Indicates a fallback segment in case attribute is dimensioned and no value is added to a specific segment of that dimension

ReadOnlybooleanOptional

Indicates whether this attribute is always readonly. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

MandatorybooleanOptional

Indicates whether this attribute is always mandatory. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

Columnsinteger · int32Optional

The number of columns this attribute should span in the PIM backoffice (1-12)

UnchangeablebooleanOptional

Indicates whether this attribute cannot change its value, once it has a value assigned. NOTE: Only applied when attribute is a sub attribute of a complex attribute.

AttributeTypestring | nullableRead-onlyOptional

Type of attribute

DisableRevisionLoggingbooleanOptional

Disable all revision logging for this attribute

DisableIndexingbooleanOptional

Disable indexing for this attribute

Responses

200

No content

400

Bad Request

application/json

put

/v1/attributes

PUT /v1/attributes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 769

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "RegEx": null,
  "RegExDescription": null,
  "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
  "Alias": "Weight",
  "BackofficeName": "Weight",
  "BackofficeDescription": "Add the net weight of the product",
  "Name": {
    "en-GB": "Weight",
    "da-DK": "Vægt"
  },
  "Description": {
    "en-GB": "Net weight of product",
    "da-DK": "Produktets nettovægt"
  },
  "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
  "AttributeScopes": [
    "8ff65645-428a-4c99-b60a-3a4c8689b2bf"
  ],
  "Localized": false,
  "FallbackLanguage": null,
  "DimensionUid": "52b645a1-d431-481f-8195-b4e14158b0c7",
  "FallbackSegment": "72457ec1-f34b-45c5-8958-3aa1b0f551d0",
  "ReadOnly": false,
  "Mandatory": false,
  "Columns": 0,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false
}

No content

Delete an attribute

delete

Authorizations

AuthorizationstringRequired

Query parameters

uidstring · uuidOptional

Unique id of attribute to delete

Responses

200

No content

400

Bad Request

application/json

delete

/v1/attributes

DELETE /v1/attributes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get a specific attribute

get

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of attribute to get

Responses

200

application/json

400

Bad Request

application/json

get

/v1/attributes/{uid}

GET /v1/attributes/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "RegEx": null,
  "RegExDescription": null,
  "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
  "Alias": "Weight",
  "BackofficeName": "Weight",
  "BackofficeDescription": "Add the net weight of the product",
  "Name": {
    "en-GB": "Weight",
    "da-DK": "Vægt"
  },
  "Description": {
    "en-GB": "Net weight of product",
    "da-DK": "Produktets nettovægt"
  },
  "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
  "AttributeScopes": [
    "47f80a00-4810-4a3d-8744-c84b2f848db1"
  ],
  "Localized": false,
  "FallbackLanguage": null,
  "DimensionUid": "bc13e5be-b0e3-4759-8375-2b1b2496ddf6",
  "FallbackSegment": "6aa08b67-b4db-4bcf-bbd2-5b2e7da76464",
  "ReadOnly": false,
  "Mandatory": false,
  "Columns": 0,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false
}

Get a batch of attributes

post

Authorizations

AuthorizationstringRequired

Bodystring · uuid[]

string · uuid[]Optional

Responses

200

application/json

400

Bad Request

application/json

post

/v1/attributes/batch

POST /v1/attributes/batch HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 118

[
  "630d5c4d-770e-4095-a262-48637f18ad57",
  "7e978dcb-fb0a-44c0-a71c-a4bb785db979",
  "e1b8cb77-d709-4768-ae32-28165ba40494"
]

[
  {
    "NumberOfDecimals": 2,
    "Unit": "kg",
    "RegEx": null,
    "RegExDescription": null,
    "Uid": "630d5c4d-770e-4095-a262-48637f18ad57",
    "Alias": "Weight",
    "BackofficeName": "Weight",
    "BackofficeDescription": "Add the net weight of the product",
    "Name": {
      "en-GB": "Weight",
      "da-DK": "Vægt"
    },
    "Description": {
      "en-GB": "Net weight of product",
      "da-DK": "Produktets nettovægt"
    },
    "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
    "AttributeScopes": [
      "99adf41d-f461-477d-a157-be549096d821"
    ],
    "Localized": false,
    "FallbackLanguage": null,
    "DimensionUid": "9afc3971-f95d-49b1-9b6e-68bc97d018ae",
    "FallbackSegment": "dfc2ab38-ae3e-43fa-b5c4-9ba15041adf0",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "NumberAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  {
    "UseMultiRowInput": false,
    "InputHeight": null,
    "UseRichText": false,
    "RichTextToolbarOptions": [],
    "RegEx": null,
    "RegExDescription": null,
    "Unit": null,
    "ShowCharacterCount": true,
    "MaxLength": 500,
    "EnableAIAssistant": false,
    "Uid": "7e978dcb-fb0a-44c0-a71c-a4bb785db979",
    "Alias": "ProductName",
    "BackofficeName": "Product name",
    "BackofficeDescription": "Add the name of the product",
    "Name": {
      "en-GB": "Weight",
      "da-DK": "Vægt"
    },
    "Description": {
      "en-GB": "Name of product",
      "da-DK": "Produktets navn"
    },
    "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
    "AttributeScopes": [
      "f7a76621-ec1f-4908-824a-fab200493f06"
    ],
    "Localized": true,
    "FallbackLanguage": null,
    "DimensionUid": "8734dcfd-c1c9-4c04-802d-5dea932a407a",
    "FallbackSegment": "0653e3ad-a567-478a-8312-3bfbb826a2c1",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "TextAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  },
  {
    "AllowMultiselect": false,
    "UploadFolderUid": "a7d5bc61-51b4-4999-ac77-71268682efc0",
    "AllowedSelectionTypes": [
      "image"
    ],
    "Uid": "e1b8cb77-d709-4768-ae32-28165ba40494",
    "Alias": "PrimaryImage",
    "BackofficeName": "Primary image",
    "BackofficeDescription": "Select the primary image to display for the product",
    "Name": {
      "en-GB": "Image",
      "da-DK": "Billede"
    },
    "Description": {
      "en-GB": "Image of product",
      "da-DK": "Produktets billede"
    },
    "AttributeGroupUid": "34b11ec3-24e2-4f23-a08e-e7dc49070154",
    "AttributeScopes": [
      "374d37c8-2071-4b5b-b651-10a06022f256"
    ],
    "Localized": true,
    "FallbackLanguage": null,
    "DimensionUid": "df66e371-f089-4d4f-bf88-d697abb77e61",
    "FallbackSegment": "5ca9af9d-fddc-4bbe-b326-6041e43c7beb",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "AssetReferenceAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false
  }
]

Get references to an attribute from other attributes

get

#Available from v.3.5.0

Authorizations

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Uid of attribute

Responses

200

application/json

get

/v1/attributes/{uid}/references

GET /v1/attributes/{uid}/references HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

{
  "AttributeUid": "d0a44406-6eb0-4073-ae55-56b3fe431858",
  "ReferencingCategories": [
    10,
    22,
    31
  ],
  "ReferencesOnCategoryAttributes": [
    {
      "EntityId": 100,
      "AttributeUid": "b61521f0-9663-48c9-95b3-c3d26bc561da"
    },
    {
      "EntityId": 101,
      "AttributeUid": "b61521f0-9663-48c9-95b3-c3d26bc561da"
    }
  ],
  "ReferencesOnProductAttributes": [
    {
      "EntityId": 100010,
      "AttributeUid": "c653bea3-766f-469e-aeaf-b031ebc7cdfe"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "c653bea3-766f-469e-aeaf-b031ebc7cdfe"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "de0f6fc0-ba4c-48ce-915a-39adca9ce163"
    }
  ],
  "ReferencesOnVariantAttributes": [
    {
      "EntityId": 100,
      "AttributeUid": "c653bea3-766f-469e-aeaf-b031ebc7cdfe"
    }
  ],
  "ReferencingGlobalListValues": [
    "ea48dc6a-a382-4468-8c19-6ba3669ce176",
    "04a42b43-c6f7-48cc-b5ce-13ba0bd8e977"
  ],
  "ReferencingProductStructures": [
    "e7237861-ad7e-4fb0-bb33-a65ecb9fe6a4"
  ],
  "ReferencingVariationDefinitions": [
    "de85521f-08ff-4982-8b2b-842e2f7c1fea",
    "a64b9ba6-0cf5-4e88-b3cd-5c8f55f3f5d5"
  ]
}

Get references from other attributes to a batch of attributes

post

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

Authorizations

AuthorizationstringRequired

Bodystring · uuid[]

string · uuid[]Optional

Responses

200

application/json

post

/v1/attributes/batch/references

POST /v1/attributes/batch/references HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

200

[
  {
    "AttributeUid": "a56dbfda-f785-4791-a5b4-7c0d1e41c84e",
    "ReferencingCategories": [
      10,
      22,
      31
    ],
    "ReferencesOnCategoryAttributes": [
      {
        "EntityId": 100,
        "AttributeUid": "35c3f93d-35e5-465d-86f2-9c1e9ef4559f"
      },
      {
        "EntityId": 101,
        "AttributeUid": "35c3f93d-35e5-465d-86f2-9c1e9ef4559f"
      }
    ],
    "ReferencesOnProductAttributes": [
      {
        "EntityId": 100010,
        "AttributeUid": "0bf86dbc-afa0-4351-a2a3-40dbea6fc9ef"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "0bf86dbc-afa0-4351-a2a3-40dbea6fc9ef"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "1060820c-0830-43fc-9065-0a184daaa018"
      }
    ],
    "ReferencesOnVariantAttributes": [
      {
        "EntityId": 100,
        "AttributeUid": "0bf86dbc-afa0-4351-a2a3-40dbea6fc9ef"
      }
    ],
    "ReferencingGlobalListValues": [
      "d206dccc-c756-4a59-a6bf-96f39f19f2ad",
      "e7bd9c6f-6a5b-47ef-84bb-aa011ce9339d"
    ],
    "ReferencingProductStructures": [
      "2be7c2d2-38ee-466e-ad5f-6a2ed896a919"
    ],
    "ReferencingVariationDefinitions": [
      "656334a4-4a29-40a6-b568-b97975f16f1b",
      "847ba1ed-8765-4ce5-813c-806ea954ecf7"
    ]
  },
  {
    "AttributeUid": "5d59cba1-7063-4fb5-ab20-19f48865d4d2",
    "ReferencingCategories": [
      10,
      31
    ],
    "ReferencesOnCategoryAttributes": [
      {
        "EntityId": 256,
        "AttributeUid": "35c3f93d-35e5-465d-86f2-9c1e9ef4559f"
      }
    ],
    "ReferencesOnProductAttributes": [
      {
        "EntityId": 24552,
        "AttributeUid": "0bf86dbc-afa0-4351-a2a3-40dbea6fc9ef"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "1060820c-0830-43fc-9065-0a184daaa018"
      }
    ],
    "ReferencesOnVariantAttributes": [
      {
        "EntityId": 22,
        "AttributeUid": "0bf86dbc-afa0-4351-a2a3-40dbea6fc9ef"
      }
    ],
    "ReferencingGlobalListValues": [
      "c691bd87-d76b-4954-a392-e1f615b8ebfe"
    ],
    "ReferencingProductStructures": [
      "3dc0704b-aa78-4845-9b96-bdaeef021558",
      "b381d2d5-0309-465c-b583-b883d6c62019"
    ],
    "ReferencingVariationDefinitions": [
      "bdf51495-88e6-4b8b-9710-cd12c478ae20"
    ]
  }
]

PreviousAttributeGroups NextAttributeScopes

Last updated 1 month ago