Attribute Groups
· Revision #3
View Attribute Group Endpoint
Structure
Attribute Group
Name
|
Type
|
Description
|
name |
string |
The name of the attribute group (e.g., Size or Colour) |
display_as |
string |
The display as of the attribute group (e.g.: dropdown, color_swatches, image_swatches, swatches) |
reference |
string |
The reference of the attribute group |
attributes
|
array |
An array of Attribute objects |
Attribute
Name
|
Type
|
Description
|
name
|
string |
The name of the attribute group (e.g., Size or Colour) |
display_name |
string |
The display name of the attribute |
reference |
string |
The reference of the attribute group |
image |
object |
The Image of the attribute |
tags |
array |
An array of Tag objects |
Tag
Name
|
Type
|
Description
|
name |
string |
The name of the tag (e.g., Small or Red) |
group |
object |
The Tag Group of the tag |
Tag Group
Name
|
Type
|
Description
|
name |
string |
The name of the tag group (e.g., Size or Colour) |
Image
Name
|
Type
|
Description
|
url |
string |
The url of the image |
Example Request
GET /api/attribute-groups/{id|name}
Example Response
{
"id": 1,
"name": "Size",
"display_as": "dropdown",
"reference": null,
"attributes": [
{
"id": 1,
"name": "Small",
"display_name": "",
"reference": null,
"image": {
"url": null
},
"tags": []
}
]
}
