Mutations

acceptConnectionRequest

Type: UUID!

Accept a connection request.

This creates a new connection without needing a connection code.

Groups can then be assigned with ordinary group assignment.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
connectionRequestId UUID!	The ID of the connection request

acceptMembershipInvite

Type: UUID!

Accept an organisation's invite to join their organisation.

This mutation doesn't require any permissions, but cannot be done by organisation tokens.

Arguments

Name	Description
membershipInviteId UUID!	The ID of the membership invite

acknowledgeDocument

Type: Void

Acknowledge a document as an organisation. An acknowledgement will be added for each role the organisation fills on the document.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the query.
documentOwnerOrganisationId UUID!	The ID of the organisation that owns the document.
documentId ID!	The ID of the document.
type DocumentAcknowledgementType	The type of acknowledgement being made.

addBookingComment

Type: Void

Add a new comment to a booking.

If the organisation specified is the carrier, you need the ParticipateCarrierBookings permission. If the organisation specified is the location, you need the ParticipateLocationBookings permission.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation adding the comment
bookingId ID!	The ID of the booking
comment CommentInput!	The comment to be added

addHistoricBookingStatusEvent

Type: Void

Add a retroactive status history event.

Arguments

Name	Description
organisationId UUID!
bookingId ID!
statusId UUID!
fields [FieldDataInput!]!
eventTime Timestamp

addVerificationComment

Type: Void

Add a comment to an existing verification request.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
comment CommentInput!	The comment to be added to the verification request

assignAreaSpace

Type: Boolean!

Assign a space to an area.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
spaceId UUID!	The ID of the space

assignBookingSpace

Type: Void

Assign or reassign the space on a booking. If the booking hasn't been scheduled, this will manually schedule the booking. If the booking has been scheduled, this will change the space and time scheduled.

This call does not respect rulesets. Any space and any time can be assigned to any booking, regardless of if that space and time would be automatically approved for the booking.

If the booking was in the Submitted status, it will change to approved. Otherwise, the space will be overridden, and the status will not change.

The space will be marked as manually assigned when you use this call.

The duration must be greater than or equal to 0, but does not otherwise respect limitations on booking length.

An area ID must be provided. However, the space does not actually have to be present at this area ID. This is an overriding call, so it is allowed to assign a space with an area unrelated to it.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
areaId UUID!	The ID of the area tobe booked to
spaceId UUID!	The ID of the space to be booked to
time Timestamp!	The time to be assigned to the booking
duration Int!	The duration of the booking

assignBookingSubcarrier

Type: Void

Arguments

Name	Description
organisationId UUID!	ID of the organisation making the request
bookingId ID!	ID of the booking
subcarrierId UUID	ID of the sub-carrier to assign. Setting this to null removes the sub-carrier.

assignRole

Type: Void

Assign a role to a member. The member will have all permissions given by the role.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
roleId UUID!	The ID of the role
memberId UUID!	The ID of the member to be assigned the role

cancelConnectionRequest

Type: Boolean!

Cancel a pending connection request.

Arguments

Name	Description
requestingOrganisationId UUID!	The ID of the organisation making the connection request
requestedOrganisationId UUID!	The ID of the organisation receiving the connection request

cancelMembershipInvite

Type: Void

Cancel a sent membership invite.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
membershipInviteId UUID!	The ID of the membership invite

cloneArea

Type: UUID!

Clone an area. The new area has all settings identical to the old one. Given names are unique, a new name must be provided.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area to be cloned
name String!	The name of the new area

connectBaseOrganisation

Type: UUID!

Base organisations can only be created by location organisations.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the query.
baseOrganisation BaseOrganisationInput!	The details of the base organisation.

consumeConnectionCode

Type: UUID!

Accept a given connection code.

This adds your organisation to the code's organisation's connections, and the code's organisation to your connection. This may also grant you certain groups, as specified by the connection code. If you already have a connection with the code's organisation, accepting another connection code adds you to any groups on the code.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
code String!	The connection code to be consumed. This is provided by another organisation

createAccessCodeBooking

Type: UUID!

Create an access-code booking.

Arguments

Name	Description
organisationId UUID!
input AccessCodeBookingInput!

createArea

Type: UUID!

Create an area.

Areas are logical groupings of spaces. Areas contain rules, that allow bookings to be automatically approved to an area and space.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
area AreaInput!	The input containing the new area details

createBooking

Type: ID!

Create a new booking.

You need the CreateCarrierBooking or CreateLocationBooking permission to create a booking. Which permission you need depends on what role your organisation is taking in the booking.

If your organisation is being set as the carrier, you need the CreateCarrierBooking. The location needs to have granted you the location necessary for the booking. If your organisation is being set as the location, you need the CreateLocationBooking. You need to have granted the carrier access to the location necessary for the booking.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
booking BookingInput	The input containing the details of the new booking
bookingEntityRef BookingEntityRefInput	The input containing reference details of the new booking

createBookingNotice

Type: Void

Create a new bookingnotice on an org

Arguments

Name	Description
organisationId UUID!
bookingNotice BookingNoticeInput!

createBookingOption

Type: UUID!

Create a new booking option.

Booking options represent properties on a booking.

A bookingOption type cannot have its name changed after creation.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingOption BookingOptionInput!	The input containing the new booking option details

createCapacityUnit

Type: UUID!

Create a capacity unit

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
capacityUnit CapacityUnitInput!	The capacity unit payload

createCapacityUnitLimit

Type: UUID!

Create a capacity unit limit

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
capacityUnitLimit CapacityUnitLimitInput!	The capacity unit limit payload

createConnectionCode

Type: ID!

Create a new connection code.

Connection codes can be consumed by other organisations to create a connection between them. Connection codes can have associated groups, that the consuming organisation is added to when the code is consumed.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
settings ConnectionCodeInput!	The input containing the settings of the new connection code

createContact

Type: UUID!

Create a new contact.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
contact ContactInput!	The input containing the new contact details

createDocument

Type: ID!

Create a new Document

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
document DocumentSubmissionInput	The input contaning the new document details
documentEntityRef DocumentEntityRefInput	The input reference contaning the new document details
upsert Boolean	Set it true if wanted to update or insert an exisiting or deleted document.

createDocumentStatus

Type: UUID!

Create a document status. Document status provides context about the current state of a given document.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
documentStatus DocumentStatusInput!	The input containing details of the status

createDocumentType

Type: UUID!

Create a document status. Document type provides information about the category of document.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
documentType DocumentTypeInput!	The input containing details of the document type

createField

Type: UUID!

Add a new field.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
field FieldInput!	The input containing the new field details

createGroup

Type: UUID!

Create a new group.

Groups can be used to organise connections, and can be assigned to areas to determine access.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
group GroupInput!	The input containing the new group settings

createLoad

Type: UUID!

Create a new load type.

A load represents something being moved in a booking, and affects the duration.

A load type cannot have its name changed after creation.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
load LoadInput!	The input containing the new load details

createManualBooking

Type: ID!

Create a new booking with manual settings.

You need the InstantBookingCreation permission at the location you're creating the booking at to create a booking with this call. OrganisationId must be equal to location ID on the booking, or the call will fail.

This call allows you to ignore ordinary limitations. Bookings are created at the given area/space, even if it's not a valid combination. Rules are ignored, and the booking is automatically approved.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
booking ManualBookingInput!	The input containing the details of the booking. Rules are ignored for this booking and it is auto-approved

createOrganisation

Type: UUID!

Create an organisation.

This mutation doesn't require any permissions, but cannot be done by organisation tokens.

Arguments

Name	Description
organisation OrganisationCreationInput!	The input used to create the organisation

createPass

Type: Pass

Pass CRUD

Arguments

Name	Description
organisationId UUID!
passInput PassInput!

createPassType

Type: PassType

PassType CRUD

Arguments

Name	Description
organisationId UUID!
passTypeInput PassTypeInput!

createRecurringBooking

Type: UUID!

Create a new recurring booking.

A recurring booking allows for a booking to be created at a specified interval, for as long as you desire.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
booking RecurringBookingInput!	The input containing the new recurring booking details
enabled Boolean!	Whether the recurring booking is initially enabled on creation. If disabled, bookings will not be automatically generated.

createRole

Type: UUID!

Create a new role.

Roles have permissions, and can be assigned to users. Users with roles can then take actions that require permissions.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
role RoleInput!	The input containing the new role details

createRule

Type: UUID!

Create a new rule.

Rules are used to determine if a booking is automatically approved, and to which area and space.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
rule RuleInput!	The input containing the details of the new rule
enabled Boolean	A flag indicating whether the rule is enabled. True indicates the rule is enabled. False indicates the rule is disabled

createSpace

Type: UUID!

Create a space.

A booking will be assigned to one space in the course of its lifetime.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
space SpaceInput!	The input containing the new space details

createStatus

Type: UUID!

Create a new status.

Statuses represent a state of the booking. They usually capture some data through fields.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
status StatusInput!	The input containing the new status details
exception Boolean!	A flag indicating whether the new status is an exception status or a flow status. True indicates an exception status. False indicates a flow status

createVehicle

Type: UUID!

Create a new vehicle type.

A vehicle determines the duration and size of space needed for a booking.

A vehicle type cannot have its name changed after creation.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
vehicle VehicleInput!	The input containing the new vehicle details

createYardAsset

Type: [UUID!]!

Create a yardAsset

Arguments

Name	Description
organisationId UUID!
input YardAssetInput!

createYardAssetStatus

Type: UUID!

Create a new yard asset status

Arguments

Name	Description
organisationId UUID!
input YardAssetStatusInput!

createYardAssetType

Type: UUID!

Create a yardAssetType

Arguments

Name	Description
organisationId UUID!
input YardAssetTypeInput!

deactivateConnectionCode

Type: Void

Deactivate a connection code manually.

A deactivated connection code will fail if used by any organisation.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
connectionCodeId UUID!	The ID of the connection code

deactivateOrganisation

Type: Void

Request the deactivation of an organisation. A deactivated organisation has all its contacts stripped, all their users removed, and is no longer accessible or joinable by anyone.

Deactivated organisations can only be reactivated by Mobiledock support.

Only the owner can deactivate an organisation.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation

declineMembershipInvite

Type: Void

Decline an organisation's invite to join their organisation.

This mutation doesn't require any permissions, but cannot be done by organisation tokens.

Arguments

Name	Description
membershipInviteId UUID!	The ID of the membership invite

delegateConnection

Type: Void

Base organisations can only be created by location organisations.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation making the query.
baseOrganisationId UUID!	The ID of the base organisation that is having its connection delegated.
targetOrganisationId UUID!	The ID of the organisation to delegate the connection to.

deleteAccessCodeBooking

Type: Void

Delete an access-code booking.

Arguments

Name	Description
organisationId UUID!
accessCodeBookingId UUID!

deleteArea

Type: Void

Delete an area.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area

deleteBookingNotice

Type: Void

Delete a bookingnotice on an org

Arguments

Name	Description
organisationId UUID!
bookingNoticeId UUID!

deleteBookingOption

Type: Void

Delete a booking option.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingOptionId UUID!	The ID of the booking option

deleteCapacityUnit

Type: Void

Delete an existing capacity unit

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
capacityUnitId UUID!	The ID of the capacity unit

deleteCapacityUnitLimit

Type: Void

Delete an existing capacity unit limit

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
capacityUnitLimitId UUID!	The ID of the capacity unit limit

deleteContact

Type: Void

Delete a contact.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
contactId UUID!	The ID of the contact

deleteDocument

Type: Void

Delete a document

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
documentId ID!	The ID of the document

deleteDocumentStatus

Type: Void

Delete a document status. Documents that have this status assigned will have their status removed.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
documentStatusId UUID!	The ID of the document status to be updated

deleteDocumentType

Type: Void

Delete a document type. Documents that have this type assigned will have their type removed.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
documentTypeId UUID!	The ID of the document status to be updated

deleteField

Type: Void

Delete a field.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
fieldId UUID!	The ID of the field

deleteGroup

Type: Void

Delete a group.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
groupId UUID!	The ID of the group

deleteLoad

Type: Void

Delete a load type.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
loadId UUID!	The ID of the load

deletePass

Type: Void

Arguments

Name	Description
organisationId UUID!
passTypeId UUID!
passId ID!

deletePassType

Type: Void

Arguments

Name	Description
organisationId UUID!
passTypeId UUID!

deleteRecurringBooking

Type: Void

Delete a recurring booking. This will not affect bookings already created.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
recurringBookingId UUID!	The ID of the recurring booking

deleteRole

Type: Void

Delete a role. You can't delete default roles.

This will unassign all members of the role, from this role. They will lose all permissions granted by the role.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
roleId UUID!	The ID of the role

deleteRule

Type: Void

Delete a rule.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area containing the rule
ruleId UUID!	The ID of the rule

deleteSpace

Type: Void

Delete a space.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
spaceId UUID!	The ID of the space

deleteStatus

Type: Void

Delete a status. Any bookings already in this status will not change. This only prevents you from setting it on bookings in the future.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
statusId UUID!	The ID of the status

deleteVehicle

Type: Void

Delete a vehicle type.

This will not allow you to change the vehicle type of bookings already assigned a vehicle type.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
vehicleId UUID!	The ID of the vehicle

deleteYardAsset

Type: Void

Delete a yardAsset

Arguments

Name	Description
organisationId UUID!
yardAssetId UUID!

deleteYardAssetStatus

Type: Void

Delete a yard asset status by ID.

Arguments

Name	Description
organisationId UUID!
yardAssetStatusId UUID!

deleteYardAssetType

Type: Void

Delete a yardAssetType

Arguments

Name	Description
organisationId UUID!
yardAssetTypeId UUID!

generateAccessCodeBooking

Type: Booking

Generate an access-code booking. Either accessCodeBookingId or code must be provided.

Arguments

Name	Description
organisationId UUID!
accessCodeBookingId UUID
code String

generateNextRecurringBooking

Type: Void

Force generate the next booking in the sequence for a recurring booking.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
recurringBookingId UUID!	The ID of the recurring booking

leaveOrganisation

Type: Boolean!

Leave an organisation.

You can't leave the organisation if you are the owner. This mutation doesn't require any permissions, but cannot be done by organisation tokens.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation

overrideBookingDriver

Type: Void

Change the driver on an existing booking. Members of a location may break the location driver restriction.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
driver DriverIdentifier	The new driver for the booking

overrideBookingStatus

Type: Void

Override the status on a booking.

With a few exceptions, an override can be used to move a booking from any status to any other status. An override can be used to move a booking from a status with a space, to a status without. However, an override cannot be used to move a booking from a status without a space, to a status with a space. A space must be assigned with the assignBookingSpace call first.

When overriding a status, all fields can be considered optional.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
statusId UUID	The ID of the status to be updated to. Can be any status, except status with a space when booking currently does not have a space
fields [FieldDataInput!]	An array of inputs containing new or updated field data
statusReference BookingStatusEntityRefInput	An status reference input containing new or updated field data

overrideBookingTasks

Type: Void

Adds new tasks and deletes existing tasks of a valid booking. The new booking tasks will avoid the booking engine and will be approved changes.

Arguments

Name	Description
organisationId UUID!
bookingId ID!
addTasks [TaskInput!]!
deleteTasks [ID!]!
headerLoads [LoadQuantityInput!]	An array of inputs containing the updated header loads for this booking
captureTaskActuals Boolean

overrideBookingVehicle

Type: Void

Override the vehicle of an existing booking

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
vehicleId UUID	The ID of the new vehicle for the booking
vehicle EntityRefInput	The new vehicle reference for the booking

patchYardAsset

Type: Void

Patch an existing yardAsset

Arguments

Name	Description
organisationId UUID!
yardAssetId UUID!
input YardAssetPatchInput!

progressYardAssetStatus

Type: Void

Progress the status of a yard asset to a status within the flow.

Arguments

Name	Description
organisationId UUID!
yardAssetId UUID!
yardAssetStatusId UUID!

reassignBookingCarrier

Type: ID!

Override the vehicle of an existing booking

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
carrierId UUID	The ID of the carrier for the booking to be assigned to
bookingId ID!	The ID of the booking
statusId UUID	The ID of the status to push the current booking to. Must be an exception status
excludedFieldIds [UUID!]	The list of field ids that should not be copied across to the new booking
reassignBookingCarrierEntityRef ReassignBookingCarrierEntityRefInput	Reassign carrier configuration input reference.

reassignBookingTasks

Type: Void

Reassinng tasks from an existing booking to another

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
taskIds [ID!]!	The IDs of the tasks to be reassigned
targetBookingId ID!	The ID of the booking to reassign the task to

removeConnection

Type: Void

Remove a connection. They will lose all groups and won't be able to book at this location any more.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
connectionId UUID!	The ID of the connection

removeConnectionRequest

Type: Void

Remove a connection request. If Block is true, you won't get connection requests from that organisation again.

A blocked connection will appear to be pending to the requester.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
connectionRequestId UUID!	The ID of the connection request
block Boolean	A flag indicating whether to block the requesting organisation. True means the requesting organisation will be unable to make another connection request. False means the requesting organisation will be able to make subsequent connection requests

removeMember

Type: Void

Remove a given member from the organisation. You cannot use this to remove yourself. You need to use the leave mutation on OrganisationOperations to leave.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
memberId UUID!	The ID of the member

reorderFields

Type: Void

Change the order of the fields

Arguments

Name	Description
organisationId UUID!
fields [UUID!]!

reorderRules

Type: Void

Change the order of the rules

Arguments

Name	Description
organisationId UUID!
areaId UUID!
rules [UUID!]!

reorderSpaces

Type: Void

Change the order of the spaces

Arguments

Name	Description
organisationId UUID!
spaces [UUID!]!

reorderVehicles

Type: Void

Change the order of the vehicles

Arguments

Name	Description
organisationId UUID!
vehicles [UUID!]!

requestConnection

Type: Boolean!

Request a connection from this organisation to the organisation specified.

Your email and name will be made visible to the organisation.

This mutation requires requesting connections to be enabled on the requested organisation.

Arguments

Name	Description
requestingOrganisationId UUID!	The ID of the organisation making the connection request
requestedOrganisationId UUID!	The ID of the organisation receiving the connection request
request ConnectionRequestInput!	The input containing the connection specifics

requestVerification

Type: Void

Initiate a verification request.

An organisation must be verified to appear in search, and location enabled to use location services in Mobiledock. An organisation can still participate in bookings as a carrier, sender, or receiver when not verified.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
verificationRequest VerificationRequestInput!	The input containing the verification request details

sendAnnouncement

Type: Void

Send an announcement to your connections.

Arguments

Name	Description
senderOrganisationId UUID!	The ID of the organisation sending the announcement
recipientOrganisationIds [UUID!]!	An array of IDs for organisations who are to receive the announcement
email EmailInput!	The input containg the details of the email announcment to be sent out

sendMembershipInvite

Type: [String!]!

Send membership invites to the specified emails. Returns a list of the emails successfully invited.

If a user does not have a Mobiledock account, they will be invited to join.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
emails [String!]!	An array of e-mails to send the membership invites to
roleIds [UUID!]!	An array of roles to assign to invitees

setAreaAccess

Type: Void

Associate (or unassociate) a group with an area. Groups associated with the area are able to book against the area. If a connection is in an associated group, they are able to book against the area, or send/receive from that area. To unassociate, pass false for canAccess.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
groupIds [UUID!]!	An array of group IDs to be given access
accessType AccessType!	An access type associated with area
canAccess Boolean!	A flag indicating whether the groups can access the areea. True indicates the groups can access the area. False indicates the groups cannot access the area

setAreaEnabled

Type: Void

Enable or disable an area. Bookings will not be made in the area while disabled. It cannot be selected as an area, and no bookings will be assigned to it.

This does not affect bookings already made to this area.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
enabled Boolean!	A flag indicating whether the area is enabled. True indicates the area is enabled. False indicates the area is disabled

setAreaIcon

Type: Void

Set the icon for an area. If IconInput is null, the icon is removed. Clears the logo if set

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
icon IconInput	The input containing the updated area icon

setAreaLogo

Type: Void

Set the icon for an area. If LogoInput is null, the logo is removed. Clears the Icon if set

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
logoUrl String	The input containing the logo url

setAreaYardEnabled

Type: Void

Enable or disable an area for yard operations. The yard feature must be enabled to set this to true.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
yardEnabled Boolean!	A flag indicating whether the area is treated as a yard.

setAutoSubscriptionProfile

Type: Void

Unsubscribe from a notifications from a specified booking.

Arguments

Name	Description
subscriptionProfile SubscriptionProfileInput!

setBookingActualLoad

Type: Void

Set the actual load of a booking.

A booking's actual load is tracked seperately from its calculated load. However, it does not affect the duration. Use assignBookingSpace to change a booking's duration.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
load [LoadQuantityInput!]	An arry of inputs containing the updated actual loads for this booking

setBookingFields

Type: Void

Update a booking with field overrides. Does not respect required/not required fields, and can only be done by the location.

If the organisation specified is the carrier, you need the ParticipateCarrierBookings permission. If the organisation specified is the location, you need the ParticipateLocationBookings permission. The specified location must also be the carrier.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
fields [FieldDataInput!]	An array of inputs containing field data details for the given booking
fieldReferences [FieldDataEntityRefInput!]	An array of inputs containing field data reference details for the given booking

setConnectionAttribute

Type: Void

Set an attribute on a connection.

If value is null, the attribute key will be removed.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
connectionId UUID!	The ID of the connection
key String!	The key / name for the connection attribute
value String	The value for the connection attribute

setConnectionContacts

Type: Void

Set a note on a connection

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
connectionId UUID!	The ID of the connection
contacts [ContactInput!]!	The contacts to set

setConnectionCoreDetails

Type: Void

Arguments

Name	Description
organisationId UUID!
connectionId UUID!
coreDetailsInput CoreDetailsInput!

setConnectionNote

Type: Void

Set a note on a connection.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
connectionId UUID!	The ID of the connection
note String	The note to be added to the connection

setDocumentStatus

Type: Void

Set a status to a specific document of an organisation.

Arguments

Name	Description
organisationId UUID!
documentId ID!
documentStatusId UUID

setGroupConnection

Type: Void

Add or remove a connection to a group.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
groupId UUID!	The ID of the group
connectionId UUID!	The ID of the connection to be added or removed
inGroup Boolean!	A flag indicating whether to add or remove the connection from the group. True indicates adding the connection to the group. False indicates removing the connection from the group

setLinkedBookingYardAssetStatuses

Type: Void

Define linked booking / yard asset statuses. When a booking hits the status specified, any linked yard asset status flows will be executed. Linked status flows can be defined for each

Arguments

Name	Description
organisationId UUID!
statusId UUID!
yardAssetLinkedStatusFlows BookingYardAssetLinkedStatusFlowsInput!

setLoadCapacityUnitValue

Type: Void

Assign a capacity unit value to a load.

Each load can only have one value assigned for each capacity unit.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation.
loadId UUID!	The ID of the load.
capacityUnitId UUID!	The ID of the capacity unit.
quantity Int	The number of capacity units that should be assigned to the load. A value of null will remove the capacity unit from the load.

setLocationInGroup

Type: Void

Add a group's owning location to a group.

A group's owning location cannot be added with setGroupConnection, as it does not have a connection ID. This call must be used instead to add the location to the group.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
groupId UUID!	The ID of the group
inGroup Boolean!	A flag indicating whether to add or remove the owning location from the group. True indicates adding the location to the group. False indicates removing the location from the group

setOrganisationFieldDataRemovalPolicy

Type: Void

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
input OrganisationFieldDataRemovalPolicyInput!

setReceiptingSettings

Type: Void

Arguments

Name	Description
organisationId UUID!
receiptingSettings ReceiptingSettingsInput!

setRecurringBookingEnabled

Type: Void

Enable or disable a recurring booking.

A disabled recurring booking will not create new bookings. This does not alter bookings already created. An enabled recurring booking will create any bookings from now/startDate (whichever is later) to the maximum time/endDate (whichever is earlier) immediately.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
recurringBookingId UUID!	The ID of the recurring booking
enabled Boolean!	A flag indicating whether the recurringbooking is enabled. True indicates the recurringbooking is enabled. False indicates the recurringbooking is disabled

setRuleEnabled

Type: Void

Activate or deactivate a rule.

A deactivated rule will not be considered when approving a booking.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area containing the rule
ruleId UUID!	The ID of the rule
enabled Boolean!	A flag indicating whether the rule is enabled. True indicates the rule is enabled. False indicates the rule is disabled

setStatusAutoTransition

Type: Void

Set the automatic tranistion details of a status. If null, auto status is disabled for this status.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
statusId UUID!	The ID of the status
autoTransition AutoTransitionInput	The input containing the auto transition details of this status. Can be set to null, for no auto transition

setSubsequentStatuses

Type: Void

Make a new set of statuses this status can lead to. This will replace the previous set.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
statusId UUID!	The ID of the status
subsequentStatusIds [UUID!]!	An array of status IDs that are to follow the status in the status flow

setVehicleCapacityUnitValue

Type: Void

Assign a capacity unit value to a vehicle.

Each vehicle can only have one value assigned for each capacity unit.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation.
vehicleId UUID!	The ID of the vehicle.
capacityUnitId UUID!	The ID of the capacity unit.
quantity Int	The number of capacity units that should be assigned to the vehicle. A value of null will remove the capacity unit from the vehicle.

setYardAssetTypeStatusFlows

Type: Void

Set the status flows for an asset type.

Arguments

Name	Description
organisationId UUID!
yardAssetTypeId UUID!
statusFlows [YardAssetStatusFlowInput!]!

subscribeBookingNotifications

Type: Void

Subscribe to a notifications from a specified booking.

Arguments

Name	Description
bookingId ID!

transferOrganisationOwnership

Type: Void

Transfer ownership of an organisation to another user.

The user must already be a member of the organisation.

This action can only be performed by the owner of the organisation.

Once the transfer is successful, the old owner will remain a member of the organisation, and will be granted the "Organisation Manager" role, if they were not already.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
userId UUID!	The ID of the user to transfer ownership to

unassignAreaSpace

Type: Boolean!

Unassign a space from an area.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
spaceId UUID!	The ID of the space

unassignRole

Type: Void

Remove a member from a role. Returns true if they've been removed, or false if they weren't already a member.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
roleId UUID!	The ID of the role
memberId UUID!	The ID of the member to be unassigned the role

unsubscribeBookingNotifications

Type: Void

Unsubscribe from a notifications from a specified booking.

Arguments

Name	Description
bookingId ID!

updateAccessCodeBooking

Type: Void

Update an access-code booking.

Arguments

Name	Description
organisationId UUID!
accessCodeBookingId UUID!
input AccessCodeBookingInput!

updateArea

Type: Void

Update an area.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
area AreaInput!	The input containing the updated area details

updateBookingDriver

Type: Void

Change the driver on an existing booking A driver can be added or removed if the location configuration allows it.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
driver DriverIdentifier	The new driver for the booking

updateBookingNotice

Type: Void

Update a bookingnotice on an org

Arguments

Name	Description
organisationId UUID!
bookingNoticeId UUID!
bookingNotice BookingNoticeInput!

updateBookingOption

Type: Void

Update a booking option.

You cannot update the name of a bookingOption.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingOptionId UUID!	The ID of the booking option
bookingOption BookingOptionInput	The input contatining the updated booking option details

updateBookingRequestedTime

Type: Void

Update the requested area and time in a booking. This will resubmit the booking for auto-approval.

An Area ID must be provided if pickAreaOnCreateBooking is true. An Area ID must be null if pickAreaOnCreateBooking is false.

You cannot change the requested time if the booking has progressed past the Approved status. You may only update the requested time if you are the carrier.

If the organisation specified is the carrier, you need the ParticipateCarrierBookings permission. If the organisation specified is the location, you need the ParticipateLocationBookings permission. The specified location must also be the carrier.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
time Timestamp!	The new requested time
areaId UUID	The ID of the updated area to be booked to

updateBookingStatus

Type: Void

Update a booking to a following status.

This call is used to progress bookings through a normal flow. The status must be specified as one of the statuses following for the current status, or an exception status. If organisationId is the carrier, the status must be a carrier available status. All required fields must be provided, or must have been provided in earlier calls.

If the organisation specified is the carrier, you need the ParticipateCarrierBookings permission. If the organisation specified is the location, you need the ParticipateLocationBookings permission.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
statusId UUID	The ID of the status to update to. Must be a subsequent status to the current status or an exception status
fields [FieldDataInput!]	An array of inputs containing new or updated field data
statusReference BookingStatusEntityRefInput	A status reference input containing new or updated field data

updateBookingTasks

Type: Void

Adds new tasks and deletes existing tasks of a valid booking. The new booking tasks will be passed through the booking engine in order to evaluate their viability based on the time requested and location conditions.

Arguments

Name	Description
organisationId UUID!
bookingId ID!
addTasks [TaskInput!]!
deleteTasks [ID!]!
time Timestamp!
areaId UUID
headerLoads [LoadQuantityInput!]	An array of inputs containing the updated header loads for this booking

updateBookingVehicle

Type: Void

Update a booking's vehicle

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
bookingId ID!	The ID of the booking
vehicleId UUID	The ID of the new vehicle for the booking
time Timestamp!	The new requested time
areaId UUID	The ID of the area to be booked to
vehicleReference UpdateBookingVehicleEntityRefInput	The new vehicle reference for the booking

updateCapacityUnit

Type: Void

Update an existing capacity unit

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
capacityUnitId UUID!	The ID of the capacity unit
capacityUnit CapacityUnitInput!	The capacity unit payload

updateCapacityUnitLimit

Type: Void

Update an existing capacity unit limit

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
capacityUnitLimitId UUID!	The ID of the capacity unit limit
capacityUnitLimit CapacityUnitLimitInput!	The capacity unit limit payload

updateConnectionCode

Type: ID!

Update an existing connection code.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
connectionCodeId UUID!	The ID of the existing connection code
settings ConnectionCodeInput!	The input containing the updated settings of the connection code

updateContact

Type: Void

Update a contact.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
contactId UUID!	The ID of the contact
contact ContactInput!	The input containing the updated contact details

updateDocument

Type: Void

Update a document

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
documentId ID!	The ID of the document
document DocumentSubmissionInput	The input containing the updated document details
documentEntityRef DocumentEntityRefInput	The input reference contaning the updated document details
upsert Boolean	Set it true if wanted to update or insert an exisiting or deleted document.

updateDocumentStatus

Type: UUID!

Update the details of a document status. Document status provides context about the current state of a given document.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
documentStatusId UUID!	The ID of the document status to be updated
documentStatus DocumentStatusInput!	The input containing details of the status

updateDocumentType

Type: UUID!

Update the details of a document type. Document type provides information about the category of document.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
documentTypeId UUID!	The ID of the document type to be updated
documentType DocumentTypeInput!	The input containing details of the document type

updateField

Type: Void

Update a field.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
fieldId UUID!	The ID of the field
field FieldInput!	The input conaining the updated field details

updateGroup

Type: Void

Update a group.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
groupId UUID!	The ID of the group
group GroupInput!	The input containing the updated group details

updateLoad

Type: Void

Update a load type.

You cannot update the name of a load type.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
loadId UUID!	The ID of the load
load LoadInput	The input containing the updated load details

updateLocationConfig

Type: Void

Update an organisation's location settings. This allows setting instructions, the booking interval, and whether you have to pick the area on the creation of the booking.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
config OrganisationLocationInput!	The input containing the updated location details

updateNotificationSettings

Type: Void

Update the user's notification settings for a certain type and delivery type. Depending on enabled, you will or won't recieve notifcations for the given event, through the given delivery type.

This mutation doesn't require any permissions, but cannot be done by organisation tokens.

Arguments

Name	Description
notificationType NotificationType!	The notification type
delivery NotificationDeliveryType!	The delivery method of the notification
enabled Boolean!	Whether the notification should be enabled

updateOrganisation

Type: Void

Update an organisation's basic information, including description, address and timezone.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
organisation OrganisationUpdateInput!	The input containing the updated organisation properties

updateOrganisationSettings

Type: Void

Update an organisation's settings, including whether it appears in searches and if connection requests can be made.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
settings OrganisationSettingsInput!	The input containing the updated organisation settings

updateOrganisationTokenValidityLimit

Type: Void

Update a organisation's token validity limit, how long its members' tokens can remain valid.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
days OrganisationTokenValidityLimitInput!	The input containing the updated organisation token validity limit

updatePass

Type: Pass

Arguments

Name	Description
organisationId UUID!
passId ID!
passInput PassInput!

updatePassType

Type: PassType

Arguments

Name	Description
organisationId UUID!
passTypeId UUID!
passTypeInput PassTypeInput!

updateRecurringBooking

Type: Void

Update a recurring booking. This will not affect bookings already created.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
recurringBookingId UUID!	The ID of the recurring booking
booking RecurringBookingInput!	The input containing the updated recurring booking details

updateRole

Type: Void

Update a role.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
roleId UUID!	The ID of the role
role RoleInput!	The input containing the updated role details

updateRule

Type: Void

Update a rule.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
areaId UUID!	The ID of the area
ruleId UUID!	The ID of the rule
rule RuleInput!	The input containing the updated rule details

updateSpace

Type: Void

Update a space.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
spaceId UUID!	The ID of the space
space SpaceInput!	The input containing the updated space details

updateStatus

Type: Void

Update a status' name, descrption and whether carriers can set it.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
statusId UUID!	The ID of the status
status StatusInput!	The input containing the updated status input

updateVehicle

Type: Void

Update a vehicle type.

You cannot update the name of a vehicle.

Arguments

Name	Description
organisationId UUID!	The ID of the organisation
vehicleId UUID!	The ID of the vehicle
vehicle VehicleInput	The input containing the updated vehicle details

updateYardAssetStatus

Type: Void

Update an existing yard asset status.

Arguments

Name	Description
organisationId UUID!
yardAssetStatusId UUID!
input YardAssetStatusInput!

updateYardAssetType

Type: UUID

Update a yardAssetType

Arguments

Name	Description
organisationId UUID!
yardAssetTypeId UUID!
input YardAssetTypeInput!