Struct Docs
Struct.PIM 4
Struct.PIM 4
  • Struct PIM Documentation
  • API Reference
  • Latest updates from Struct HQ
  • Latest updates in Documentation
  • Fundamental concepts
    • Get familiar with Struct PIM
    • Catalogues & categories
    • Products & variants
    • Attributes
    • Product structures
    • Identifiers
    • Global lists
    • Localization & segmentation
    • Revisions & changelog
    • Publications
    • Supplier onboarding portal
  • Tutorials
    • Helpful guides
      • How to search efficiently
      • How to use Import
        • How to import products
        • How to import data into a list property on entities
        • How to import categories
        • How to import with media
        • How to use File templates
    • Example projects
      • Working with the API
  • Integration
    • Integrate with Struct PIM
    • Web API
    • Webhooks
  • Media format
  • API Reference
    • Introduction
    • Endpoints
      • AssetFolders
      • Assets
      • AssetTypes
      • AttributeGroups
      • Attributes
      • AttributeScopes
      • Browse
      • BusinessUnits
      • Catalogues
      • Categories
      • Dimensions
      • Exports
      • EnrichmentInsightSetups
      • GlobalLists
      • Languages
      • Maintenance
      • Miscellaneous
      • Messaging
      • Permissions
      • Products
      • ProductStructures
      • Publications
      • Transactions
      • UserGroup
      • UserRoles
      • Users
      • VariantGroups
      • UserTasks
      • Variants
      • Webhooks
      • Workflows
      • Models
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints

AttributeScopes

PreviousAttributesNextBrowse

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.

Delete an attribute scope

delete

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

Authorizations
Query parameters
uidstring · uuidOptional

Unique id of attribute scope to delete

Responses
200
OK
404
Not Found
delete
DELETE /v1/attributescopes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get a attribute scope from its uid

get
Authorizations
Path parameters
uidstring · uuidRequired

Unique id of attribute scope to get

Responses
200
OK
404
Not Found
get
GET /v1/attributescopes/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Alias": "text"
}
  • GETGet all attribute scopes in the system
  • POSTCreate an attribute scope
  • PUTUpdate an attribute scope
  • DELETEDelete an attribute scope
  • GETGet a attribute scope from its uid
  • POSTGet uids of attributes in scopes

Get all attribute scopes in the system

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

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Alias": "text"
  }
]

Create an attribute scope

post
Authorizations
Body

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
400
Bad Request
post
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

Update an attribute scope

put
Authorizations
Body

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
400
Bad Request
put
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

Get uids of attributes in scopes

post
Authorizations
Body

Wrapper for attribute scope attributes batch query

AttributeScopeUidsstring · uuid[] | nullableOptional

Attribute scope uids to request attributes for

Responses
200
OK
post
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"
  ]
}
200

OK

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