# View Collection Endpoint

## Structure

### Collection

<table border="1" id="bkmrk-name-type-descriptio" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Type**  
</td><td>**Description**  
</td></tr><tr><td>`name`</td><td>string</td><td>The name of the collection</td></tr><tr><td>`slug`</td><td>string</td><td>The slug of the collection</td></tr><tr><td>`reference`</td><td>string</td><td>The reference of the collection</td></tr><tr><td>`logic`</td><td>string</td><td>The logic of the rules for the collection</td></tr><tr><td>`rules`</td><td>array</td><td>The listing page rules of the collection, see [Rule](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-rule)</td></tr><tr><td>`content`</td><td>object</td><td>The listing page content of the collection, see [Content](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-content)</td></tr><tr><td>`options`</td><td>object</td><td>The listing page options of the collection, see [Options](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-options)</td></tr><tr><td>`seo`</td><td>object</td><td>The [SEO](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-seo) of the collection</td></tr><tr><td>`additional_attributes`</td><td>array</td><td>An array of [Additional Attribute](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-additional-attribute) objects</td></tr><tr><td>`settings`</td><td>object</td><td>A [Settings](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-settings) object with grouped key-value pairs</td></tr></tbody></table>

### Image

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

### Tag

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

### Tag Group

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

### Rule

<table border="1" id="bkmrk-name-type-descriptio-5" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Type**  
</td><td>**Description**  
</td></tr><tr><td>`type`</td><td>string</td><td>The type of the rule</td></tr><tr><td>`requirement`</td><td>string</td><td>The requirement of the rule</td></tr><tr><td>`logic`</td><td>string</td><td>The logic of the rule</td></tr><tr><td>`data`</td><td>object</td><td>The data for the rule, required keys vary based on `type` of the rule</td></tr><tr><td>`data.tags`</td><td>array</td><td>An array of [Tag](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-tag) objects for a `have_tags` rule</td></tr><tr><td>`data.manufacturers.*.id`</td><td>int</td><td>The manufacturer id for a `have_manufacturers` rule</td></tr><tr><td>`data.manufacturers.*.name`</td><td>string</td><td>The manufacturer name for a `have_manufacturers` rule</td></tr><tr><td>`data.price_list.id`</td><td>int</td><td>The price list id for an `in_price_list` rule</td></tr><tr><td>`data.price_list.name`</td><td>string</td><td>The price list name for an `in_price_list` rule</td></tr><tr><td>`data.category.id`</td><td>int</td><td>The category id for an `in_category` rule</td></tr><tr><td>`data.category.name`</td><td>string</td><td>The category name for an `in_category` rule</td></tr><tr><td>`data.days`</td><td>int</td><td>The days for a `published_within_days` rule</td></tr><tr><td>`data.start_at`</td><td>timestamp</td><td>The start at date for a `published_within` rule</td></tr><tr><td>`data.end_at`</td><td>timestamp</td><td>The end at date for a `published_within` rule</td></tr><tr><td>`data.min_price`</td><td>float</td><td>The min price **including tax**, in whole units (e.g. pounds not pence) for `price_between` rule</td></tr><tr><td>`data.max_price`</td><td>float</td><td>The max price **including tax**, in whole units (e.g. pounds not pence) for `price_between` rule</td></tr><tr><td>`data.currency`</td><td>string</td><td>The currency code for `price_between` rule</td></tr></tbody></table>

### Content

<table border="1" id="bkmrk-name-type-descriptio-6" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Type**  
</td><td>**Description**  
</td></tr><tr><td>`summary`</td><td>string</td><td>The summary content</td></tr><tr><td>`description`</td><td>string</td><td>The description content</td></tr><tr><td>`small_image`</td><td>object</td><td>The Small [Image](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-image)</td></tr><tr><td>`medium_image`</td><td>object</td><td>The Medium [Image](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-image)</td></tr><tr><td>`large_image`</td><td>object</td><td>The Large [Image](https://support.aerocommerce.com/books/api/page/view-collection-endpoint#bkmrk-image)</td></tr></tbody></table>

### Options

<table border="1" id="bkmrk-name-type-descriptio-7" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Type**  
</td><td>**Description**  
</td></tr><tr><td>`categories.mode`</td><td>string</td><td>The category filters mode (e.g., show\_all/hide\_all/show\_some)</td></tr><tr><td>`categories.values`</td><td>array</td><td>The options for categories on the listings page</td></tr><tr><td>`categories.values.*.id`</td><td>int</td><td>The id of category</td></tr><tr><td>`categories.values.*.name`</td><td>string</td><td>The name of category</td></tr><tr><td>`filters.mode`</td><td>int</td><td>The facet filters mode (e.g., show\_all/hide\_all/show\_some)</td></tr><tr><td>`filters.values`</td><td>array</td><td>The options for facet filters on the listings page</td></tr><tr><td>`filters.values.*.name`</td><td>string</td><td>The name of the facet filter, e.g. Manufacturer, Price, etc...</td></tr><tr><td>`filters.values.*.collapsed`</td><td>boolean</td><td>Whether to collapse the facet filter or not</td></tr><tr><td>`sort_bys`</td><td>array</td><td>An array of the applied sorts on the listings page (e.g., name-az, name-za, price-low, price-high, etc...)</td></tr><tr><td>`per_page`</td><td>int</td><td>The per page of the listings page</td></tr></tbody></table>

### SEO

<table border="1" id="bkmrk-name-type-descriptio-8" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Type**  
</td><td>**Description**  
</td></tr><tr><td>`heading`</td><td>string</td><td>The SEO Heading</td></tr><tr><td>`page_title`</td><td>string</td><td>The SEO Page Title</td></tr><tr><td>`meta_description`</td><td>string</td><td>The SEO Meta Description</td></tr><tr><td>`canonical`</td><td>string</td><td>The SEO Canonical</td></tr><tr><td>`noindex`</td><td>boolean</td><td>The SEO No Index</td></tr><tr><td>`nofollow`</td><td>boolean</td><td>The SEO No Follow</td></tr></tbody></table>

### Additional Attribute

<table border="1" id="bkmrk-name-type-descriptio-9" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col></colgroup><tbody><tr><td>**Name**  
</td><td>**Type**  
</td><td>**Description**  
</td></tr><tr><td>`key`</td><td>string</td><td>The key of the additional attribute</td></tr><tr><td>`value`</td><td>string</td><td>The value of the additional attribute</td></tr></tbody></table>

### Settings

Settings are grouped as key-value pairs.

- Use "\_" for ungrouped settings.
- Each group contains its own object of key-value pairs.

```json
{
    "settings": {
        "_": {
            "no_group": "value"
        },
        "group": {
            "key": "value"
        }
    }
}
```

## Example Request

```
GET /api/collections/{id|name}
```

## Example Response

```json
{
    "id": 1,
    "name": "Sale",
    "reference": null,
    "slug": "sale",
    "published_at": "2025-01-08T12:28:14.000000Z",
    "content": {
        "summary": "Combination Summary",
        "description": "Combination Description",
        "small_image": {
            "url": null
        },
        "medium_image": {
            "url": null
        },
        "large_image": {
            "url": null
        }
    },
    "rules": [],
    "options": {
        "categories": {
            "mode": "show_all",
            "values": []
        },
        "filters": {
            "mode": "show_all",
            "values": []
        },
        "sort_bys": [],
        "per_page": 24
    },
    "seo": {
        "heading": "SEO Heading",
        "page_title": "SEO Page Title",
        "meta_description": "SEO Meta Description",
        "open_graph": "",
        "canonical": "",
        "noindex": 0,
        "nofollow": 0
    },
    "settings": [],
    "additional_attributes": []
}
```