API reference
Reference documentation for every Storefront API endpoint, generated from the OpenAPI documents of each service.
The Storefront API is a set of REST APIs. All of them use JSON, the same authentication, and the same error format.
Commerce
Catalogues
Search and read products, ticketing lookups, prices and cross-sells.
Baskets
Create a basket, add products, set customer details and delivery, and start payment.
Payments
Take payment with the payment provider of the store, such as Worldpay, CyberSource, Adyen or Stripe.
Orders
Read orders and check their processing status.
Notifications
Poll for the result of an asynchronous request.
Subscriptions and memberships
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 subscriptions and memberships give to a customer.
Ticketing and venue
Ticketing
List, forward, accept, reject and recall tickets, and create wallet passes.
Seating
Read venue seating plans.
Kiosks
Read venue kiosks.
Timestreams
Read the timestreams, timelines and time periods that control products and prices over time.
Using the endpoint pages
Each endpoint page shows the parameters, the request body, every response, and a request sample in several languages.
Each page also has a request panel that sends a real request from your browser:
- Choose a server, or enter the base URL for your store. See Environments.
- Enter your API key in the
x-api-keyfield. Enter a bearer token if the endpoint needs one. - Fill in the parameters and the body, then select Send.
The request panel sends real requests. Use a Sandbox API key, not a Live key.
OpenAPI documents
Download the OpenAPI document of an API to generate a client or to import it into a tool such as Postman.
| API | OpenAPI document |
|---|---|
| Catalogues | catalogues.yaml, facets.yaml |
| Baskets | baskets.yaml |
| Payments, Worldpay | worldpay.json |
| Orders | orders.yaml |
| Notifications | notifications.yaml |
| Subscriptions | subscriptions.yaml, renewal-options.yaml |
| Entitlements | entitlements.yaml |
| Ticketing | ticketing.yaml |
| Seating | seating.yaml |
| Kiosks | kiosks.yaml |
| Timestreams | timestreams.yaml |