Checkout flow

Build the basket

1. Create a basket when the customer adds their first product. Store the basket id on the device.
2. Add products. Products that need more input have their own endpoints: Select seats for ticketing products and Select time slot for products that are collected or delivered in a time slot.
3. Change the basket with Update line item quantity and Delete line item.
4. Apply a voucher with Add voucher to basket.

Each of these requests is asynchronous. Poll the notification, then read the basket to show the new totals.

Collect customer and delivery details

1. Read missingCustomerDetailFields on the basket. It lists the customer details that the providers in the basket still need.
2. Send them with Set customer details.
3. For each provider basket that needs one, choose a delivery method with Set delivery method.
4. If the customer signs in at this point, call Assign contact.

Create a payment intent

Call Create a payment intent when the customer chooses to pay.

OneBasket tells each provider in the basket that a payment is about to be made. A provider can lock inventory at this point, or reject the payment. From now on the basket is immutable.

If the customer goes back to change the basket, call Cancel a payment intent. The basket becomes mutable again.

Take payment

Take payment with the payment provider configured for your store, such as Worldpay, CyberSource, Adyen or Stripe. Each provider has its own client SDK and its own Storefront endpoints. See Payments.

The payment intent moves through these statuses:

Confirm the order

When OneBasket receives confirmation of the payment, the basket is complete and becomes an order. The order id is the same as the basket id.

Order processing is asynchronous. Show the customer a message such as "Your order has been received" straight away, then call Get order status to follow progress:

{
  "id": "...",
  "processingCompleted": true,
  "hasRejections": false
}