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 |
| product | object | The trigger product (available include) |
| 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.