Input objects

AccessCodeBookingInput

Access-Code booking creation and updates.

Arguments

Name	Description
code String!	The code of the booking. The code is canse insensitive and can only contain alpha-numeric characters. The code must be unique to access-code bookings at the organisation. To avoid conflicts with booking PINs, the code cannot be a 5-digit number.
name String!	The name of the booking.
description String	The description of the booking. Has no effect on the created bookings.
expiresAt Timestamp	The time, in UTC, when the access code automatically expires. If null, the access code will not automatically expire.
carrierId UUID!	The carrier of the booking.
areaId UUID!	The area of the booking.
spaceId UUID!	The space of the booking.
vehicleId UUID!	The vehicle of the booking.
duration Int!	The duration of the booking.
tasks [TaskInput!]!	The tasks of the booking.
fields [FieldDataInput!]!	Fields of the booking.
statusId UUID!	The status the booking should be placed in on creation. Cannot be of type Submitted, Cancelled or Exception.
headerLoads [LoadQuantityInput!]!	The header loads of the booking.

AreaInput

A logical area, within an organisation.

Organisations are subdivided into areas and spaces. Spaces can be assigned to areas, from whence they can be booked against. Areas are the level at which rulesets are defined and applied.

Arguments

Name	Description
name String!	The name of the area. Max length of 250 characters. Must be unique per organisation.
description String	The description of the area.
instructions String	A set of instructions, to be displayed with a booking.
minimumMinutesInAdvance Int	The minimum time in advance a booking must be submitted by. If the requested time minus the current time is less than minimumMinutesInAdvance, the booking cannot be made. In the circumstance where the area is not selected, the booking engine will consider minimumMinutesInAdvance, and will not automatically approve any booking to an area failing the above condition. Default value if null is 0.
maximumMinutesInAdvance Int	The maximum time in advance a booking must be submitted by. If the requested time minus the current time is more than maximumMinutesInAdvance, the booking cannot be made. In the circumstance where the area is not selected, the booking engine will consider maximumMinutesInAdvance, and will not automatically approve any booking to an area failing the above condition. maximumMinutesInAdvance must be greater than minimumMinutesInAdvance. Default value if null is 14 days.
maximumAutoApproveMinutes Int	The maximum duration of a booking that will be automatically approved. If the duration of the booking is greater than this, it will not be auto approved to this area. In the circumstance where the area is not selected, the booking engine will consider the duration of the booking in relation to each possible area, and maximumAutoApproveInMinutes. It will not automatically approve any booking failing this condition. If maximumAutoApproveMinutes is null, there is no maximum limit to duration for automatic approval.
openTime Timestamp	The opening date of the area. Bookings will not be accepted before this date, even for manual approval. If null, the area opens immediately.
closeTime Timestamp	The closing date of the area. Bookings will not be accepted after this date, even for manual approval. If null, the area will never close.
displayPin Boolean	Whether a booking's PIN code should be displayed on the booking. A booking's PIN code is a semi-unique code that is unique within 72 hours before or after the booking.
address PhysicalAddressInput	Optional physical address

AttributeInput

Wrapper for attributes, initially for documents

Arguments

Name	Description
key String!	key, required
value String	value, can be empty

AutoTransitionInput

How a status should automatically transition to another status.

Arguments

Name	Description
statusId UUID!	The status to change into.
minutes Int!	How long after the relative time to wait before changing.
relativeTo TransitionType!	The base time from which the change is relative to. Not applicable for Submitted or On Hold statuses.
addDuration Boolean!	Whether to add the booking's duration Not applicable for Submitted or On Hold statuses.

BaseOrganisationInput

Arguments

Name	Description
name String!	The name is normalised before lookup.
coreDetails CoreDetailsInput	Optionally specify core details for this new connection.
groupIds [UUID!]	Automatically place this connection in one or more groups.

BookedYardAssetInput

Arguments

Name	Description
yardAssetId UUID
yardAssetExternalId String
yardAssetTypeId UUID!
direction Direction!
tasks [TaskInput!]!

BookingEntityRefInput

A booking refrence input

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.

Arguments

Name	Description
carrier EntityRefInput!	The carrier reference.
location EntityRefInput!	The location reference.
vehicle EntityRefInput!	Vehicle reference.
area EntityRefInput	The area reference. Must only be present if pickAreaOnCreateBooking is true.
tasks [TaskEntityRefInput!]!	A list of task references to add to the booking.
time Timestamp	The requested time for the booking.
timeRange TimeRange	A requested time range for the booking. The booking will be automatically approved for the first time slot available in the range specified. If there are no times available in the specified time range, the booking will be submitted for manual approval at the specified start time. This field is required if not providing the time value.
note CommentInput	A note. This will be added as the first comment to a booking.
fields [FieldDataEntityRefInput!]!	Field references required by the Submitted status.
driver DriverIdentifier	The driver input identifier.

BookingInput

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.

Arguments

Name	Description
carrierId UUID!	The ID of the carrier.
locationId UUID!	The ID of the location.
vehicleId UUID!	The ID of the vehicle type.
areaId UUID	The ID of the area. Must only be present if pickAreaOnCreateBooking is true.
tasks [TaskInput!]!	A list of tasks to add to the booking.
time Timestamp	The requested time for the booking.
timeRange TimeRange	A requested time range for the booking. The booking will be automatically approved for the first time slot available in the range specified. If there are no times available in the specified time range, the booking will be submitted for manual approval at the specified start time. This field is required if not providing the time value.
note CommentInput	A note. This will be added as the first comment to a booking.
fields [FieldDataInput!]!	Any fields required by the Submitted status.
driver DriverIdentifier	The driver input identifier.
headerLoads [LoadQuantityInput!]
yardAssets [BookedYardAssetInput!]	Yard assets and their corresponding tasks.

BookingNoticeInput

Arguments

Name	Description
heading String!
message String!
type BookingNoticeType!
timeRange TimeRange!

BookingOptionInput

A booking option represents some kind of property on the booking, or loads. For example, booking options may be used to represent the type of loads you have on board, e.g dangerous, cold, heavy, etc.

Arguments

Name	Description
name String!	The name of the bookingOption. This cannot be changed after being set.
description String	The description of the bookingOption.

BookingOverrideInput

A booking override.

Overrides the current booking properties.

Arguments

Name	Description
carrierId UUID!	The ID of the carrier.
vehicleId UUID!	The ID of the vehicle type.
tasks [BookingTaskChangeInput!]!	A list of tasks to add to the booking.

BookingsFilterInput

A booking must match all of the conditions in a filter. If a condition is null, it's always matched. String conditions are always 'contains' conditions, that is a

Comparisions are case-insensitive.

Arguments

Name	Description
timeRange TimeRangePartial	The time range to return bookings in. Will check booked time if the booking has a space, else requested time.
searchType BookingSearchType	Which mode to use for the time range
location String	Search by location name.
locationIds [UUID!]	Limit to only given locations.
space String	Search on space name.
spaceIds [UUID!]	Limit to only given locations.
carrier String	Search by carrier name.
carrierIds [UUID!]	Limit to only given carriers.
subcarrier String	Search by subcarrier name.
subcarrierIds [UUID!]	Limit to only given subcarriers.
statusType [StatusType!]	Search by status type.
status String	Search by status name.
statusIds [UUID!]	Limit to only given statuses.
onsite String	Search by onsite name.
onsiteIds [UUID!]	Limit to only given onsites.
offsite String	Search by offsite name.
offsiteIds [UUID!]	Limit to only given offsites.
vehicle String	Search by vehicle name.
vehicleIds [UUID!]	Limit to only given vehicles
load String	Search by load name.
loadIds [UUID!]	Limit to only given loads.
bookingOption String	Search by booking option name.
bookingOptionIds [UUID!]	Limit to only given booking options.
fields [FieldSearchInput!]	Search by fields. Multiple fields can be specified. All must be matched.
documentIds [ID!]	Search by document identifiers.
areaIds [UUID!]	Search by area identifiers. Limit to only given locations.
loadTags [ID!]	Search bookings by load tags.
groupIds [UUID!]	Search bookings that have an organisation in the specified group. Searches for all organisations on a booking: carrier, senders, receivers.
documentTypeIds [UUID!]	Search for bookings that contain one or more documents of a specific type.
documentStatusIds [UUID!]	Search for bookings that contain one or more documents in a specific status.
participantIds [UUID!]	Search for bookings that one or more organisations are a participant in.
accessCodes [String!]	Search for bookings that were created with a specific access code.
direction [String!]	Search for bookings with specific directions (INBOUND, OUTBOUND, RELOAD, EMPTY)

BookingsFilterInputV2

A booking must match all of the conditions in a filter. If a condition is null, it's always matched. String conditions are always 'contains' conditions, that is a

Comparisions are case-insensitive.

Arguments

Name	Description
carrier EntityRefComparisonInput
subcarrier EntityRefComparisonInput
location EntityRefComparisonInput
loadQuantity [LoadQuantityFilterInput!]
fieldValue [FieldValueFilterInput!]
vehicle EntityRefComparisonInput
activeTime Comparison
modifiedTime Comparison
createdTime Comparison
space EntityRefComparisonInput
area EntityRefComparisonInput
occupant EntityRefComparisonInput
offsite EntityRefComparisonInput
document EntityRefComparisonInput
documentType EntityRefComparisonInput
documentStatus EntityRefComparisonInput
loadTag Comparison
group EntityRefComparisonInput
bookingOption EntityRefComparisonInput
status EntityRefComparisonInput
participant EntityRefComparisonInput
accessCode Comparison
id Comparison
direction Comparison

BookingStatusEntityRefInput

Status reference input.

Arguments

Name	Description
status EntityRefInput!	The status reference to update to. Must be a subsequent status to the current status or an exception status
fieldReferences [FieldDataEntityRefInput!]!	An array of reference inputs containing new or updated field data

BookingTaskChangeInput

A task that overrides the given task.

Arguments

Name	Description
task TaskInput	A task to add to the booking
taskId ID	The task to overwrite

BookingYardAssetLinkedStatusFlowsInput

Arguments

Name	Description
yardAssetTypeId UUID!
statusFlows [YardAssetStatusFlowInput!]!

CapacityUnitInput

A capacity unit input is a user-defined unit that can be used to capacity the throughput of a site.

Arguments

Name	Description
name String!	The name of the capacity unit.
description String	A description of the capacity unit.

CapacityUnitLimitInput

Capacity unit limits input

Arguments

Name	Description
type CapacityUnitLimitType!	The type of limit.
weekdays [Weekday!]	The days of the week that this limit applies to.
capacityUnitId UUID!	The capacity unit to set a limit for.
quantity Int!	The quantity of capacity units that def
areas [UUID!]	The areas that this limit applies to

CommentInput

A comment.

Arguments

Name	Description
content String!	The content of your comment.

Comparison

Comparison type. At least one of the fields must be occupied.

Arguments

Name	Description
eq String	equal
neq String	not equal
match String	match (like pattern)
in [String!]	in
nin [String!]	not in
lt String	less than
lte String	less than or equal
gt String	greater than
gte String	greater than or equal

ConditionInput

A condition represents some state that must be matched by a booking, to match the condition.

GraphQL does not support input interface types, so all condition types must be supported by one condition input type.

Arguments

Name	Description
type ConditionType!	The type of the condition. The condition type will determine what other fields are required. Filling out any other field will error out.
not Boolean	Whether the condition is a 'not' condition. Not conditions are inverse: A regular condition will pass when the condition matches (right day, time, load present, etc.) While a not condition will pass only when the condition does not match (e.g a not condition on 'Tuesday' will match any day that isn't Tuesday) When null or not present, 'not' is assumed to be false.
times [RuleTimeInput!]	An array of times in the day in which this condition is valid. Only reqired for the 'Time' type.
weekdays [Weekday!]	An array of weekdays which this condition is valid. Only required for the 'Week' type.
days [RuleDateInput!]	An array of dates in the year which this condition is valid. Only required for the 'Year' type.
ids [UUID!]	An array of IDs. The specific meaning of this field differs with the type. For the 'Vehicle' type, it is an array of Vehicle IDs. For the 'Load' type, it is an array of Load IDs. For the 'BookingOption' type, it is an array of BookingOption IDs. For the 'Space' type, it is an array of Space IDs. For the 'Group' type, it is an array of Group IDs. For the 'DocumentStatus' type, it is an array of DocumentStatus IDs. For the 'DocumentType' type, it is an array of DocumentType IDs For the 'Organisation' type, it is an array of Organisation IDs For the 'YardAssetType' type, it is an array of YardAssetType IDs It is not used for any other type.
strings [String!]	An array of dates load tags for which this rule should apply. Only required for the 'LoadTag' type.
direction Direction	A task direction mode. Only required for the 'Direction' type.
pointBlockTimes [Time!]	A list of points in time. Only required for the 'PointBlock' type.

ConnectionCodeInput

A connection code can be used to connect two organisations together.

Arguments

Name	Description
emails [String!]	A list of email addresses to email this invite to.
expiresIn Int	How long until this invite should expire, in minutes. If not provided, the invite does not expire.
uses Int	How many uses this invite has. Null is unlimited.
groups [UUID!]!	IDs of groups to add the consuming partner to.

ConnectionRequestInput

Details for requesting a new connection.

Arguments

Name	Description
note String	A note to be provided to the organisation you are requesting a connection from.

ContactInput

Contact creation and modification type.

Arguments

Name	Description
name String!	The name of this contact.
email String	The email address of this contact. Must contain exactly one @ sign.
phone String	The phone number of a contact. Must start with a '+' character, followed by the country code and phone number. May contain an 'x' at the end followed by more numbers, to designate an extension. Will be validated by the following regex: ^\+\d+(x\d+)?$
description String	The description of a contact.

CoordinatesInput

A coordinates pair, with orientation and level.

Arguments

Name	Description
latitude Float!	Latitude can range from -90 to +90. Positive 90 represents a northern latitude, while -90 represents southern.
longitude Float!	Longitude can range from -180 to +180. +180 represents eastern, while -180 represents western.
orientation Int!	Orientation can range from 0 to 359.
level String	A short string to be displayed as the level of a complex the space is on.

CoreDetailsInput

A connection's core details are location-specific options for customizing a connection.

Arguments

Name	Description
id [String!]
name String

DaysOfWeekRecurranceInput

A weekly recurrance, based on days of the week and times on those days.

Arguments

Name	Description
daysOfWeek [Weekday!]!	The days of the week to create the booking.
times [Time!]!	The times in the day the booking will be created on.

DocumentEntityRefInput

Document expected when created a new Document

Arguments

Name	Description
externalId String!	The external identifier of the document will always be same as in the physical document
occupant EntityRefInput	Offsite reference for the document.
offsite EntityRefInput	Offsite reference for the document.
carrier EntityRefInput	Carrier reference for the document.
direction Direction!	Represents the direction whether goods are intending to be brought in or taken out.
loads [LoadQuantityEntityRefInput!]	Load references of this document
settings DocumentSettingsInput!	Sets the configuration for this document
validDates TimeRangePartial	Sets the range of valid dates when this document is valid
preferredDates TimeRangePartial	Set the preferred dates when this document is valid
bookingOptions [EntityRefInput!]!	Booking option references associated with the task.
description String	The description of the organisation.
attributes [AttributeInput!]!	This will be treated as a Dictionary<string,string>, so data looks like {key:"value",key:"value"...}
status EntityRefInput	Document's status reference, if present.
type EntityRefInput	Document's type reference, if present.

DocumentFilter

This filter is used to make specific searches in a list of documents.

Arguments

Name	Description
occupantIds [UUID]	Filter documents for the occupant's identifiers provided.
offsiteIds [UUID]	Filter documents for the offsite's identifiers provided.
carrierIds [UUID]	Filter documents for the carrier's identifiers provided.
direction Direction	Filter documents for their direction inbound or outbound.

DocumentSettingsInput

It is the parameters' configuration for a document. Every document must have set this settings.

Arguments

Name	Description
mode DocumentMode!	Regulates changes in the original document.
maxUses Int	Number of times a document can be used in a booking.

DocumentsFilterInput

Arguments

Name	Description
id EntityRefComparisonInput	Filter documents by ID.
carrier EntityRefComparisonInput	Filter documents by the document carrier organisation.
location EntityRefComparisonInput	Filter documents by the document location organisation.
occupant EntityRefComparisonInput	Filter documents by the document occupant organisation.
offsite EntityRefComparisonInput	Filter documents by the document offsite organisation.
createdTime Comparison	Filter documents by the date that they were created.
modifiedTime Comparison	Filter documents by the date that they were modified.
validTime Comparison	Filter documents by the date that they are valid.
preferredTime Comparison	Filter documents by the date that they are preferred.
bookingCount Comparison	Filter documents by the number of bookings that reference this document
acknowledgementCount Comparison	Filter by number of acknowlegements
carrierAcknowledgement Boolean	Filter on if the carrier org has/has not acknowledged
occupantAcknowledgement Boolean	Filter on if the onsite org has/has not acknowledged
offsiteAcknowledgement Boolean	Filter on if the offsite org has/has not acknowledged
documentType EntityRefComparisonInput	Filter on document type
documentStatus EntityRefComparisonInput	Filter on document status
direction Direction	Filter documents for their direction inbound or outbound.

DocumentStatusInput

Arguments

Name	Description
name String!

DocumentSubmissionInput

Document expected when created a new Document

Arguments

Name	Description
externalId String!	The external identifier of the document will always be same as in the physical document
occupantId UUID	The offsite for the document.
offsiteId UUID	The offsite for the document.
carrierId UUID	The carrier for the document.
direction Direction!	Represents the direction whether goods are intending to be brought in or taken out.
loads [LoadQuantityInput!]	Loads of this document
settings DocumentSettingsInput!	Sets the configuration for this document
validDates TimeRangePartial	Sets the range of valid dates when this document is valid
preferredDates TimeRangePartial	Set the preferred dates when this document is valid
bookingOptions [UUID!]!	A list of booking options associated with the task.
description String	The description of the organisation.
attributes [AttributeInput!]!	This will be treated as a Dictionary<string,string>, so data looks like {key:"value",key:"value"...}
statusId UUID	The ID of the document's status, if present.
typeId UUID	The ID of the document's type, if present.

DocumentTypeInput

Arguments

Name	Description
name String!

DriverIdentifier

One value must be provided as a driver identifier

Arguments

Name	Description
userId UUID	The id of the driver member of your organisation to add
email String	The email address of the driver to add

EmailInput

A generic type used for specifying an email.

Arguments

Name	Description
subject String!	The subject line of the email
message String!	The message. Currently, the message is not extensively formatted.

EntityRefComparisonInput

Arguments

Name	Description
id Comparison	Entity id.
name Comparison	Entity name, where applicable.
type Comparison	Entity type property, where applicable.

EntityRefInput

Entity reference input

Arguments

Name	Description
id UUID	The entity's ID.
name String	The entity's name.

FieldCapturePointInput

A point in the status flow where a field should be captured.

Arguments

Name	Description
required Boolean!	Whether the field is required or not. If false, the field can be null or omitted. If true, the field must be supplied when updating, or the status change will be rejected.
position FieldPosition!	What position on the status this field should be captured at. For Submitted, Completed and the exception statuses, it must be the entering position. For approved, it must be the exiting position.
statusId UUID!	The ID of the status to capture the field on.

FieldDataEntityRefInput

Entity reference input type for field data.

Arguments

Name	Description
field EntityRefInput!	The field reference input.
value String	The value of the field. What this means is specific to the type of the field. A file field requires the token from an uploaded file. This token must not be used on another booking.
fileId UUID	The id is the unique reference to an attached file. This can only be filled out when using a field of File type. The file provided cannot already be assigned to another resource.

FieldDataInput

Input type for field data.

Arguments

Name	Description
field UUID!	The ID of the field.
value String	The value of the field. What this means is specific to the type of the field. A file field requires the token from an uploaded file. This token must not be used on another booking.
fileId UUID	The id is the unique reference to an attached file. This can only be filled out when using a field of File type. The file provided cannot already be assigned to another resource.

FieldInput

A field is an extra, custom piece of data captured some time in a booking.

Arguments

Name	Description
label String!	The label of the field.
description String	The description of the field.
regex String	A regular expression to validate this field. Not applicable if options are defined. The choice you pick will not be validated against the regex. This regular expression will be executed in single-line mode, so '.' will match \n characters. Only applicable on String fields, when specified on other field types an error is returned.
maxLength Int	The maximum length of this field. Not applicable if options are defined. The choice you pick will not be validated against the maximum length. Only applicable on String fields, when specified on other field types an error is returned.
multiLine Boolean	Whether a string field should be displayed as multiple lines or not. Has no effect on processing the field, only display. Not applicable if options are defined. Only applicable on String fields, ignored on all other fields.
options [OptionInput!]	A list of options, defining valid return values. If set, you can only submit any of the 'value' fields in any option when submitting the field. If you specify options, you must have at least one option. Only applicable on String fields, when specified on other field types an error is returned.
type FieldType!	The type of data the field accepts. You cannot change a field's type after creation.
capturePoints [FieldCapturePointInput!]!	A set of capture points to be captured relative to this status.
allowedFileTypes [String!]	A list of approved file types that can be uploaded to this field. Only globally-approved file types can be included. Can only be set if type is 'Field'. If no value is provided, all globally-approved file types are allowed.
maxFileSize Int	The maximum file size (in bytes) that can be uploaded to this field. This value cannot exceed the maximum file size approved for this organisation. Can only be set if type is 'Field'. If no value is provided, the maximum approved file size for the organisation will be used.
internal Boolean!	If true, this field & corresponding data is visible only to the location.
passTypeId UUID	pass type id
autoPurgeValue Boolean!	Enable this option to have values captured automatically removed in accordance with organisation field data removal policy.
highlighted Boolean	If true, the field will be displayed with higher priority

FieldSearchInput

A search filter for fields on a booking.

Arguments

Name	Description
fieldId UUID!	The ID of the field to search for
value String!	The value of the field to search by.
exactMatch Boolean	Whether or not the field must be an exact match. Defaults to false.

FieldValueFilterInput

Arguments

Name	Description
field EntityRefInput!
value Comparison!

GroupInput

A group of connections. Groups are used to determine who can and cannot book at an area.

Arguments

Name	Description
name String!	The name of the group.
description String	The description of the group.
suggested Boolean!	Whether organisations in a group should be suggested to other organisations as suggested organisations to connect with.
hidden Boolean!	Whether the group should be hidden from view of the user.
documentBaseOffsiteDefault Boolean	If enabled, base offsite organisations created on documents will be automatically placed in this group.
documentBaseOccupantDefault Boolean	If enabled, base occupant organisations created on documents will be automatically placed in this group.
documentBaseCarrierDefault Boolean	If enabled, base carrier organisations created on documents will be automatically placed in this group.

IconInput

An area icon.

An icon will be displayed as a coloured shape of the given type, with the text overlaid on top, encompassed by the shape.

Arguments

Name	Description
shape Shape!	The shape of the icon.
shapeColour Colour!	The colour of the shape.
textColour Colour!	The colour of the text.
text String	The text on the shape.

LoadInput

A load represents an amount of something in a booking. Example loads include pallets, crates, or cartons. Each load on a booking has an associated quantity.

Arguments

Name	Description
name String!	The name of the load type. This cannot be changed after being set.
description String	The description of the load type.
duration Int!	The time needed to process one of this load, in seconds. This is used to calculate the booking duration. Must be above or equal to 0.
position LoadBookingPosition	Where the load must be positioned. If it's not provided, it defaults to Task.
class ID	reference to load class

LoadQuantityEntityRefInput

A reference input load and associated quantity.

Arguments

Name	Description
load EntityRefInput!	The load reference input.
quantity Int!	The quantity of this load.
loadTag String	Essential field to store specific information about the load.

LoadQuantityFilterInput

Arguments

Name	Description
load EntityRefInput!
quantity Comparison!

LoadQuantityInput

A load and associated quantity.

Arguments

Name	Description
loadId UUID!	The ID of the load.
quantity Int!	The quantity of this load.
loadTag String	Essential field to store specific information about the load.

ManualBookingInput

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.

This model is used for CreateManualBooking, which does less strict checking.

Arguments

Name	Description
carrierId UUID!	The ID of the carrier.
vehicleId UUID!	The ID of the vehicle type.
areaId UUID!	The ID of the area.
spaceId UUID!	The ID of the space.
tasks [TaskInput!]!	A list of tasks to add to the booking.
time Timestamp!	The time for the booking.
note CommentInput	A note. This will be added as the first comment to a booking.
fields [FieldDataInput!]!	Any fields possible in the booking.
duration Int!	The duration of the booking.
statusId UUID!	The status to create the booking at.
driver DriverIdentifier	The driver input identifier.
headerLoads [LoadQuantityInput!]
yardAssets [BookedYardAssetInput!]	Yard assets and their corresponding tasks.

OptionInput

An option for a field.

Arguments

Name	Description
label String!	The label of the option, to be displayed to the users.
value String!	The value of the option. This value is the value that must be returned to the API when filling in an option. The value does not have to be the same as the label, but it's recommended to make it at least somewhat legible on its own, as it may be displayed if the choice is later removed.

OrganisationCreationInput

Organisation creation type.

Arguments

Name	Description
name String!	The name of the organisation. Cannot be changed once set.
description String	The description of the organisation.
address PhysicalAddressInput	The address of the organisation.
timezone String!	The timezone the organisation resides in.
settings OrganisationSettingsInput!	Settings depending on visibility and invite requests.
contacts [ContactInput!]!	Contacts to add to the organisation. You must have at least one to create an organisation.
industry String	Must be one of the accepted values.

OrganisationFieldDataRemovalPolicyInput

Arguments

Name	Description
days Int	Value must be between 30 days and 2 years

OrganisationFilter

A filter used for searching for organisations.

Arguments

Name	Description
ids [UUID!]	A list of IDs to filter by. Only organisations with these IDs will be shown. If this is null, no ID filtering is applied.
name String	A string to filter names by. Any organisation with a name containing the string, case-insensitive, will be shown. If this is null, no name filtering is applied.

OrganisationLocationInput

General location settings.

Arguments

Name	Description
bookingInstructions String	Instructions to be displayed on every booking at, and when booking at this location.
taskInstructions String	Instructions to be displayed on the booking wizard, in relation to creating your tasks.
timeInstructions String	Instructions to displayed on the Time Selection page of the booking process.
requireInstructionsAcknowledgement Boolean!	Whether users must acknowledge instructions before proceeding with booking.
bookingInterval Int!	The booking appointment interval. Bookings will always start on this subdivision of an hour. e.g with an interval of 15, a booking will be made on the hour, at 15 past, at 30 past, or at 45 past. An appointment interval must always divide 60 - therefore, the only valid values are: 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30 and 60.
pickAreaOnCreateBooking Boolean!	Whether you have to pick your area on booking creation or not. When true, you must include a area ID with the booking creation When false, you must not include an area ID with booking creation. An area will be assigned to you.
mandatoryOffsiteOnCreate Boolean!	Whether the task offsite (sender for Inbound, receiver for Outbound) must be provided when a booking is created.
documentFeatureStatus DocumentFeatureStatusView!	Configure document's feature in the task view
driverMode DriverMode!	Set up the driver feature for a location across the booking process.
minimumBookingOptionsSelected Int	The minumum number of booking options that may be selected on each task.
maximumBookingOptionsSelected Int	The maximum number of booking options that may be selected on each task. Must be greater than or equal to minimumBookingOptionsSelected.
taskDirectionMode TaskDirectionMode!	Determines what direction tasks are permitted to be at this location.
yardMode YardMode!	Determines if yard features are enabled at this location.
maximumTaskCount Int	Specify the maximum number of tasks that can be added without requiring manual review. If null, there is no limit.
manualApprovalPolicy ManualApprovalPolicy	Defaults to Allowed if not specified.
fallbackTimeRange Int	When in fallback policy, the number of hours both before and after the requested time that there must be no available spaces for fallback mode to accept the booking for manual approval. Must be null if ManualApprovalPolicy is not set to Fallback.
bookingHorizonDays Int!	The number of days in advance that a user can request a booking for, either for automatic or manual approval.

OrganisationSettingsInput

Settings modification type.

Arguments

Name	Description
public Boolean!	Whether an organisation is visible in in searches and queries to non-joined members.
allowConnectionRequests Boolean!	Whether people can request connections to this organisation. Changing this to false does not cancel any current connection requests.

OrganisationTokenValidityLimitInput

Token validity limit modification type.

Arguments

Name	Description
tokenValidityLimit Int	Duration for what a token is going to be valid

OrganisationUpdateInput

Organisation update type.

Arguments

Name	Description
description String	The description of the organisation.
address PhysicalAddressInput	The address of the organisation.
timezone String!	The timezone of the organisation.
industry String	Must be one of the accepted industry values.

PassInput

Arguments

Name	Description
id String!
attributes [AttributeInput!]!	This will be treated as a Dictionary<string,string>, so data looks like {key:"value",key:"value"...}
validity TimeRangePartial
type UUID!
url String

PassTypeInput

Arguments

Name	Description
name String!
key String!
url String!

PhysicalAddressInput

Physical location creation and modification type.

Arguments

Name	Description
address1 String!	The first line of an address, e.g Unit 2, 123 Example St
address2 String	The second line of an address, when necessary.
city String!	The city or town the address is located within, e.g Melbourne
postal String	A region specific postal identifier, such as a postal code or ZIP code.
region String!	The state, province, or other region the address is located within.
country String!	The country the address is located within.

ReassignBookingCarrierEntityRefInput

Hold needed parameters to reassign a carrier to a booking

Arguments

Name	Description
carrier EntityRefInput!	Carrier reference input.
status EntityRefInput!	Status reference input.
excludedFieldDataEntityRef [EntityRefInput!]	Excluded field reference inputs.

ReceiptingSettingsInput

Arguments

Name	Description
autoOffsiteDocuments [ID!]!
autoCarrierDocuments [ID!]!

RecurringBookingInput

A recurring booking. Recurring bookings represent bookings that are automatically created by the system on a specified period. Recurring bookings don't go through the booking engine, so are created approved. Recurring bookings are created past the max booked time, so there are no chances of conflicting with manually created bookings.

If something would change that would render creating the recurring booking impossible, i.e

• The connections between the location and the carrier, or any receivers, are removed.
• The carrier or any receivers are removed from the appropiate groups.
• Loads, bookingOptions, or vehicles are removed.
• The area or space is removed.
• The space is removed from the area. the booking is set to 'invalid', and no new bookings will be created.

Arguments

Name	Description
name String!	The name of the recurring booking. Has no effect on the created bookings.
description String	The description of the recurring booking. Has no effect on the created bookings.
time DaysOfWeekRecurranceInput!	The time settings determining when the booking will be created.
startDate Timestamp	The time when this recurring booking will start, or started. No bookings will be automatically created before this date. When null, start date is set to current time.
endDate Timestamp	The time when this recurring booking will end. No bookings will be automatically created after this date.
carrierId UUID!	The carrier of the booking.
areaId UUID!	The area of the booking.
spaceId UUID!	The space of the booking.
vehicleId UUID!	The vehicle of the booking.
duration Int!	The duration of the booking.
tasks [TaskInput!]!	The tasks in this booking.
fields [FieldDataInput!]!	Fields that will be submitted with this booking.
statusId UUID	Custom Status, optional
headerLoads [LoadQuantityInput!]!

RoleInput

A role is a collection of permissions that can be assigned to a user. Permissions therefore allow them to take actions.

Arguments

Name	Description
name String!	The name of the role.
description String	The description of the role.
permissions [Permission!]!	A list of permissions assigned to this role.

RuleDateInput

A date in a year.

Arguments

Name	Description
month Month!	The month of the year.
day Int!	The day of the month.

RuleInput

A rule, as applied to an area. All the conditions in the rule are ANDed together. That is, every present condition needs to match for the rule to match.

The result of the rule is determined by the rule's type. If a rule with Allow matches a given space and time, the booking will be allocated If no rule with Allow matches any space or time, the booking will not be allocated. If a booking with Allow matches a given space and time but a rule with Block matches as well, the booking will not be allocated to that space and time.

The default for any space and time is blocked, so if no rules apply, the booking will be blocked.

Options inside a condition are treated as OR. If a condition has multiple values that could match, only one needs to match for the condition to be considered valid.

Arguments

Name	Description
name String!	The name of the rule.
description String	The description of the rule.
reasonMessage String	The public description of the rule. This will be displayed to users if the rule causes them to not find times.
type RuleType!	The type of the rule. Allow rules allow a booking if they match. Block rules block a booking, even if an allow rule matched.
conditions [ConditionInput!]!	A list of conditions applying to the rule. Every condition must be satisfied to satisfy the rule.
validateTasksIndividually Boolean	Whether certain conditions (load, product, groups) are applied on a per-task level rather than a whole-rule level. If you have several conditions of these types, they must all match on the same task. It does not affect conditions of any other type. By default, this is false.

RuleTimeInput

A time period.

Arguments

Name	Description
begin Time!	The beginning of a period.
end Time!	The end of a time period.

SpaceInput

Space creation and modification type.

Arguments

Name	Description
name String!	The name of the space. Must be unique per organisation.
maxBookings Int	The maximum number of bookings that can be in this space at any given time. The booking engine will never assign more than this many bookings to a safe. Manual assignment may be used to overload a space. Cannot be below or equal to zero. By default, maxBookings is 1.
capacity Int	The capacity of this space. Every Load Type has a size. The vehicles booked in a space at any given time, won't have more combined size than the capacity of the space. Cannot be below or equal to zero. By default, capacity is 1.
priority Int	The priority of a space. A space with a higher priority will be booked over a space with a lower priority, when the spaces are both valid. By default, priority is 0.
coordinates CoordinatesInput	An optional coordinates set.

StatusInput

A creation or update of a status.

Arguments

Name	Description
name String!	The name of the status. Status names are unique.
description String	The description of the status.
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!	If the status should be highlighted

SubscriptionProfileInput

Arguments

Name	Description
autoSubscribeCreatedBookings Boolean!	If enabled, the user will be automatically subscribed to changes in all bookings they create.
autoSubscribeParticipantBookings Boolean!	If enabled, the user will be automatically subscribed to changes in all bookings they participate in.
autoSubscribeOrganisationBookings Boolean!	If enabled, the user will be automatically subscribed to changes in all bookings for each organisation they are a member of.

TaskEntityRefInput

A reference input task represents a core unit of work for a booking. A task has loads and booking options, and will be either incoming or outgoing. The onsite organisation must be referenced on the task, the offsite may be omitted. When a task is inbound, the receiver is the onsite, and the sender is the offsite. When a task is outbound, the sender is the onsite, and the receiver is the offsite.

Arguments

Name	Description
sender EntityRefInput	The assigned sender to the task. Incoming tasks do not require a sender. Outgoing tasks do.
receiver EntityRefInput	The assigned receiver to the task. Outgoing tasks do not require a sender. Incoming tasks do.
direction Direction!	The direction the task is going, inbound or outbound.
loads [LoadQuantityEntityRefInput!]!	A list of load references quantities on the task.
bookingOptions [EntityRefInput!]!	A list of booking option references associated with the task.
documentId ID	A document Id option

TaskInput

A task represents a core unit of work for a booking. A task has loads and booking options, and will be either incoming or outgoing. The onsite organisation must be referenced on the task, the offsite may be omitted. When a task is inbound, the receiver is the onsite, and the sender is the offsite. When a task is outbound, the sender is the onsite, and the receiver is the offsite.

Arguments

Name	Description
senderId UUID	The assigned sender to the task. Incoming tasks do not require a sender. Outgoing tasks do.
receiverId UUID	The assigned receiver to the task. Outgoing tasks do not require a sender. Incoming tasks do.
direction Direction!	The direction the task is going, inbound or outbound.
loads [LoadQuantityInput!]!	A list of load quantities on the task.
bookingOptions [UUID!]!	A list of booking options associated with the task.
documentId ID	A document Id option
yardAssetId ID	A yard asset Id option
yardAssetTypeKey ID	A yard asset type Id option

TimeRange

A range of time.

Arguments

Name	Description
begin Timestamp!	The start of the range, inclusive.
end Timestamp!	The end of the range, exclusive.

TimeRangePartial

One or all properties can be used to make a booking search.

Arguments

Name	Description
begin Timestamp	The start of the range, inclusive.
end Timestamp	The end of the range, exclusive.

UpdateBookingVehicleEntityRefInput

A vehicle reference represents the vehicle the booking will be using. Every booking must have exactly one vehicle, and the vehicle chosen determines how long the booking will take. Each vehicle also has a capacity. A booking will not be booked automatically into a space with too few capacity to contain the vehicle.

Arguments

Name	Description
area EntityRefInput	The area reference to be booked to
vehicle EntityRefInput!	The new vehicle reference for the booking

VehicleInput

A vehicle represents the vehicle the booking will be using. Every booking must have exactly one vehicle, and the vehicle chosen determines how long the booking will take. Each vehicle also has a capacity. A booking will not be booked automatically into a space with too few capacity to contain the vehicle.

Arguments

Name	Description
name String!	The name of the vehicle. This cannot be changed after being set.
description String	The description of the vehicle.
size Int!	The size of the vehicle. A vehicle will only be booked into a space with the capacity to support it. By default, size is 1. A size cannot be below 0.
duration Int!	The duration a booking with this vehicle will take, in seconds. Must be above or equal to 0.
class ID	optional entity class

VerificationRequestInput

A request to Mobiledock for your organisation to be verified.

Arguments

Name	Description
country String!	The country the organisation resides in.
companyCode String!	The provided 'company code'. A 'company code' is a term for some unambiguous identifier for the organisation. This can include, for instance, a business number.
note CommentInput	An initial comment to be left.

YardAssetAssignedBookingInput

Arguments

Name	Description
bookingId ID	The ID of the booking
direction Direction!	The direction of the assignment

YardAssetIDChangeInput

Arguments

Name	Description
value ID

YardAssetInboundBookingChangeInput

Arguments

Name	Description
value ID

YardAssetInput

Input for creating a new yard asset.

Arguments

Name	Description
externalId ID	The name of the asset
typeId UUID!	The type of the asset
position YardAssetPositionInput	The site-assigned position of the asset
timeAssignment YardAssetTimeAssignmentInput	The site-assigned time of the asset
statusId UUID!	The status of the asset
tasks [TaskInput!]!	A list of tasks to add to the asset
inboundTimeRange TimeRangePartial	The allowed pickup window for the asset
outboundTimeRange TimeRangePartial	The allowed delivery window for the asset
inboundBookingId ID	The id of the inbound booking
outboundBookingId ID	The id of the outbound booking

YardAssetOutboundBookingChangeInput

Arguments

Name	Description
value ID

YardAssetPatchInput

Arguments

Name	Description
externalId YardAssetIDChangeInput
type YardAssetTypeChangeInput
position YardAssetPositionChangeInput
timeAssignment YardAssetTimeAssignmentChangeInput
status YardAssetStatusChangeInput
tasks YardAssetTasksChangeInput
inboundBooking YardAssetInboundBookingChangeInput
outboundBooking YardAssetOutboundBookingChangeInput
inboundTimeRange YardAssetTimeRangeChangeInput
outboundTimeRange YardAssetTimeRangeChangeInput

YardAssetPositionChangeInput

Arguments

Name	Description
value YardAssetPositionInput

YardAssetPositionInput

Arguments

Name	Description
spaceId UUID!
areaId UUID!

YardAssetsFilterInput

Arguments

Name	Description
id Comparison	The externalId of the yard asset.
type EntityRefComparisonInput
location EntityRefComparisonInput
space EntityRefComparisonInput
status EntityRefComparisonInput
area EntityRefComparisonInput
modifiedTime Comparison
createdTime Comparison
activeTime Comparison

YardAssetsQueryInput

Arguments

Name	Description
filter YardAssetsFilterInput
start Int
count Int

YardAssetStatusChangeInput

Arguments

Name	Description
value UUID!

YardAssetStatusFlowInput

Input structure for creating or updating a yard asset status flow.

Arguments

Name	Description
beginStatusId UUID!	The ID of the acceptable starting yard asset status. A beginStatusId cannot appear more than once for a single booking status.
endStatusId UUID!	The ID of the yard asset status to progress to.

YardAssetStatusInput

Input used when creating or updating a yard asset status.

Arguments

Name	Description
name String!	The name of the status.
type YardAssetStatusType!	The type of this status.
colour Colour!	The display colour associated with this status.

YardAssetTasksChangeInput

Arguments

Name	Description
value [TaskInput!]!

YardAssetTimeAssignmentChangeInput

Arguments

Name	Description
value YardAssetTimeAssignmentInput

YardAssetTimeAssignmentInput

Arguments

Name	Description
beginTime Timestamp!
endTime Timestamp!

YardAssetTimeRangeChangeInput

Arguments

Name	Description
value TimeRangePartial

YardAssetTypeChangeInput

Arguments

Name	Description
value UUID!

YardAssetTypeInput

Input structure for creating or updating a yard asset type.

Arguments

Name	Description
key String!
name String!
defaultStandingTime Int!
ignoreInboundContentsDuration Boolean!
ignoreOutboundContentsDuration Boolean!
allowInboundAssetCreation Boolean!
allowOutboundAssetCreation Boolean!
allowInboundAnonymousAssetCreation Boolean!
allowOutboundAnonymousAssetCreation Boolean!
allowInboundAssetConnection Boolean!
allowOutboundAssetConnection Boolean!
inboundBookingDuration Int!
outboundBookingDuration Int!