Size Guides
· Revision #6
Create Size Guide Endpoint
This endpoint is only available if aerocargo/size-guides is installed.
Structure
Size Guide
Name
|
Type
|
Description
|
Required
|
id |
int |
The id of the size guide |
No |
name |
string |
The name for the size guide |
Yes |
heading
|
string |
The heading of the size guide |
Yes |
view
|
string |
The view of the size guide |
No |
small_image |
object |
The Small Image |
No |
medium_image |
object |
The Medium Image |
No |
large_image |
object |
The Large Image |
No |
products
|
array |
An array of product ids or models |
Conditional * |
manufacturers
|
array |
An array of manufacturer ids or names |
Conditional * |
categories
|
array |
An array of category ids or breadcrumbs |
Conditional * |
tags
|
array |
An array of tag ids or names |
Conditional * |
groups
|
array |
An array of Group objects |
No |
* Either products is required or manufacturers and/or categories and/or tags are.
Group
Name
|
Type
|
Description
|
Required
|
id |
int |
The id of the size guide group |
No |
heading
|
string |
The heading of the size guide |
Yes |
sections
|
array |
An array of Section objects |
No |
Section
Name
|
Type
|
Description
|
Required
|
id |
int |
The id of the size guide section |
No |
heading
|
string |
The heading of the size guide section |
Yes |
content
|
string |
The content of the size guide section |
Yes |
Image
Name
|
Type
|
Description
|
Required
|
src |
string |
The source url of the image |
Yes |
Example Request
POST /api/size-guides/
Example Response
{
"name": "API Test",
"heading": "Test",
"view": "test",
"products": [],
"manufacturers": [
"Burberry",
],
"categories": [
"Mens > Coats",
],
"tags": [
"Blue",
],
"groups": [
{
"heading": "Group Heading",
"sections": [
{
"heading": "Section Heading",
"content": "Section Content"
}
]
}
]
}