Booking status

All bookings have a status field which indicates the current state of a Booking.

Acceptabe status options are available from the following API:

GET /api/beta/booking-statuses

Response:

{
	"booking_statuses": [
		{
			"key": "cancelled_by_supplier",
			"description": "Booking was cancelled by the supplier"
		},
		{
			"key": "cancelled_by_user",
			"description": "Booking was cancelled by the user"
		},
		{
			"key": "pending",
			"description": "Booking is waiting to be handled"
		},
		{
			"key": "accepted",
			"description": "Booking is accepted"
		},
		{
			"key": "declined",
			"description": "Booking is declined"
		},
		{
			"key": "completed",
			"description": "Booking is completed"
		}
	]
}
  • booking_statuses - (array) List of supported Booking status values
  • booking_statuses[].key - (string) The Booking status key that should be used in other APIs
  • booking_statuses[].description - (string) Short human readable description of the Booking status

It is recommended that your application periodically refresh any local caches of this information from this API, to ensure you are working with the most up-to-date data.

See also