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

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/attributegroups

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "Id": 2,
    "Uid": "00000000-0000-0000-0000-000000000000",
    "Alias": "SizeAndWeight",
    "BackofficeName": "",
    "BackofficeDescription": null,
    "SortOrder": 1,
    "Name": {
      "en-GB": "Size & weight",
      "da-DK": "Størrelse & vægt"
    }
  },
  {
    "Id": 4,
    "Uid": "00000000-0000-0000-0000-000000000000",
    "Alias": "MechanicalProperties",
    "BackofficeName": "",
    "BackofficeDescription": null,
    "SortOrder": 2,
    "Name": {
      "en-GB": "Mechanical properties",
      "da-DK": "Mekaniske egenskaber"
    }
  }
]

Create an attribute group

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

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

application/json

Responseinteger · int32

400

Bad Request

application/json

post

/v1/attributegroups

HTTPcURLJavaScriptPython

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

{
  "Id": 0,
  "Uid": "00000000-0000-0000-0000-000000000000",
  "Alias": "MechanicalProperties",
  "BackofficeName": "",
  "BackofficeDescription": null,
  "SortOrder": 2,
  "Name": {
    "en-GB": "Mechanical properties",
    "da-DK": "Mekaniske egenskaber"
  }
}

4

Update an attribute group

put

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

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

No content

400

Bad Request

application/json

404

Not Found

application/json

put

/v1/attributegroups

HTTPcURLJavaScriptPython

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

{
  "Id": 4,
  "Uid": "00000000-0000-0000-0000-000000000000",
  "Alias": "MechanicalProperties",
  "BackofficeName": "",
  "BackofficeDescription": null,
  "SortOrder": 4,
  "Name": {
    "en-GB": "Mechanical properties",
    "da-DK": "Mekaniske egenskaber"
  }
}

No content

Delete an attribute group

delete

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

idinteger · int32Optional

Id of attribute group to delete

Responses

200

OK

No content

400

Bad Request

application/json

delete

/v1/attributegroups

HTTPcURLJavaScriptPython

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

No content

Get a attribute group from its id

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

idinteger · int32Required

Id of attribute group to get

Responses

200

OK

application/json

404

Not Found

application/json

get

/v1/attributegroups/{id}

HTTPcURLJavaScriptPython

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

{
  "Id": 4,
  "Uid": "00000000-0000-0000-0000-000000000000",
  "Alias": "MechanicalProperties",
  "BackofficeName": "",
  "BackofficeDescription": null,
  "SortOrder": 2,
  "Name": {
    "en-GB": "Mechanical properties",
    "da-DK": "Mekaniske egenskaber"
  }
}