Once a booking exists, the status
field is how it progresses through its lifecycle.
The status can be changed using the following API request:
PUT /api/beta/bookings/{booking_id}/status
{
"status": "accepted"
}
{booking_id}
- (string) The ID of the bookingstatus
- (string) The new Booking statusAll Bookings start with pending status.
The pending
status is the initial status for Bookings.
Valid next status values are:
The accepted
status indicates that a booking has been accepted.
Valid next status values are:
The declined
status indicates that a booking has not been accepted.
Once a Booking has the declined
status, its status cannot be changed.
The completed
status indicates that a booking has been successfully completed.
The cancelled_by_supplier
status indicates that the supplier (Vehicle owner) has cancelled the booking.
Once a Booking has the cancelled_by_supplier
status, its status cannot be changed.
The cancelled_by_user
status indicates that the user (creator of the Booking) has cancelled the booking.
Once a Booking has the cancelled_by_user
status, its status cannot be changed.
When the status of a Booking is changed, the booking-status-changed Webhook is triggered.