Storefront API documentation

Every product. One basket. One payment.

OneBasket brings ticketing, retail, and food and beverage providers together behind one API. Build the whole purchase, from product search to fulfilled order, inside your own website or app.

Start the quickstart API reference

Create a basket and add a product

$ curl -X POST "$ONEBASKET_API_URL/baskets" \
    -H "x-api-key: $ONEBASKET_API_KEY"
  
$ curl -X POST \
    "$ONEBASKET_API_URL/baskets/$BASKET_ID/products/$PRODUCT_ID" \
    -H "x-api-key: $ONEBASKET_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{ "quantity": 1 }'
{ "notificationId": "..." }

Guides

The four things every integration needs to get right.

All guides

Quickstart

Search for a product, create a basket and start payment in five requests.

Authentication

When to send the API key, and when to add a bearer token.

Asynchronous operations

Handle requests that return a notification id and poll for the result.

Checkout flow

Every API call from an empty basket to a fulfilled order.

API reference

Generated from the OpenAPI document of each service. Every endpoint page shows its parameters and responses, request samples in six languages, and a panel that sends a test request.

Catalogues

Search and read products from every connected provider, including ticketing lookups, prices and cross-sells.

Baskets

Create a basket, add products from any provider, set customer details and delivery, and start payment.

Payments

Take payment for a payment intent with the payment provider of the store, such as Worldpay, CyberSource, Adyen or Stripe.

Orders

Read the orders of the signed-in contact and check whether each provider has accepted the order.

Subscriptions

Read the subscriptions and memberships of a contact, cancel, upgrade and renew them, and change the saved payment method.

Entitlements

Read the benefits that the subscriptions and memberships of a customer give, such as access to video content.

Notifications

Poll for the result of an asynchronous request, such as adding a product to a basket.

Ticketing

List the tickets a contact owns, forward, accept, reject and recall tickets, and create wallet passes.

Seating

Read the seating plan of a venue as a hierarchy of seating levels, and the kiosks each level can use.

Kiosks

Read the kiosks of a venue: the locations where customers buy or collect products, such as food and beverage outlets.

Timestreams

Read the timestreams, timelines and time periods that control which products and prices apply at a given time.