Skip to main content

Stop

No description

type Stop {
_id: ObjectId!
status: EnumStopStatus!
operationType: EnumOperationType
location: Location!
events: Events!
date: FromToDate!
comment: String
statusUpdateComment: String
time: FromToTime!
additionalTimeWindows: [FromToTime!]
waitingTimeMinutes: Float
token: String
sharedByUser: ContactInfo
plannedArrivalTime: DateTime
plannedDepartureTime: DateTime
isTrackingEmailSent: Boolean
isArrivingSoonEmailSent: Boolean
referenceStops: [ObjectId!]
timezone: TimeZone
address: Address
orderReference: String!
profiles: Profiles!
loadingUnits: [OrderLoadingUnits!]!
etaToStop: DateTime
}

Fields

Stop._id ● ObjectId! non-null scalar

Stop.status ● EnumStopStatus! non-null enum

Stop.operationType ● EnumOperationType enum

Stop.location ● Location! non-null object

Stop.events ● Events! non-null object

Stop.date ● FromToDate! non-null object

Stop.comment ● String scalar

Contains any notes from the dispatcher

Stop.statusUpdateComment ● String scalar

Contains any notes associated with the stop status update

Stop.time ● FromToTime! non-null object

Stop.additionalTimeWindows ● [FromToTime!] list object

A stop can have multiple time windows. In that case, the first window is stored in the "time" field, and additional windows are stored in this field.

Stop.waitingTimeMinutes ● Float scalar

Waiting time at the stop (in minutes).

Stop.token ● String scalar

Can be used for tracking to give access to the stop without needing to log in.

Stop.sharedByUser ● ContactInfo object

The user that shared the stop.

Stop.plannedArrivalTime ● DateTime scalar

The planned arrival date and time when time management is enabled. Can be used to give an estimate of delivery time to customers. The date does not contain any timezone info and is considered to be in the timezone of order departure.

Stop.plannedDepartureTime ● DateTime scalar

The planned departure date and time when time management is enabled. Can be used to give an estimate of delivery time to customers. The date does not contain any timezone info and is considered to be in the timezone of order departure.

Stop.isTrackingEmailSent ● Boolean scalar

Specifies whether stop tracking email was sent to stop contact or not.

Stop.isArrivingSoonEmailSent ● Boolean scalar

Specify whether arriving soon email notification sent to stop contact or not.

Stop.referenceStops ● [ObjectId!] list scalar

Used for fused orders, to reference the stops from the orignial order, and used to define a merged stop

Stop.timezone ● TimeZone scalar

Stop.address ● Address object

Stop.orderReference ● String! non-null scalar

Stop.profiles ● Profiles! non-null object

Stop.loadingUnits ● [OrderLoadingUnits!]! non-null object

Stop.etaToStop ● DateTime scalar