Checkout
The Checkout menu turns a prepared cart into a placed order. It runs as a sequence: set the addresses, choose a shipping method, choose a payment method, then place the order.
The checkout sequence
Checkout is order-sensitive — each step unlocks the next:
- Set the shipping and billing addresses (or read back the saved ones). Addresses are required before shipping rates can be calculated.
- Get shipping methods for the cart, then set the chosen one.
- Get payment methods, then set the chosen one.
- Place the order to finalise the cart into an order.
Calling a step out of order (e.g. asking for shipping methods before addresses are saved) is rejected — complete the earlier step first.
Operations in this menu
| Operation | Method & Path | Description |
|---|---|---|
| Get Addresses | GET /api/shop/checkout-addresses | Read the addresses saved on the cart. |
| Set Shipping Address | POST /api/shop/checkout-addresses | Save the shipping address. |
| Set Billing Address | POST /api/shop/checkout-addresses | Save the billing address. |
| Get Shipping Methods | GET /api/shop/checkout-shipping-methods | List available shipping rates. |
| Set Shipping Method | POST /api/shop/checkout-shipping-methods | Select a shipping method. |
| Get Payment Methods | GET /api/shop/checkout-payment-methods | List available payment methods. |
| Set Payment Method | POST /api/shop/checkout-payment-methods | Select a payment method. |
| Place Order | POST /api/shop/checkout-orders | Finalise the cart into an order. |
All Checkout endpoints require the storefront key and the active cart's token — see Authentication.