Baskets API
Create a basket, add products from any provider, collect customer and delivery details, and start payment.
A basket holds the products a customer intends to buy. It contains one provider basket for each provider that has a product in it.
| Property | Value |
|---|---|
| Base path | /baskets |
| Authentication | x-api-key header. Add a bearer token when the customer is signed in. See Authentication. |
| OpenAPI document | baskets.yaml |
Requests that change a basket are asynchronous
They return a notificationId, not the updated basket. Poll the Notifications API until the request completes, then read the basket again. See Asynchronous operations.
For the order in which to call these endpoints, see Checkout flow.
Endpoints
POST
/basketsCreate a basketGET/baskets/{id}Get a basketDELETE/baskets/{id}Delete a basketPATCH/baskets/{id}/assign-contactAssign contactPOST/baskets/{id}/payment-intentsCreate a payment intentDELETE/baskets/{id}/payment-intents/{paymentIntentId}Cancel a payment intentPOST/baskets/{id}/products/{productId}Add a product to a basketPOST/baskets/{id}/products/{productId}/ticketing/select-seatsSelect seatsPOST/baskets/{id}/products/{productId}/time-slots/select-slotSelect time slotPATCH/baskets/{id}/provider/{providerBasketId}/items/{lineItemId}Update a line itemDELETE/baskets/{id}/provider/{providerBasketId}/items/{lineItemId}Delete line itemPATCH/baskets/{id}/provider/{providerBasketId}/items/{lineItemId}/quantityUpdate line item quantityPOST/baskets/{id}/provider/{providerBasketId}/set-delivery-methodSet delivery methodPATCH/baskets/{id}/set-customer-detailsSet customer detailsPOST/baskets/{id}/voucherAdd voucher to basketDELETE/baskets/{id}/voucherRemove voucher from basket