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

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

get/v1/attributes

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

200

[
  {
    "NumberOfDecimals": 2,
    "Unit": "kg",
    "RegEx": null,
    "RegExDescription": null,
    "UpperBound": null,
    "LowerBound": 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": [
      "feb83c14-4f48-473a-ae70-a4b31a489de3"
    ],
    "Localized": false,
    "FallbackLanguage": null,
    "DimensionUid": "6126900e-0643-441a-b55b-f753c1cedf1f",
    "FallbackSegment": "906bed8f-22ae-48ff-a017-6b147c2de240",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "NumberAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false,
    "MetaData": null
  },
  {
    "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": [
      "0921e535-b251-4f27-9ad9-47479a8eb796"
    ],
    "Localized": true,
    "FallbackLanguage": null,
    "DimensionUid": "5999897c-4a70-467c-b546-d830050ab4d9",
    "FallbackSegment": "fb7599be-5bca-4817-929b-66f425f5c6dc",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "TextAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false,
    "MetaData": null
  },
  {
    "AllowMultiselect": false,
    "UploadFolderUid": "5f4633e9-f861-4c11-83bf-93c1994a07de",
    "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": [
      "c3f38d2e-f94e-4d4c-957a-a450eca8bafd"
    ],
    "Localized": true,
    "FallbackLanguage": null,
    "DimensionUid": "592c7708-57a8-462a-9916-c2245260c2ea",
    "FallbackSegment": "1bedcfb3-0cb7-4ba8-8c2a-45c2053c6862",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "AssetReferenceAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false,
    "MetaData": null
  }
]

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
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 821

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "RegEx": null,
  "RegExDescription": null,
  "UpperBound": null,
  "LowerBound": 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": [
    "331ffc97-8bbc-4501-9e88-88335aa5218f"
  ],
  "Localized": false,
  "FallbackLanguage": null,
  "DimensionUid": "d441481d-297f-4d25-85f2-d7c51b039dcb",
  "FallbackSegment": "9041ab3b-a9a5-46e1-a945-81a132d8ee6d",
  "ReadOnly": false,
  "Mandatory": false,
  "Columns": 0,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false,
  "MetaData": null
}

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
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 821

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "RegEx": null,
  "RegExDescription": null,
  "UpperBound": null,
  "LowerBound": 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": [
    "f4e1b0b6-52fb-435a-8d55-affad470109c"
  ],
  "Localized": false,
  "FallbackLanguage": null,
  "DimensionUid": "6ab99948-f8cf-4f58-bea4-962196165b2b",
  "FallbackSegment": "3e8944bf-17c3-41a0-bb92-18e304d38972",
  "ReadOnly": false,
  "Mandatory": false,
  "Columns": 0,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false,
  "MetaData": null
}

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

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

400

Bad Request

application/json

get/v1/attributes/{uid}

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

{
  "NumberOfDecimals": 2,
  "Unit": "kg",
  "RegEx": null,
  "RegExDescription": null,
  "UpperBound": null,
  "LowerBound": 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": [
    "c671d535-0779-47ef-b5cf-f2be2e8ab2aa"
  ],
  "Localized": false,
  "FallbackLanguage": null,
  "DimensionUid": "87cafcc9-bdc9-47cd-bf95-7da7ff42a2cf",
  "FallbackSegment": "e234809d-d4f0-4fd5-a8a5-1d3bc0acb9e9",
  "ReadOnly": false,
  "Mandatory": false,
  "Columns": 0,
  "Unchangeable": false,
  "AttributeType": "NumberAttribute",
  "DisableRevisionLogging": false,
  "DisableIndexing": false,
  "MetaData": null
}

Get a batch of attributes

post

Authorizations

AuthorizationstringRequired

Bodystring · uuid[]

string · uuid[]Optional

Responses

200

application/json

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

400

Bad Request

application/json

post/v1/attributes/batch

POST /v1/attributes/batch HTTP/1.1
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,
    "UpperBound": null,
    "LowerBound": 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": [
      "f6e7e63c-255c-46bd-8f76-40e9fec094c4"
    ],
    "Localized": false,
    "FallbackLanguage": null,
    "DimensionUid": "2c6ede63-01b5-4267-88f7-244d618cea83",
    "FallbackSegment": "e0e2f0e6-3bff-4bee-b510-a153090bffe4",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "NumberAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false,
    "MetaData": null
  },
  {
    "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": [
      "c2ccc8b6-0caa-4ff9-8987-8925d11e7113"
    ],
    "Localized": true,
    "FallbackLanguage": null,
    "DimensionUid": "638908ad-8519-4d56-9c28-789b088bc711",
    "FallbackSegment": "b5f1c168-b755-47ef-9f15-a5e60214436b",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "TextAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false,
    "MetaData": null
  },
  {
    "AllowMultiselect": false,
    "UploadFolderUid": "10a20b96-d406-4c3a-a534-fdac3596d6a3",
    "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": [
      "f006f778-acb2-4e59-846a-52caac1e919a"
    ],
    "Localized": true,
    "FallbackLanguage": null,
    "DimensionUid": "9769efc2-7b3f-4ea3-ad65-1646bbb39720",
    "FallbackSegment": "2e4bb735-87f1-4c43-95d7-0b0921e2be75",
    "ReadOnly": false,
    "Mandatory": false,
    "Columns": 0,
    "Unchangeable": false,
    "AttributeType": "AssetReferenceAttribute",
    "DisableRevisionLogging": false,
    "DisableIndexing": false,
    "MetaData": null
  }
]

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

Model holding references from other entities to an attribute

AttributeUidstring · uuidOptional

Id of the referenced attribute

ReferencingCategoriesinteger · int32[] · nullableOptional

List of categories referencing this attribute for product attribute templating

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of global list values referencing this attribute

ReferencingProductStructuresstring · uuid[] · nullableOptional

List of product structures referencing this attribute

ReferencingVariationDefinitionsstring · uuid[] · nullableOptional

List of variation definitions referencing this attribute

get/v1/attributes/{uid}/references

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

200

{
  "AttributeUid": "eb40a418-1911-4257-bf97-4e546cced8ee",
  "ReferencingCategories": [
    10,
    22,
    31
  ],
  "ReferencesOnCategoryAttributes": [
    {
      "EntityId": 100,
      "AttributeUid": "ec4d411f-44a0-46ac-ada2-e74edddfb287"
    },
    {
      "EntityId": 101,
      "AttributeUid": "ec4d411f-44a0-46ac-ada2-e74edddfb287"
    }
  ],
  "ReferencesOnProductAttributes": [
    {
      "EntityId": 100010,
      "AttributeUid": "b895eba2-24bc-4e4f-8d9d-ec504b561593"
    },
    {
      "EntityId": 100011,
      "AttributeUid": "b895eba2-24bc-4e4f-8d9d-ec504b561593"
    },
    {
      "EntityId": 102354,
      "AttributeUid": "4ea7a42d-54c2-440e-bd40-2a36d9a6687c"
    }
  ],
  "ReferencesOnVariantAttributes": [
    {
      "EntityId": 100,
      "AttributeUid": "b895eba2-24bc-4e4f-8d9d-ec504b561593"
    }
  ],
  "ReferencingGlobalListValues": [
    "329796bc-2096-4bd2-819e-b071b89cd234",
    "0762f9e3-7d52-4012-8f17-7eec223a0643"
  ],
  "ReferencingProductStructures": [
    "abbfa094-a019-4708-87fb-0859fb4187b8"
  ],
  "ReferencingVariationDefinitions": [
    "ae9812a8-4c7a-4419-ba78-6cc4955aded4",
    "0c1b07f3-2955-4c64-807c-e43c790e127d"
  ]
}

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

Model holding references from other entities to an attribute

AttributeUidstring · uuidOptional

Id of the referenced attribute

ReferencingCategoriesinteger · int32[] · nullableOptional

List of categories referencing this attribute for product attribute templating

ReferencingGlobalListValuesstring · uuid[] · nullableOptional

List of global list values referencing this attribute

ReferencingProductStructuresstring · uuid[] · nullableOptional

List of product structures referencing this attribute

ReferencingVariationDefinitionsstring · uuid[] · nullableOptional

List of variation definitions referencing this attribute

post/v1/attributes/batch/references

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

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

200

[
  {
    "AttributeUid": "0884fd9e-e0f3-43ec-8525-1f6dc5d86163",
    "ReferencingCategories": [
      10,
      22,
      31
    ],
    "ReferencesOnCategoryAttributes": [
      {
        "EntityId": 100,
        "AttributeUid": "08e4018b-a1c1-4e8e-9362-460ed41b2ed7"
      },
      {
        "EntityId": 101,
        "AttributeUid": "08e4018b-a1c1-4e8e-9362-460ed41b2ed7"
      }
    ],
    "ReferencesOnProductAttributes": [
      {
        "EntityId": 100010,
        "AttributeUid": "466b67c1-bb3a-4935-a688-1e37c0ea60e7"
      },
      {
        "EntityId": 100011,
        "AttributeUid": "466b67c1-bb3a-4935-a688-1e37c0ea60e7"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "6800aa56-b5c8-468d-a37a-a04173f41a5b"
      }
    ],
    "ReferencesOnVariantAttributes": [
      {
        "EntityId": 100,
        "AttributeUid": "466b67c1-bb3a-4935-a688-1e37c0ea60e7"
      }
    ],
    "ReferencingGlobalListValues": [
      "51ef5a9b-af7d-4c02-837f-d9f91496c7f2",
      "e0b91990-0d03-4c0a-b415-780891b6b328"
    ],
    "ReferencingProductStructures": [
      "2af7f2a6-0be6-4a7b-8a25-b4634a02081f"
    ],
    "ReferencingVariationDefinitions": [
      "e3ef64b0-4d6d-4804-801d-96d48bdca1fa",
      "1944202a-741a-48be-818c-4830e4985d3b"
    ]
  },
  {
    "AttributeUid": "56eb45a8-c287-43a8-a265-d7296b3471ed",
    "ReferencingCategories": [
      10,
      31
    ],
    "ReferencesOnCategoryAttributes": [
      {
        "EntityId": 256,
        "AttributeUid": "08e4018b-a1c1-4e8e-9362-460ed41b2ed7"
      }
    ],
    "ReferencesOnProductAttributes": [
      {
        "EntityId": 24552,
        "AttributeUid": "466b67c1-bb3a-4935-a688-1e37c0ea60e7"
      },
      {
        "EntityId": 102354,
        "AttributeUid": "6800aa56-b5c8-468d-a37a-a04173f41a5b"
      }
    ],
    "ReferencesOnVariantAttributes": [
      {
        "EntityId": 22,
        "AttributeUid": "466b67c1-bb3a-4935-a688-1e37c0ea60e7"
      }
    ],
    "ReferencingGlobalListValues": [
      "c926adc2-c4d6-49ba-84b3-d1ae7d9b7336"
    ],
    "ReferencingProductStructures": [
      "a373c168-08dc-4fc9-9d93-d4b95452b50d",
      "6925ebbc-0da7-495f-9961-60711280c4ff"
    ],
    "ReferencingVariationDefinitions": [
      "2645bc54-e647-481e-bf87-c5742fd7a0a3"
    ]
  }
]

PreviousAttributeGroups NextAttributeScopes

Last updated 1 month ago