AttributeScopes
Attribute scopes are used to organize your attributes in different scopes, so you can easily work with collections of attributes based on their attribute scopes. If for example you want to render a table with all technical specifications for a product on your website, what are the technical specification attributes? By adding the technical specifications attributes to a specific attribute scope, your can easily find the collection of attributes to render in this table.
Use attribute scopes to segment your attributes into different scopes for different purposes
Unique id of scope
Unique alias of scope used to be easily identifiable by humans
POST /v1/attributescopes HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 61
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text"
}
No content
Use attribute scopes to segment your attributes into different scopes for different purposes
Unique id of scope
Unique alias of scope used to be easily identifiable by humans
PUT /v1/attributescopes HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 61
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text"
}
No content
Attribute scopes can only be deleted if no attributes reference the scope
Unique id of attribute scope to delete
DELETE /v1/attributescopes HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
No content
Unique id of attribute scope to get
GET /v1/attributescopes/{uid} HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Accept: */*
{
"Uid": "123e4567-e89b-12d3-a456-426614174000",
"Alias": "text"
}
Wrapper for attribute scope attributes batch query
Attribute scope uids to request attributes for
POST /v1/attributescopes/batch/attributes HTTP/1.1
Host:
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 63
{
"AttributeScopeUids": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
OK
{
"ANY_ADDITIONAL_PROPERTY": [
"123e4567-e89b-12d3-a456-426614174000"
]
}