API Reference

Booking Request / Response

PropertyData TypeRequiredDescription
externalIdStringYesExternalId to identify this booking
businessIdNumberYesId that identifies the property
businessTypeString of Business TypeYesType of the business
bookingNumberStringNoId to identify this booking. Can be the same as externalId
startTimeString of RFC 3339 Timestamp FormatYesStart date of the booking
endTimeString of RFC 3339 Timestamp FormatYesEnd date of the booking
typeString of Booking TypeYesType of booking
statusString of Booking StatusYesStatus of the booking
adultCountNumberYesNumber of adults in this booking
childCountNumberYesNumber of children in this booking
reasonForStayStringNoReason for the reservation
companyStringNoCompany that made the reservation
bookedAtString of RFC 3339 Timestamp FormatNoWhen the booking was created
cancelledAtString of RFC 3339 Timestamp FormatNoWhen the booking was cancelled
customersList of CustomerYesList of customers for this booking
itemsList of Booking ItemYesList of items for this booking
notesList of Booking NoteNoAdditional notes to add to this booking

Booking Status

Possible Values:

  • CONFIRMED
  • CHECKED_IN
  • CHECKED_OUT
  • CANCELLED

Booking Type

Possible Values:

  • ONLINE
  • WALK_IN

Business Type

Possible Values:

  • VENUE
  • EVENT