AttributeGroups

Attribute groups are used to organize attributes in the system for easy presentation in groups on different channels. Eg. if you want to display a long list of technical specifications, but grouped under different headlines, attribute groups are here for that purpose.

Get all attribute groups in the system

get
Authorizations
Responses
200
OK
get
GET /v1/attributegroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

OK

[
  {
    "Id": 1,
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text",
    "BackofficeName": "text",
    "BackofficeDescription": "text",
    "SortOrder": 1,
    "Name": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
]

Create an attribute group

post
Authorizations
Body

Represents an attribute group used to organize attributes within

Idinteger · int32Optional

Assigned sequential id of attribute group (is unique)

Uidstring · uuidOptional

Unique uid of attribute group

Aliasstring | nullableOptional

Unique alias of attribute group

BackofficeNamestring | nullableOptional

Name of attribute group shown in the backoffice

BackofficeDescriptionstring | nullableOptional

Description of attribute group shown in the backoffice

SortOrderinteger · int32Optional

Sort order of the attribute group used to sort attribute groups between each other

Responses
200
OK
Responseinteger · int32
post
POST /v1/attributegroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 179

{
  "Id": 1,
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "BackofficeName": "text",
  "BackofficeDescription": "text",
  "SortOrder": 1,
  "Name": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
1

Update an attribute group

put
Authorizations
Body

Represents an attribute group used to organize attributes within

Idinteger · int32Optional

Assigned sequential id of attribute group (is unique)

Uidstring · uuidOptional

Unique uid of attribute group

Aliasstring | nullableOptional

Unique alias of attribute group

BackofficeNamestring | nullableOptional

Name of attribute group shown in the backoffice

BackofficeDescriptionstring | nullableOptional

Description of attribute group shown in the backoffice

SortOrderinteger · int32Optional

Sort order of the attribute group used to sort attribute groups between each other

Responses
200
OK
put
PUT /v1/attributegroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 179

{
  "Id": 1,
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "BackofficeName": "text",
  "BackofficeDescription": "text",
  "SortOrder": 1,
  "Name": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
No content

Delete an attribute group

delete
Authorizations
Query parameters
idinteger · int32Optional

Id of attribute group to delete

Responses
200
OK
delete
DELETE /v1/attributegroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get a attribute group from its id

get
Authorizations
Path parameters
idinteger · int32Required

Id of attribute group to get

Responses
200
OK
get
GET /v1/attributegroups/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Id": 1,
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text",
  "BackofficeName": "text",
  "BackofficeDescription": "text",
  "SortOrder": 1,
  "Name": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}
PreviousAssetTypesNextAttributes