View Size Guide Endpoint
This endpoint is only available if aerocargo/size-guides is installed.
Structure
Size Guide
Name
|
Type
|
Description
|
Version
|
id |
int |
The id of the size guide |
>=0.1.0 |
type
|
string |
The type of the size guide |
>=2.0.0
|
name |
string |
The name for the size guide |
>=0.1.0 |
heading
|
string |
The heading of the size guide |
>=0.1.0 |
view
|
string |
The view of the size guide |
>=0.1.0 |
content
|
string |
The content of the size guide |
>=2.0.0
|
small_image |
object |
The Small Image |
>=0.1.0 |
medium_image |
object |
The Medium Image |
>=0.1.0 |
large_image |
object |
The Large Image |
>=0.1.0 |
products
|
array |
An array of Product objects |
>=0.1.0 |
manufacturers
|
array |
An array of Manufacturer objects |
>=0.1.0 |
categories
|
array |
An array of Category objects |
>=0.1.0 |
tags
|
array |
An array of Tag objects |
>=0.1.0 |
groups
|
array |
An array of Group objects |
>=0.1.0 |
Group
Name
|
Type
|
Description
|
Version
|
id |
int |
The id of the size guide group |
>=0.1.0 |
heading
|
string |
The heading of the size guide |
>=0.1.0 |
sections
|
array |
An array of Section objects |
>=0.1.0 |
Section
Name
|
Type
|
Description
|
Version
|
id |
int |
The id of the size guide section |
>=0.1.0 |
heading
|
string |
The heading of the size guide section |
>=0.1.0 |
content
|
string |
The content of the size guide section |
>=0.1.0 |
Product
Name
|
Type
|
Description
|
Version
|
id |
int |
The id of the product |
>=0.1.0 |
model
|
string |
The model of the product |
>=0.1.0 |
name |
string |
The name of the product |
>=0.1.0 |
Manufacturer
Name
|
Type
|
Description
|
Version
|
id |
int |
The id of the manufacturer |
>=0.1.0 |
name |
string |
The name of the manufacturer |
>=0.1.0 |
Category
Name
|
Type
|
Description
|
Version
|
id |
int |
The id of the category |
>=0.1.0 |
name |
string |
The name of the category |
>=0.1.0 |
breadcrumb
|
string |
The breadcrumb for the category |
>=0.1.0 |
Tag
Name
|
Type
|
Description
|
Version
|
id |
int |
The id of the tag |
>=0.1.0 |
name |
string |
The name of the tag (e.g., Small or Red) |
>=0.1.0 |
group |
object |
The tag group, see Tag Group |
>=0.1.0 |
Tag Group
Name
|
Type
|
Description
|
Version
|
id |
int |
The id of the tag group |
>=0.1.0 |
name |
string |
The name of the tag group (e.g., Size or Colour) |
>=0.1.0 |
Image
Name
|
Type
|
Description
|
Version
|
url |
string |
The url of the image |
>=0.1.0 |
Example Request
GET /api/size-guides/{id}
Example Response
Example - Version 1.x
{
"id": 1,
"name": "API Test",
"heading": "Test",
"view": "test",
"small_image": {
"url": null
},
"medium_image": {
"url": null
},
"large_image": {
"url": null
},
"products": [],
"manufacturers": [
{
"id": 1,
"name": "Burberry"
}
],
"categories": [
{
"id": 1,
"name": "Coats",
"breadcrumb": "Mens » Coats"
}
],
"tags": [
{
"id": 1,
"name": "Blue",
"group": {
"id": 1,
"name": "Colour"
}
}
],
"groups": [
{
"id": 1,
"heading": "Group Heading",
"sections": [
{
"id": 1,
"heading": "Section Heading",
"content": "Section Content"
}
]
}
]
}
Example - Version 2.x
{
"id": 1,
"type": "rich_text",
"name": "API Test",
"heading": "Test",
"view": "test",
"content": "Section Content",
"small_image": {
"url": null
},
"medium_image": {
"url": null
},
"large_image": {
"url": null
},
"products": [],
"manufacturers": [
{
"id": 1,
"name": "Burberry"
}
],
"categories": [
{
"id": 1,
"name": "Coats",
"breadcrumb": "Mens » Coats"
}
],
"tags": [
{
"id": 1,
"name": "Blue",
"group": {
"id": 1,
"name": "Colour"
}
}
],
"groups": []
}
