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.

Get all attribute scopes in the system

get

Authorizations

ApiKey

AuthorizationstringRequired

Responses

200

OK

application/json

get

/v1/attributescopes

HTTPcURLJavaScriptPython

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

200

OK

[
  {
    "Uid": "f99a9ea0-fb0e-41c0-81f4-15c6b8fe72a8",
    "Alias": "ProductMasterData"
  },
  {
    "Uid": "85894ec1-740b-40f9-a96a-c8f4c683c23c",
    "Alias": "SpecificationData"
  }
]

Create an attribute scope

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Use attribute scopes to segment your attributes into different scopes for different purposes

Uidstring · uuidOptional

Unique id of scope

Aliasstring | nullableOptional

Unique alias of scope used to be easily identifiable by humans

Responses

200

OK

No content

400

Bad Request

application/json

post

/v1/attributescopes

HTTPcURLJavaScriptPython

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

{
  "Uid": "2f34cd5c-9775-4088-9065-65a6658cf9ac",
  "Alias": "ProductMasterData"
}

No content

Update an attribute scope

put

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Use attribute scopes to segment your attributes into different scopes for different purposes

Uidstring · uuidOptional

Unique id of scope

Aliasstring | nullableOptional

Unique alias of scope used to be easily identifiable by humans

Responses

200

OK

No content

400

Bad Request

application/json

put

/v1/attributescopes

HTTPcURLJavaScriptPython

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

{
  "Uid": "0ae06e83-a6c0-4a6b-b33e-b1348756582a",
  "Alias": "NewScopeAlias"
}

No content

Delete an attribute scope

delete

Attribute scopes can only be deleted if no attributes reference the scope

Authorizations

ApiKey

AuthorizationstringRequired

Query parameters

uidstring · uuidOptional

Unique id of attribute scope to delete

Responses

200

OK

No content

404

Not Found

application/json

delete

/v1/attributescopes

HTTPcURLJavaScriptPython

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

No content

Get a attribute scope from its uid

get

Authorizations

ApiKey

AuthorizationstringRequired

Path parameters

uidstring · uuidRequired

Unique id of attribute scope to get

Responses

200

OK

application/json

404

Not Found

application/json

get

/v1/attributescopes/{uid}

HTTPcURLJavaScriptPython

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

{
  "Uid": "218247cc-d8c8-4ca5-8b9e-3d2aec02fc19",
  "Alias": "ProductMasterData"
}

Get uids of attributes in scopes

post

Authorizations

ApiKey

AuthorizationstringRequired

Body

application/json

Wrapper for attribute scope attributes batch query

AttributeScopeUidsstring · uuid[] | nullableOptional

Attribute scope uids to request attributes for

Responses

200

OK

application/json

post

/v1/attributescopes/batch/attributes

HTTPcURLJavaScriptPython

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

{
  "AttributeScopeUids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

200

OK

{
  "d49f0bdc-df44-47b4-88c9-8873f581f22e": [
    "90cf6392-126b-49d7-8925-fa016182564e",
    "0337cb98-a402-4372-9cf3-9d3fe7a54215"
  ],
  "1b8c9639-0202-41ea-a721-78e22cb9a212": [
    "bcc41e0a-97e0-4f3f-8df1-5ce33d84fc85",
    "b10e1548-afa6-474e-bd45-6881bd6b7d3b"
  ]
}