Rest API Overview
The Rest API is a general-purpose API which supports real-time use cases and enables the creation of ROLLER bookings.
Use our Postman Collection to get started
- Available products and capacities for specific dates can be called and capacity can be reserved in advance of creating a booking
- Bookings can then be created along with associated payments and customer records
- Those bookings can be edited, cancelled or deleted
- Payments can be processed using the ROLLER Payments API. Alternatively external payments can be recorded against existing bookings using the Rest API.
The Rest API can also support other use cases which use the available endpoints, some examples are:
- Searching for specific bookings based on booking IDs or other search criteria
- Searching for guest details or a list of bookings held by a specific guest
- Viewing a list of available products, dates/times they are available and the capacity remaining on those dates/times
Updated about 2 months ago
Did this page help you?