A booking.
Bookings are the core unit of work for carriers and locations.
Bookings contain one or more tasks, which are the core unit of work
for senders and receivers.
General 20
| Field | Type | Description |
|---|
id* | ID! | The ID of the booking,
The ID will always be in the format of "MDB-XX-XXXX-XXXX"
where the first two XX after MDB are the last two digits of the year the booking
was created in. |
pin | ID | The PIN code.
Only a booking with a space has a PIN code.
This code is guaranteed to be unique within 72 hours forward or backwards from the booking.
Otherwise, no uniqueness is guaranteed. |
requestedTime* | Timestamp! | The requested time of the booking. |
bookedTime | Timestamp | The booked time of the booking.
Will not be present if the booking hasn't been approved. |
duration* | Int! | The duration of the booking, in minutes. |
actualLoad | [ActualLoadQuantity!] | The actual load of the booking.
A location can set the actual load once the booking arrives. |
tasks* | [Task!]! | A list of tasks on the booking. |
comments* | [Comment!]! | A list of comments on the booking. |
formResponses* | [FormResponse!]! | Form responses associated with the booking |
driver | Driver | Driver linked to the current booking. |
reassignedFrom | ID | The booking that this booking was reassigned from, if any. |
reassignedTo | ID | The booking that this booking was reassigned to, if any. |
userSubscriptionStatus | Boolean | This flag indicates the notification subscription status of the user that is querying.
A value of true indicates the user is subscribed.
A value of false indicates the user has unsubscribed.
A value of null indicates that there is no specific subscription status for this booking. |
nextStatuses* | [Status!]! | Return the statuses that the given booking can move to, when updated by the given organisation.
This does not count booking status overrides. |
headerLoads* | [LoadQuantity!]! | A list of header loads defined for this booking |
headerLoadsPlanned* | [LoadQuantity!]! | A list of planned header loads defined for this booking |
tasksPlanned* | [PlannedTask!]! | A list of tasks initially planned before arrival.
May differ from `tasks` if actuals were recorded during receipting. |
subcarrier | OrganisationReference | Sub carrier if exists |
yardAssets* | [YardAssetLink!]! | Yard assets associated with the booking |
updatableFields* | [FieldCapturePoint!]! | A list of field capture points from the Submitted status. |
Carrier 2
Location 1
Area 1
| Field | Type | Description |
|---|
area | AreaReference | The area of the booking.
May be requested or actual, depending on the
status of the booking.
Null if the booking is submitted but no area has been provided. |
Space 1
| Field | Type | Description |
|---|
space | SpaceReference | The space assigned to this booking.
Will not be present if the booking hasn't been approved. |
Vehicle 1
Direction 1
Status 1
| Field | Type | Description |
|---|
status* | Status! | The present status of the booking. |
Booking 2
| Field | Type | Description |
|---|
bookingHistory* | [History!]! | The history of a booking, ordered from earliest to latest. |
bookingType* | BookingType! | The type of the booking. |
Field 1
| Field | Type | Description |
|---|
fields* | [FieldData!]! | Field data associated with the booking |
Created 1
| Field | Type | Description |
|---|
createdAt* | Timestamp! | The timestamp of booking creation (UTC) |
Modified 1
| Field | Type | Description |
|---|
modifiedAt* | Timestamp! | The timestamp of the last booking event (UTC). |
