Skip to main content
GET
Get Free Shipping Upsell

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Path Parameters

cartId
string<uuid>
required

The unique identifier for the cart

Response

200 - application/json

The free shipping upsell state for the cart.

The free shipping upsell state for a cart.

show
boolean
required

Whether to display a free shipping upsell prompt.

qualifies
boolean

Whether the cart already qualifies for free shipping.

type
enum<string>

Whether the upsell threshold is based on order value or item volume.

Available options:
value,
volume
amountNeeded
number | null

For value-based upsells, the additional spend required to qualify, in minor currency units. Null for volume-based upsells.

itemsNeeded
integer | null

For volume-based upsells, the additional item volume required to qualify. Null for value-based upsells.