docs
Search or ask...
back to main menu
Getting Started
Overview
Security
Resources
Config
Get the checkout configuration
State
Get the current checkout state
Create or update the checkout state
Apply minor updates to the checkout state
Addresses
Create or update a billing or shipping address
Copy an address between address types
Delete a customer address
Shipping Options
Select an available shipping option
Payment Methods
Update a payment option
Select a payment option
Order Confirmation
Confirm the order and start the payment flow
Basket
Update basket item quantity
Voucher
Add a voucher code to the order
Remove a voucher code from the order
Collection Points
Search for collection points
Loyalty Program
Redeem loyalty points
Attach a loyalty card
Detach a loyalty card
Register for a loyalty program
Address Book
Retrieve customer addresses
Create a customer address
Update a customer address
Gift Cards
Delete a recurring payment option
Add a gift card to the order
Resources
State
Get The Current Checkout State
Get the current checkout state
Last updated: August 31, 2026
