Status model of Bookings

This article explains the different statuses a booking progresses through. If you don't know yet what a booking is, please read the Bookings article first.

Introduction

Every Booking on MotionTools progresses through different statuses during its lifecycle. It’s critical to understand the meaning of each status, as available actions and features, as well as the visibility, are directly related to or restricted by its status.

A Booking doesn’t necessarily go through all available statuses. Some statuses may be skipped during transitions. For example, if an operator hasn’t enabled payments, a booking will never enter the Processing Payment status.

If you are developing integration with MotionTools, note that the status names shown on the Dashboard may slightly differ from the names used in the API. To receive notifications for every status change, you can subscribe to the corresponding webhook event.

Statuses

On hold

to_be_dispatched

An On Hold status indicates that a Booking was created but hasn't been dispatched into a Tour yet.

On Hold is also the initial status of all Bookings if the Manual Dispatching feature is enabled for a service of a Booking.

Available transition	Transition on API	Trigger
On Hold → Dispatched	dispatch	All stops of a booking were merged into tours. This happens automatically when the Manual Dispatching feature is disabled.
On Hold → Partially dispatched	partially_dispatch	Some stops of a booking were merged into tours
On Hold → Cancelled	cancel	A booking was cancelled

Dispatched

dispatched

A Dispatched status indicates that all stops of a Booking were distributed between one or multiple Tours. The Booking will transition straight to Done as soon as all stops are completed unless any stops fail.

Available transition	Transition on API	Trigger
Dispatched → Done	complete_stops	All stops of a booking were completed via corresponding tours
Dispatched → On Hold	undispatch_stops	All stops of a booking were undispatched, and the Manual Dispatching feature is enabled for the service of a booking
Dispatched → On Hold	complete_stops	A booking was operationally completed, but all stops failed
Dispatched → Partially Dispatched	undispatch_stops	Only some stops of a booking were undispatched
Dispatched → Partially Dispatched	complete_stops	A booking was operationally complete, but some stops failed
Dispatched → Processing Payment	process_payment	Only if Payment feature is enabled
Dispatched → Cancelled	cancel	A booking was cancelled

Partially dispatched

partially_dispatched

A Partially Dispatched status indicates that only some of its stops were distributed between Tours or that a Booking has failed stops.

Available transition	Transition on API	Trigger
Partially Dispatched → Dispatched	dispatch	The remaining stops were distributed between tours
Partially Dispatched → On Hold	undispatch_stops	All stops of a booking were undispatched, and the Manual Dispatching feature is enabled for the service of a booking
Partially Dispatched → Cancelled	cancel	A booking was cancelled

Done

done

A Done status indicates that a booking has been operationally completed, i.e., all stops of the Booking were completed by a Driver.

Available transition	Transition on API	Trigger
Done → Processing payment	process_payment	The platform started processing payment after a booking is completed operationally
Done → Paid	paid	If a tenant doesn’t have payments enabled, a booking transitions to Paid after it’s completed operationally

Processing payment

processing_payment

A Processing Payment status indicates that that the payment is yet to be received. Depending on the payment method selected for the booking, this process can be finalized automatically or may require manual confirmation by an Admin. For instance, invoice payments always require manual confirmation, whereas credit card payments will be resolved automatically unless a card charge fails.

Available transition	Transition on API	Trigger
Processing payment → Paid	paid	A payment was confirmed automatically, or an Admin marked a booking as paid manually
Processing payment → Cancelled	cancel	A booking was cancelled

Paid

paid

This is the final status of a Booking. Note that a Booking will transition to this status even if payments are disabled for a tenant.

Cancelled

cancelled

This is the final status of a booking if a booking is cancelled by an Admin, Organization Manager, or Customer.