# View Product Endpoint

#### Structure

##### Product

<table border="1" id="bkmrk-name-type-descriptio" style="border-collapse: collapse; width: 100%; height: 793.734px;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></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></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">`model`</td><td style="height: 46.5938px;">string</td><td style="height: 46.5938px;">The **unique** model identifier for the product</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 display name of the product</td></tr><tr style="height: 52.1953px;"><td style="height: 52.1953px;">`manufacturer`</td><td style="height: 52.1953px;">object</td><td style="height: 52.1953px;">The [Manufacturer](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-manufacturer) object (null when none)</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">`summary`</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">A short summary of the product</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">`description`</td><td style="height: 29.7969px;">string</td><td style="height: 29.7969px;">A detailed description of the product</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">`active`</td><td style="height: 46.5938px;">boolean</td><td style="height: 46.5938px;">Whether the product is active (available for purchase)</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">`visible`</td><td style="height: 46.5938px;">boolean</td><td style="height: 46.5938px;">Whether the product is visible in the storefront</td></tr><tr style="height: 46.5938px;"><td style="height: 46.5938px;">`attribute_groups_to_split_by`</td><td style="height: 46.5938px;">?array</td><td style="height: 46.5938px;">The attribute groups to split listings by (null when none)</td></tr><tr style="height: 29.7969px;"><td style="height: 29.7969px;">`published_at`</td><td style="height: 29.7969px;">timestamp</td><td style="height: 29.7969px;">When the product was published</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`images`</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Image](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-image) objects</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-product-endpoint#bkmrk-category) objects</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-product-endpoint#bkmrk-tag) objects</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`variants`</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Variant](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-variant) objects</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`seo`</td><td style="height: 35.3984px;">object</td><td style="height: 35.3984px;">A [SEO](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-seo) object</td></tr><tr style="height: 52.1953px;"><td style="height: 52.1953px;">`settings`</td><td style="height: 52.1953px;">object</td><td style="height: 52.1953px;">A [Settings](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-settings) object with grouped key-value pairs</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`additional_attributes`</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Additional Attribute](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-additional-attribute) objects</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`specifications` `*`</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Specification](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-specification) objects</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`specification_groups` `*`</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Specification Group](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-specification-group) objects</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`upsells`</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Upsell](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-upsell) objects</td></tr><tr style="height: 35.3984px;"><td style="height: 35.3984px;">`related_listings`</td><td style="height: 35.3984px;">array</td><td style="height: 35.3984px;">An array of [Related Listing](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-related-listing) objects</td></tr></tbody></table>

`*` `specifications` is if using `<1.0.0` version of `aerocargo/specifications`, otherwise use `specification_groups`.

##### Manufacturer

<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>`id`</td><td>int</td><td>The id of the manufacturer</td></tr><tr><td>`name`</td><td>string</td><td>The name of the manufacturer</td></tr></tbody></table>

##### Image

<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>`url`</td><td>string</td><td>The url of the image</td></tr><tr><td>`default`</td><td>bool</td><td>Whether the image is default</td></tr><tr><td>`attributes`</td><td>array</td><td>An array of [Attribute](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-attribute) objects</td></tr></tbody></table>

##### Category

<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>`id`</td><td>int</td><td>The id of the category</td></tr><tr><td>`name`</td><td>string</td><td>The name of the category (e.g., Coats)</td></tr><tr><td>`breadcrumb`</td><td>string</td><td>The breadcrumb path for the category (e.g., Mens &gt; Coats)</td></tr></tbody></table>

##### Variant

<table border="1" id="bkmrk-name-type-descriptio-4" 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>`sku`</td><td>string</td><td>The **unique** SKU for the variant</td></tr><tr><td>`reference`</td><td>string</td><td>The **unique** reference for the variant</td></tr><tr><td>`name`</td><td>string</td><td>Display name of the variant</td></tr><tr><td>`summary`</td><td>string</td><td>A short summary of the variant</td></tr><tr><td>`description`</td><td>string</td><td>A detailed description of the variant</td></tr><tr><td>`barcode`</td><td>string</td><td>The barcode/UPC/EAN of the variant</td></tr><tr><td>`buyable`</td><td>boolean</td><td>Whether the variant can be purchased</td></tr><tr><td>`visible`</td><td>boolean</td><td>Whether the variant is visible in listings</td></tr><tr><td>`shippable`</td><td>boolean</td><td>Whether the variant is shippable</td></tr><tr><td>`discountable`</td><td>boolean</td><td>Whether discounts can be applied to this variant</td></tr><tr><td>`hide_when_no_stock`</td><td>boolean</td><td>Whether the variant should be hidden when out of stock</td></tr><tr><td>`infinite_stock`</td><td>boolean</td><td>Whether the variant has unlimited stock</td></tr><tr><td>`stock_level`</td><td>int</td><td>Current stock level</td></tr><tr><td>`stock_buffer`</td><td>int</td><td>The stock buffer</td></tr><tr><td>`tax_group`</td><td>string</td><td>The tax group applied to the variant</td></tr><tr><td>`minimum_quantity`</td><td>int</td><td>Minimum quantity per purchase</td></tr><tr><td>`maximum_quantity`</td><td>int</td><td>Maximum quantity per purchase</td></tr><tr><td>`multiples_of`</td><td>int</td><td>Purchasable only in multiples of this number</td></tr><tr><td>`weight`</td><td>float</td><td>Weight of the variant</td></tr><tr><td>`weight_unit`</td><td>string</td><td>Unit of weight (e.g., `kg`, `lb`)</td></tr><tr><td>`volume`</td><td>float</td><td>Volume of the variant</td></tr><tr><td>`volume_unit`</td><td>string</td><td>Unit of volume (e.g., `m^3`, `cm^3`)</td></tr><tr><td>`hs`</td><td>string</td><td>HS (Harmonized System) code for customs</td></tr><tr><td>`price.amount`</td><td>float</td><td>The current price of the variant **excluding tax**</td></tr><tr><td>`price.tax`</td><td>float</td><td>The tax of the current price</td></tr><tr><td>`price.currency`</td><td>string</td><td>The currency of the current price</td></tr><tr><td>`retail.amount`</td><td>float</td><td>The RRP for the variant **excluding tax**</td></tr><tr><td>`retail.tax`</td><td>float</td><td>The tax of the RRP</td></tr><tr><td>`retail.currency`</td><td>string</td><td>The currency of the RRP</td></tr><tr><td>`origin_country`</td><td>string</td><td>ISO country code of origin (e.g., `US`, `GB`)</td></tr><tr><td>`goods_description`</td><td>string</td><td>Description of goods for customs</td></tr><tr><td>`attributes`</td><td>array</td><td>An array of [Attribute](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-attribute) objects</td></tr><tr><td>`tags`</td><td>array</td><td>An array of [Tag](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-tag) objects</td></tr><tr><td>`cost`</td><td>object</td><td>The [Cost Price](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-cost-price) of the variant</td></tr><tr><td>`prices`</td><td>array</td><td>An array of [Price](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-price) objects</td></tr><tr><td>`additional_attributes`</td><td>array</td><td>An array of [Additional Attribute](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-additional-attribute) objects</td></tr><tr><td>`specifications` `*`</td><td>array</td><td>An array of [Specification](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-specification) objects</td></tr><tr><td>`specification_groups` `*`</td><td>array</td><td>An array of [Specification Group](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-specification-group) objects</td></tr><tr><td>`upsells`</td><td>array</td><td>An array of [Upsell](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-upsell) objects</td></tr></tbody></table>

`*` `specifications` is if using `<1.0.0` version of `aerocargo/specifications`, otherwise use `specification_groups`.

##### Attribute

<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>`id`</td><td>int</td><td>The id of the attribute</td></tr><tr><td>`name`</td><td>string</td><td>The name of the attribute</td></tr><tr><td>`reference`</td><td>string</td><td>The reference of the attribute</td></tr><tr><td>`group`</td><td>object</td><td>The [Attribute Group](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-attribute-group) object</td></tr></tbody></table>

##### Attribute Group

<table border="1" id="bkmrk-name-type-descriptio-6" style="border-collapse: collapse; width: 100%; height: 29.7969px;"><colgroup><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></col><col style="width: 33.3731%;"></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></tr><tr><td>`id`</td><td>int</td><td>The id of the tag group</td></tr><tr><td>`name`</td><td>string</td><td>The name of the tag group</td></tr><tr><td>`reference`</td><td>string</td><td>The reference of the tag group</td></tr></tbody></table>

##### Tag

<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>`id`</td><td>int</td><td>The id of the tag</td></tr><tr><td>`name`</td><td>string</td><td>The name of the tag</td></tr><tr><td>`reference`</td><td>string</td><td>The reference of the tag</td></tr><tr><td>`group`</td><td>object</td><td>The [Tag Group](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-tag-group) object</td></tr></tbody></table>

##### Tag Group

<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>`id`</td><td>int</td><td>The id of the tag group</td></tr><tr><td>`name`</td><td>string</td><td>The name of the tag group</td></tr><tr><td>`reference`</td><td>string</td><td>The reference of the tag group</td></tr></tbody></table>

##### Cost Price

<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>`amount`</td><td>float</td><td>The cost price **including tax**</td></tr><tr><td>`currency`</td><td>string</td><td>Currency code (defaults to store default if not provided)</td></tr></tbody></table>

##### Price

<table border="1" id="bkmrk-name-type-descriptio-10" 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>`id`</td><td>int</td><td>The id of the price</td></tr><tr><td>`currency`</td><td>string</td><td>The currency code for the price</td></tr><tr><td>`quantity`</td><td>int</td><td>The quantity required for the price to be detected/applied</td></tr><tr><td>`value.amount`</td><td>float</td><td>The normal price **excluding tax**</td></tr><tr><td>`value.tax`</td><td>float</td><td>The tax for the normal price</td></tr><tr><td>`sale_value.amount`</td><td>float</td><td>The sale price **excluding tax**</td></tr><tr><td>`sale_value.tax`</td><td>float</td><td>The tax for the sale price</td></tr><tr><td>`retail_value.amount`</td><td>float</td><td>The retail price **excluding tax**</td></tr><tr><td>`retail_value.tax`</td><td>float</td><td>The tax for the retail price</td></tr><tr><td>`start_at`</td><td>timestamp</td><td>The start date for when the price is active</td></tr><tr><td>`end_at`</td><td>timestamp</td><td>The end date for when the price is active</td></tr><tr><td>`reference`</td><td>string</td><td>The reference for the price</td></tr></tbody></table>

##### SEO

<table border="1" id="bkmrk-name-type-descriptio-11" 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>

##### 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"
        }
    }
}
```

##### Additional Attribute

<table border="1" id="bkmrk-name-type-descriptio-12" 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>

##### Specification

<table border="1" id="bkmrk-name-type-descriptio-13" 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>`group.name`</td><td>string</td><td>The name of the specification group</td></tr><tr><td>`name`</td><td>string</td><td>The name of the specification</td></tr><tr><td>`value`</td><td>string</td><td>The value of the specification</td></tr><tr><td>`media`</td><td>array</td><td>An array of [Media](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-media) objects</td></tr></tbody></table>

<p class="callout info">This is only for `<1.0.0` version of `aerocargo/specifications`. See [Specification Group](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-specification-group) for `1.x` structure.</p>

##### Specification Group

<table border="1" id="bkmrk-name-type-descriptio-14" 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>`id`</td><td>int</td><td>The id of the specification group</td></tr><tr><td>`name`</td><td>string</td><td>The name of the specification group</td></tr><tr><td>`fields`</td><td>array</td><td>An array of [Field](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-specification-group-) objects</td></tr><tr><td>`media`</td><td>array</td><td>An array of [Media](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-media) objects</td></tr><tr><td>`settings`</td><td>object</td><td>A [Settings](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-settings) object with grouped key-value pairs</td></tr></tbody></table>

<p class="callout info">This is only for `>=1.0.0` version of `aerocargo/specifications`. See [Specification](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-specification) for `0.x` structure.</p>

##### Specification Group Field

<table border="1" id="bkmrk-name-type-descriptio-15" 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>`id`</td><td>int</td><td>The id of the specification group field</td></tr><tr><td>`name`</td><td>string</td><td>The name of the specification group field</td></tr><tr><td>`value`</td><td>string</td><td>The value of the specification group field</td></tr><tr><td>`media`</td><td>array</td><td>An array of [Media](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-media) objects</td></tr><tr><td>`settings`</td><td>object</td><td>A [Settings](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-settings) object with grouped key-value pairs</td></tr></tbody></table>

##### Media

<table border="1" id="bkmrk-name-type-descriptio-16" 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>`id`</td><td>int</td><td>The id of the media</td></tr><tr><td>`slug`</td><td>string</td><td>The slug of the media</td></tr><tr><td>`disk`</td><td>string</td><td>The disk used to store the media</td></tr><tr><td>`path`</td><td>string</td><td>The path of the media on the disk</td></tr><tr><td>`title`</td><td>string</td><td>The title of the media</td></tr><tr><td>`type`</td><td>string</td><td>The mimetype of the media</td></tr><tr><td>`extension`</td><td>string</td><td>The file extension of the media</td></tr><tr><td>`size`</td><td>int</td><td>The file size of the media in bytes</td></tr><tr><td>`meta`</td><td>object</td><td>The meta data of the media</td></tr><tr><td>`source`</td><td>string</td><td>The source file name of the media</td></tr><tr><td>`is_protected`</td><td>bool</td><td>Whether the media is protected</td></tr></tbody></table>

##### Upsell

<table border="1" id="bkmrk-name-type-descriptio-17" 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>`group`</td><td>object</td><td>The [Upsell Group](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-upsell-group) object (null when none)</td></tr><tr><td>`attributes`</td><td>array</td><td>An array of [Attribute](https://support.aerocommerce.com/books/api/page/view-product-endpoint#bkmrk-attribute) objects that the upsell shows for</td></tr><tr><td>`models`</td><td>array</td><td>And array of models for the upsell</td></tr><tr><td>`skus`</td><td>array</td><td>And array of SKUs for the upsell</td></tr></tbody></table>

##### Upsell Group

<table border="1" id="bkmrk-name-type-descriptio-18" 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 upsell group</td></tr><tr><td>`name`</td><td>string</td><td>The name of the upsell group</td></tr></tbody></table>

##### Related Listing

<table border="1" id="bkmrk-name-type-descriptio-19" 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>`id`</td><td>int</td><td>The id of the listing</td></tr><tr><td>`product.id`</td><td>int</td><td>The id of the product linked to the listing</td></tr><tr><td>`product.model`</td><td>string</td><td>The model of the product linked to the listing</td></tr><tr><td>`variants.*.id`</td><td>id</td><td>The id of the variants linked to the listing</td></tr><tr><td>`variants.*.sku`</td><td>string</td><td>The sku of the variants linked to the listing</td></tr><tr><td>`sort`</td><td>int</td><td>The sort of the listing within the group</td></tr></tbody></table>

#### Example Requests

```
GET /api/products/{id|model}
```

```
GET /api/products?model=model
```

<p class="callout info">Using the first request syntax is advised, only use the second if/when the model is numeric, as if a matching id exists that would be resolved instead.</p>

#### Example Responses

<details id="bkmrk-simple-product-%7B-%22mo"><summary>Simple Product</summary>

```json
{
    "model": "9021182",
    "name": "Detachable Sleeve Puffer Jacket",
    "manufacturer": "Burberry",
    "categories": [
        { 
            "name": "Mens > Coats > Padded Coats"
        }
    ],
    "summary": "Summary",
    "description": "Description",
    "active": true,
    "visible": true,
    "images": [
        {
            "src": "https://picsum.photos/seed/first/600/400",
            "default": true
        }
    ],
    "variants": [
        {
            "sku": "9021182",
            "barcode": "abc123",
            "stock_level": 5,
            "prices": [
                {
                    "currency": "GBP",
                    "price": 790,
                    "quantity": 1
                }
            ],
            "tax_group": "Taxable Product"
        }
    ],
    "tags": [
        {
            "group": { 
                "name": "Colour"
            },
            "name": "Blue"
        }
    ],
    "seo": {
        "heading": "test heading",
        "page_title": "test page title",
        "meta_description": "test meta description",
        "noindex": 0,
        "nofollow": 0
    },
    "additional_attributes": [
        {
            "key": "test_name",
            "value": "test_value"
        }
    ]
}
```

</details><details id="bkmrk-variant-product-%7B-%22i"><summary>Variant Product</summary>

```json
{
    "id": 1,
    "model": "8021182",
    "name": "Detachable Sleeve Puffer Jacket",
    "summary": "Outer: Leather 100%, Polyamide 100%\nLining: Polyester 100%, Goose Down 90%, Wool 70%, Polyamide 20%, Cashmere 10%, Feather 10%",
    "description": "A quintessentially British brand, Burberry creates iconic designs that seamlessly infuse their rich heritage with a contemporary aesthetic. This deep blue wool and cashmere blend detachable sleeve puffer jacket from Burberry features a hood, a high standing collar, a zip and press stud fastening, detachable long sleeves, a contrast logo patch to one side, zipped side slit pockets and a puffer style.",
    "type": "variant",
    "active": true,
    "visible": true,
    "attribute_groups_to_split_by": null,
    "published_at": "2025-06-13T07:34:34.000000Z",
    "manufacturer": {
        "id": 1,
        "name": "Burberry"
    },
    "images": [
        {
            "url": "https://picsum.photos/seed/first/600/400",
            "default": "1"
        },
        {
            "url": "https://picsum.photos/seed/second/600/400",
            "default": "1"
        },
        {
            "url": "https://picsum.photos/seed/third/600/400",
            "default": "1"
        },
    ],
    "categories": [
        {
            "id": 3,
            "name": "Padded Coats",
            "breadcrumb": "Mens » Coats » Padded Coats"
        }
    ],
    "tags": [
        {
            "id": 1,
            "name": "Blue",
            "reference": null,
            "group": {
                "id": 1,
                "name": "Colour",
                "reference": null
            }
        }
    ],
    "seo": {
        "heading": "test heading",
        "page_title": "test page title",
        "meta_description": "test meta description",
        "open_graph": "",
        "canonical": "",
        "noindex": null,
        "nofollow": null
    },
    "variants": [
        {
            "id": 1,
            "sku": "8021182-S",
            "reference": null,
            "name": "",
            "summary": "",
            "description": "",
            "barcode": null,
            "buyable": true,
            "visible": true,
            "shippable": true,
            "discountable": true,
            "infinite_stock": false,
            "stock_level": 5,
            "stock_buffer": 0,
            "weight": null,
            "weight_unit": null,
            "volume": null,
            "volume_unit": null,
            "hs": null,
            "origin_country": null,
            "goods_description": null,
            "cost": {
                "amount": 5623.54,
                "currency": "GBP"
            },
            "price": {
                "amount": 65833.33,
                "tax": 13166.669999999998,
                "currency": "GBP"
            },
            "retail": {
                "amount": null,
                "tax": null,
                "currency": "GBP"
            },
            "prices": [
                {
                    "id": 1,
                    "currency": "GBP",
                    "quantity": 1,
                    "value": {
                        "amount": 65833.33,
                        "tax": 13166.669999999998
                    },
                    "sale_value": {
                        "amount": 65833.33,
                        "tax": 13166.669999999998
                    },
                    "retail_value": {
                        "amount": null,
                        "tax": null
                    },
                    "start_at": null,
                    "end_at": null,
                    "reference": null
                }
            ],
            "images": [
                {
                    "url": "https://picsum.photos/seed/fourth/600/400",
                    "default": "1",
                    "attributes": [
                        {
                            "group": {
                                "name": "Size"
                            },
                            "name": "Small"
                        }
                    ]
                }
            ],
            "attributes": [
                {
                    "id": 1,
                    "name": "Small",
                    "display_name": "Small",
                    "reference": null,
                    "group": {
                        "id": 1,
                        "name": "Size",
                        "reference": null
                    }
                }
            ],
            "tags": [
                {
                    "id": 2,
                    "name": "Small",
                    "reference": null,
                    "group": {
                        "id": 2,
                        "name": "Size",
                        "reference": null
                    }
                }
            ],
            "additional_attributes": []
        },
        {
            "id": 2,
            "sku": "8021182-M",
            "reference": null,
            "name": "",
            "summary": "",
            "description": "",
            "barcode": null,
            "buyable": true,
            "visible": true,
            "shippable": true,
            "discountable": true,
            "infinite_stock": false,
            "stock_level": 5,
            "stock_buffer": 0,
            "weight": null,
            "weight_unit": null,
            "volume": null,
            "volume_unit": null,
            "hs": null,
            "origin_country": null,
            "goods_description": null,
            "cost": {
                "amount": null,
                "currency": null
            },
            "price": {
                "amount": 65833.33,
                "tax": 13166.669999999998,
                "currency": "GBP"
            },
            "retail": {
                "amount": null,
                "tax": null,
                "currency": "GBP"
            },
            "prices": [
                {
                    "id": 2,
                    "currency": "GBP",
                    "quantity": 1,
                    "value": {
                        "amount": 65833.33,
                        "tax": 13166.669999999998
                    },
                    "sale_value": {
                        "amount": 65833.33,
                        "tax": 13166.669999999998
                    },
                    "retail_value": {
                        "amount": null,
                        "tax": null
                    },
                    "start_at": null,
                    "end_at": null,
                    "reference": null
                }
            ],
            "images": [],
            "attributes": [
                {
                    "id": 2,
                    "name": "Medium",
                    "display_name": "Medium",
                    "reference": null,
                    "group": {
                        "id": 1,
                        "name": "Size",
                        "reference": null
                    }
                }
            ],
            "tags": [
                {
                    "id": 3,
                    "name": "Medium",
                    "reference": null,
                    "group": {
                        "id": 2,
                        "name": "Size",
                        "reference": null
                    }
                }
            ],
            "additional_attributes": []
        },
        {
            "id": 3,
            "sku": "8021182-L",
            "reference": null,
            "name": "",
            "summary": "",
            "description": "",
            "barcode": null,
            "buyable": true,
            "visible": true,
            "shippable": true,
            "discountable": true,
            "infinite_stock": false,
            "stock_level": 5,
            "stock_buffer": 0,
            "weight": null,
            "weight_unit": null,
            "volume": null,
            "volume_unit": null,
            "hs": null,
            "origin_country": null,
            "goods_description": null,
            "cost": {
                "amount": null,
                "currency": null
            },
            "price": {
                "amount": 65833.33,
                "tax": 13166.669999999998,
                "currency": "GBP"
            },
            "retail": {
                "amount": null,
                "tax": null,
                "currency": "GBP"
            },
            "prices": [
                {
                    "id": 3,
                    "currency": "GBP",
                    "quantity": 1,
                    "value": {
                        "amount": 65833.33,
                        "tax": 13166.669999999998
                    },
                    "sale_value": {
                        "amount": 65833.33,
                        "tax": 13166.669999999998
                    },
                    "retail_value": {
                        "amount": null,
                        "tax": null
                    },
                    "start_at": null,
                    "end_at": null,
                    "reference": null
                }
            ],
            "images": [],
            "attributes": [
                {
                    "id": 3,
                    "name": "Large",
                    "display_name": "Large",
                    "reference": null,
                    "group": {
                        "id": 1,
                        "name": "Size",
                        "reference": null
                    }
                }
            ],
            "tags": [
                {
                    "id": 4,
                    "name": "Large",
                    "reference": null,
                    "group": {
                        "id": 2,
                        "name": "Size",
                        "reference": null
                    }
                }
            ],
            "additional_attributes": []
        },
        {
            "id": 4,
            "sku": "8021182-XL",
            "reference": null,
            "name": "",
            "summary": "",
            "description": "",
            "barcode": null,
            "buyable": true,
            "visible": true,
            "shippable": true,
            "discountable": true,
            "infinite_stock": false,
            "stock_level": 5,
            "stock_buffer": 0,
            "weight": null,
            "weight_unit": null,
            "volume": null,
            "volume_unit": null,
            "hs": null,
            "origin_country": null,
            "goods_description": null,
            "cost": {
                "amount": null,
                "currency": null
            },
            "price": {
                "amount": 65833.33,
                "tax": 13166.669999999998,
                "currency": "GBP"
            },
            "retail": {
                "amount": null,
                "tax": null,
                "currency": "GBP"
            },
            "prices": [
                {
                    "id": 1,
                    "currency": "GBP",
                    "quantity": 1,
                    "value": {
                        "amount": 65833.33,
                        "tax": 13166.669999999998
                    },
                    "sale_value": {
                        "amount": 65833.33,
                        "tax": 13166.669999999998
                    },
                    "retail_value": {
                        "amount": null,
                        "tax": null
                    },
                    "start_at": null,
                    "end_at": null,
                    "reference": null
                }
            ],
            "images": [],
            "attributes": [
                {
                    "id": 4,
                    "name": "Extra Large",
                    "display_name": "Extra Large",
                    "reference": null,
                    "group": {
                        "id": 1,
                        "name": "Size",
                        "reference": null
                    }
                }
            ],
            "tags": [
                {
                    "id": 5,
                    "name": "Extra Large",
                    "reference": null,
                    "group": {
                        "id": 2,
                        "name": "Size",
                        "reference": null
                    }
                }
            ],
            "additional_attributes": []
        }
    ],
    "additional_attributes": [],
    "settings": []
}
```

</details>