Skip to main content
POST
Redeem Reward Points

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

Body

application/json
points
integer
required

The number of reward points to redeem against the cart.

Required range: x >= 1

Response

Points applied. Returns the recalculated cart along with the number of points redeemed and the resulting discount value.

data
object

A storefront shopping cart with its items, totals and applied discounts. Monetary amounts are expressed in the cart currency's minor units (e.g. pence/cents).

pointsApplied
integer

The number of points actually redeemed.

pointsDiscount
number

The monetary discount value granted by the redeemed points.