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
    • Welcome to Struct PIM 4
    • 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
    • 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

AttributeGroups

PreviousAssetTypesNextAttributes

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.

Delete an attribute group

delete
Authorizations
Query parameters
idinteger · int32Optional

Id of attribute group to delete

Responses
200
OK
400
Bad Request
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
404
Not Found
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"
  }
}
  • GETGet all attribute groups in the system
  • POSTCreate an attribute group
  • PUTUpdate an attribute group
  • DELETEDelete an attribute group
  • GETGet a attribute group from its id

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
400
Bad Request
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
400
Bad Request
404
Not Found
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