comecerodocs

List cart up-sells

GET
/carts/{cart_id}/up_sells

Returns up-sell offers for the cart: a better product in place of one in the cart, picked from your active up-sell promotions. Each offer says which product it replaces and how much more it costs. To take an offer, add its product with its up_sell_id; the replaced item is removed. One page. Any token type may call it; a limited token only for a bound cart.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

cart_id*string

The id of the cart.

Query Parameters

max_up_sells?integer

How many up-sell offers to return when up_sells is expanded, 0 to 10. Default 3.

Range0 <= value <= 10
expand?string

Comma-separated child objects to return in full instead of as a URL, for example customer,payments. Use dot notation for nested objects (items.product), up to four levels deep. A single object takes up to 12 paths; a list takes up to 2, applied to every item. Extra paths are dropped without an error. See Expanding objects.

formatted?boolean

When true, the object also has a formatted child with amounts and dates as display text in the shopper's language and currency (for example $19.99 or November 7, 2026). The default is false. See Localized formatting.

Defaultfalse

Response Body

The up-sell offers.

application/json
  1. response

An offset-based list of up-sell offers for a cart. It is one page.

total_items*integer

The number of items in the whole list.

total_pages*integer

The number of pages.

current_page*integer

The page number of this page, starting at 1.

next_page_url*|

The URL of the next page, or null on the last page.

Formaturi
next_page_offset*|

The offset of the next page, or null on the last page.

previous_page_url*|

The URL of the previous page, or null on the first page.

Formaturi
previous_page_offset*|

The offset of the previous page, or null on the first page.

current_page_url*string

The URL of this page.

Formaturi
data*array<>

The offers on this page.

Example Request
curl -X GET 'https://api.comecero.com/api/v1/carts/string/up_sells'
Example Response
{  "total_items": 1,  "total_pages": 1,  "current_page": 1,  "next_page_url": null,  "next_page_offset": null,  "previous_page_url": null,  "previous_page_offset": null,  "current_page_url": "https://api.comecero.com/api/v1/carts/0091307952465CafhFSTa1/up_sells?offset=0&limit=10",  "data": [    {      "up_sell_id": "0091307952511PtR8sQm-c3d4",      "product_id": "pdf-pro-plus.test",      "name": "PDF Viewer Pro Plus",      "price": 119.95,      "price_original": 129.95,      "discount": 10,      "discount_percent": 0.08,      "currency": "USD",      "up_sell_from_product": "https://api.comecero.com/api/v1/products/pdf-pro.test",      "additional_amount": 40,      "product": "https://api.comecero.com/api/v1/products/pdf-pro-plus.test"    }  ]}