# View Size Guide Endpoint

<p class="callout warning">This endpoint is only available if `aerocargo/size-guides` is installed.</p>

## Structure

### Size Guide  


<table border="1" id="bkmrk-name-type-descriptio" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">`id`</td><td style="height: 29.7969px;">int</td><td style="height: 29.7969px;">The id of the size guide</td><td style="height: 29.7969px;">`>=0.1.0`</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">`type`  
</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">The type of the size guide</td><td style="height: 29.7969px;">`>=2.0.0`  
</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">`name`</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">The name for the size guide</td><td style="height: 29.7969px;">`>=0.1.0`</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">`heading`  
</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">The heading of the size guide</td><td style="height: 29.7969px;">`>=0.1.0`</td></tr><tr style="height: 28.7969px;"><td style="height: 28.7969px;">`view`  
</td><td style="height: 28.7969px;">string</td><td style="height: 28.7969px;">The view of the size guide</td><td style="height: 28.7969px;">`>=0.1.0`</td></tr><tr><td>`content`  
</td><td>string</td><td>The content of the size guide</td><td>`>=2.0.0`  
</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`small_image`</td><td style="height: 35.3984px;">object</td><td style="height: 35.3984px;">The Small [Image](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-image)</td><td style="height: 35.3984px;">`>=0.1.0`</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`medium_image`</td><td style="height: 35.3984px;">object</td><td style="height: 35.3984px;">The Medium [Image](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-image)</td><td style="height: 35.3984px;">`>=0.1.0`</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`large_image`</td><td style="height: 35.3984px;">object</td><td style="height: 35.3984px;">The Large [Image](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-image)</td><td style="height: 35.3984px;">`>=0.1.0`</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`products`  
</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Product](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-product) objects</td><td style="height: 35.3984px;">`>=0.1.0`</td></tr><tr style="height: 52.1953px;"><td style="height: 52.1953px;">`manufacturers`  
</td><td style="height: 52.1953px;">array</td><td style="height: 52.1953px;">An array of [Manufacturer](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-manufacturer) objects</td><td style="height: 52.1953px;">`>=0.1.0`</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`categories`  
</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Category](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-category) objects</td><td style="height: 35.3984px;">`>=0.1.0`</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`tags`  
</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Tag](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-tag) objects</td><td style="height: 35.3984px;">`>=0.1.0`</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`groups`  
</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Group](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-group) objects</td><td style="height: 35.3984px;">`>=0.1.0`</td></tr></tbody></table>

### Group

<table border="1" id="bkmrk-name-type-descriptio-1" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the size guide group</td><td>`>=0.1.0`</td></tr><tr><td>`heading`  
</td><td>string</td><td>The heading of the size guide</td><td>`>=0.1.0`</td></tr><tr><td>`sections`  
</td><td>array</td><td>An array of [Section](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-section) objects</td><td>`>=0.1.0`</td></tr></tbody></table>

### Section

<table border="1" id="bkmrk-name-type-descriptio-2" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the size guide section</td><td>`>=0.1.0`</td></tr><tr><td>`heading`  
</td><td>string</td><td>The heading of the size guide section</td><td>`>=0.1.0`</td></tr><tr><td>`content`  
</td><td>string</td><td>The content of the size guide section</td><td>`>=0.1.0`</td></tr></tbody></table>

### Product

<table border="1" id="bkmrk-name-type-descriptio-3" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the product</td><td>`>=0.1.0`</td></tr><tr><td>`model`  
</td><td>string</td><td>The model of the product</td><td>`>=0.1.0`</td></tr><tr><td>`name`</td><td>string</td><td>The name of the product</td><td>`>=0.1.0`</td></tr></tbody></table>

### Manufacturer

<table border="1" id="bkmrk-name-type-descriptio-4" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the manufacturer</td><td>`>=0.1.0`</td></tr><tr><td>`name`</td><td>string</td><td>The name of the manufacturer</td><td>`>=0.1.0`</td></tr></tbody></table>

### Category

<table border="1" id="bkmrk-name-type-descriptio-5" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the category</td><td>`>=0.1.0`</td></tr><tr><td>`name`</td><td>string</td><td>The name of the category</td><td>`>=0.1.0`</td></tr><tr><td>`breadcrumb`  
</td><td>string</td><td>The breadcrumb for the category</td><td>`>=0.1.0`</td></tr></tbody></table>

### Tag

<table border="1" id="bkmrk-name-type-descriptio-6" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the tag</td><td>`>=0.1.0`</td></tr><tr><td>`name`</td><td>string</td><td>The name of the tag (e.g., Small or Red)</td><td>`>=0.1.0`</td></tr><tr><td>`group`</td><td>object</td><td>The tag group, see [Tag Group](https://support.aerocommerce.com/books/api/page/view-size-guide-endpoint#bkmrk-tag-group)</td><td>`>=0.1.0`</td></tr></tbody></table>

### Tag Group

<table border="1" id="bkmrk-name-type-descriptio-7" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr><td>`id`</td><td>int</td><td>The id of the tag group</td><td>`>=0.1.0`</td></tr><tr><td>`name`</td><td>string</td><td>The name of the tag group (e.g., Size or Colour)</td><td>`>=0.1.0`</td></tr></tbody></table>


### Image

<table border="1" id="bkmrk-name-type-descriptio-8" style="border-collapse: collapse; width: 100%; height: 477.765px;"><colgroup><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col><col style="width: 25.0298%;"></col></colgroup><tbody><tr style="height: 29.7969px;"><td style="height: 29.7969px;">**Name**  
</td><td style="height: 29.7969px;">**Type**  
</td><td style="height: 29.7969px;">**Description**  
</td><td style="height: 29.7969px;">**Version**  
</td></tr><tr><td>`url`</td><td>string</td><td>The url of the image</td><td>`>=0.1.0`</td></tr></tbody></table>


## Example Request

```
GET /api/size-guides/{id}
```

## Example Response

<details id="bkmrk-example---version-1."><summary>Example - Version 1.x</summary>

```json
{
    "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"
                }
            ]
        }
    ]
}
```

</details><details id="bkmrk-example---version-2."><summary>Example - Version 2.x</summary>

```json
{
    "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": []
}
```

</details>