Skip to main content

DeliveryAppointment

A shipment's current delivery appointment in a scheduling integration.

type DeliveryAppointment {
appointmentId: ID
carrierName: String
ccEmails: [String!]!
confirmationNumber: String
dockId: ID
endAt: ISO8601DateTime
fieldValues: [DeliveryAppointmentFieldValue!]!
integrationActive: Boolean!
integrationId: ID!
integrationName: String!
integrationType: IntegrationTypeEnum!
loadTypeId: ID
notes: String
palletCount: Int
referenceNumber: String
startAt: ISO8601DateTime
state: DeliveryAppointmentStateEnum!
status: DeliveryAppointmentStatusEnum
timezone: String
url: String
}

Fields​

DeliveryAppointment.appointmentId ● ID scalar common​

The appointment's id in the scheduling system. Null until the booking is confirmed.

DeliveryAppointment.carrierName ● String scalar common​

The trucking company the operator entered, or TBD.

DeliveryAppointment.ccEmails ● [String!]! non-null scalar common​

The other email addresses the scheduling system notifies about the appointment.

DeliveryAppointment.confirmationNumber ● String scalar common​

The warehouse's confirmation number.

DeliveryAppointment.dockId ● ID scalar common​

The dock of the slot the operator booked.

DeliveryAppointment.endAt ● ISO8601DateTime scalar common​

When the appointment ends.

DeliveryAppointment.fieldValues ● [DeliveryAppointmentFieldValue!]! non-null object common​

The values the operator entered for the warehouse's other appointment fields.

DeliveryAppointment.integrationActive ● Boolean! non-null scalar common​

False when the scheduling integration is inactive or archived.

DeliveryAppointment.integrationId ● ID! non-null scalar common​

The scheduling integration the appointment is in.

DeliveryAppointment.integrationName ● String! non-null scalar common​

The scheduling integration's display name.

DeliveryAppointment.integrationType ● IntegrationTypeEnum! non-null enum integrations​

The scheduling integration's type.

DeliveryAppointment.loadTypeId ● ID scalar common​

The load type the operator booked.

DeliveryAppointment.notes ● String scalar common​

The notes the operator entered.

DeliveryAppointment.palletCount ● Int scalar common​

The number of pallets the operator entered.

DeliveryAppointment.referenceNumber ● String scalar common​

The reference number the booking carries.

DeliveryAppointment.startAt ● ISO8601DateTime scalar common​

When the appointment starts.

DeliveryAppointment.state ● DeliveryAppointmentStateEnum! non-null enum common​

Where the appointment stands in Endless.

DeliveryAppointment.status ● DeliveryAppointmentStatusEnum enum common​

The appointment's status.

DeliveryAppointment.timezone ● String scalar common​

The warehouse's IANA time zone.

DeliveryAppointment.url ● String scalar common​

A link to the appointment in the scheduling system.

Returned By​

supplyDeliveryAppointments query