APIs

API endpoints

Payment

APIDescription
POST bookings/{uniqueIdentifier}/payments

Add payment to booking

Customer

APIDescription
GET customers/{customerId}

Get customer detail

Product

APIDescription
GET products

Gets a list of product detail. This should be cached by your app and called infrequently. The detail includes when the product is offered but you need to call the product-availability endpoint to determine if there's capacity on a given day. The availability response includes basic product detail so depending on your use case you may not need this level of detail.

GET product-availability

Gets product availability for a given date

Booking

APIDescription
POST bookings

Create a booking

PUT bookings/{uniqueIdentifier}

Update the booking name, comments and add or remove items. You cannot edit items - add or remove items instead

POST bookings/{uniqueIdentifier}/cancel

Cancel and optionally refund a booking (IssueRefund defaults to true)

DELETE bookings/{uniqueIdentifier}

Delete a booking. This can be used in conjunction with creating a new booking as an alternative to updating a booking

GET bookings/{uniqueIdentifier}

Get booking detail

GET bookings

Search bookings by keywords, date and more. At least one search criteria is required. If there are more than 100 bookings only the latest 100 bookings are returned.

Capacity reservation

APIDescription
POST capacity-reservation

Validates the items in a booking and reserves capacity

DELETE capacity-reservation/{uniqueId}

Delete reserved capacity

Data endpoints

Signed waivers

APIDescription
GET data/signedwaivers

Gets signed waivers from your authorised venue

Booking signed waivers

APIDescription
GET data/bookingsignedwaivers

Gets signed waivers from your authorised venue

Reporting categories

APIDescription
GET data/reportingcategories

Gets reporting categories from your authorised venue

Giftcards

APIDescription
GET data/giftcards

Gets giftcards from your authorised venue

Staffs

APIDescription
GET data/staffs

Gets staffs from your authorised venue

Revenues

APIDescription
GET data/revenues

Gets revenues from your authorised venue. Each page shows the revenues of a maximum of 100 bookings. The response would also indicate the total number of pages available. In order to get the whole revenues under the specified date range, be sure to call this endpoint for every available page.

Customers

APIDescription
GET data/customers

Gets customers from your authorised venue

Booking payments

APIDescription
GET data/bookingpayments

Gets booking payments from your authorised venue

MembershipRedemptions

APIDescription
GET data/membershipredemptions

Gets membership redemptions from your authorised venue

MembershipStatuses

APIDescription
GET data/membershipstatuses

Gets membership statuses from your authorised venue

Products

APIDescription
GET data/products

Gets products from your authorised venue

Tickets

APIDescription
GET data/tickets

Gets tickets from your authorised venue e.g. memberships, passes...

Attendances

APIDescription
GET data/attendances

Gets attendances from your authorised venue

Booking Items

APIDescription
GET data/bookingitems

Gets bookings from your authorised venue

Locations

APIDescription
GET data/locations

Gets locations from your authorised venue

Waivers

APIDescription
GET data/waivers

Gets waivers from your authorised venue

Discounts

APIDescription
GET data/discounts

Gets discounts from your authorised venue