Checkout
The Checkout menu turns a prepared cart into a placed order. It runs as an ordered sequence — set the address, pick a shipping method, pick a payment method, then place the order — and provides queries to read the saved addresses and the available shipping / payment options at each step.
The checkout sequence
Checkout must run in order, because each step depends on the one before:
- Set the checkout address (billing, and shipping unless the cart is virtual / downloadable only).
- Get shipping methods for the saved address, then set the chosen shipping method.
- Get payment methods available once shipping is selected, then set the chosen payment method.
- Place the order to finalise the cart into an order.
Calling a step out of sequence (for example, fetching shipping methods before an address is saved) fails — finish the previous step first.
Operations in this menu
| Operation | GraphQL field |
|---|---|
| Get Addresses | addresses query |
| Get Shipping Methods | shippingMethods query |
| Get Payment Methods | paymentMethods query |
| Set Checkout Address | saveCheckoutAddresses mutation |
| Set Shipping Method | saveShippingMethod mutation |
| Set Payment Method | savePaymentMethod mutation |
| Place Order | placeOrder mutation |
Checkout operates on the cart (identified by its cart token); a guest needs only the storefront key, while a signed-in customer also sends their Bearer token. See Authentication.