---
url: https://docs.youcan.shop/store-admin/entities/upsell.md
---
# Upsell entity

The Upsell entity at YouCan.

| Attribute Name | Type | Description |
| --- | --- | --- |
| id | string | Identifier (UUID) |
| name | string | Upsell name |
| description | string, null | Description shown to the customer |
| footer | string, null | Text displayed at the bottom of the upsell offer |
| active | bool | Whether the upsell is active |
| weight | int | Display priority — lower weight is shown first (default: `1`) |
| product\_offer\_ids | array | IDs of the products offered in the upsell |
| actions | object | Configuration for the accept/decline buttons — see [Actions](#actions) |
| [product](#product) | object | The trigger product (available include) |
| [product\_offers](#product-offers) | array | The offered products (available include) |

## Actions

The `actions` object contains two keys: `btn_yes` (accept button) and `btn_no` (decline button).

| Attribute Name | Type | Description |
| --- | --- | --- |
| title | string | Button label |
| size | string | Button size — `"small"` or `"large"` |
| bg\_color | string | Background color (hex) |
| font\_size | string | Font size |
| font\_color | string | Text color (hex) |

## Product

The product that triggers this upsell. Use `?include=product` to include.

## Product Offers

The products offered when the upsell is triggered. Use `?include=product_offers` to include.