StatusReference
Object: StatusReference
Section titled “Object: StatusReference”A booking status.
This is a simpler reference to statuses. Check the full Status interface for more information.
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id* | UUID! | The ID of the status. |
key* | EntityKey! | A user-defined, stable identifier for the status. |
name* | String! | The name of the status. Status names are unique. |
description | String | The description of the status. |
type* | StatusType! | The type of the status. Core statuses have special rules on modification, and can never be deleted. The Submitted status can have entry fields, but no exit fields. The Completed status can have entry fields, but no exit fields. The Approved status can have exit fields, but no entry fields. |
carrierProgressable* | Boolean! | Whether this status is available to the carrier. If true, the carrier or the location can move from any status to this status. If false, only the location can move to this status. |
colour* | Colour! | The colour of the status to be displayed as. |
highlighted* | Boolean! | Flag indicating if value should be highlighted in display |