FacilityAppointment
An appointment at a Facility.
Date-times are ISO 8601 strings in the facility's time zone, for example 2025-05-11T11:00:00-07:00.
- allType:
_load _types requiredProperties: 2The load types on the appointment and its orders.
- carrierType: array of string
_emails required - createdType: stringFormat: date-time
_at read-onlyrequiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- facilityType: stringFormat: uuidrequired
The id of the
Facilitythe appointment is at. - idType: stringFormat: uuidrequired
- isType: boolean
_work _in requiredWhether the appointment is a work-in, added for a truck that arrived without a booked appointment.
- orderType: array of object
_info requiredProperties: 4The orders on the appointment. See Orders, Loads & Shipments.
- recurringType: object | null
_facility _appointment requiredProperties: 2The recurring series the appointment belongs to, or
nullif it isn't recurring. - scheduledType: stringFormat: date-time
_end _time requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- scheduledType: stringFormat: date-time
_start _time requiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- statusType: stringenumread-onlyrequired
Where the appointment is in its lifecycle. Conduit works it out each time the appointment is returned, so
LateandNo Showcan change without the appointment being updated.Status Description Requested The carrier requested the appointment and the facility hasn't confirmed it yet. Also used for a work-in the driver created on site that the facility hasn't confirmed. Facility Rescheduled The facility proposed a new time for a requested appointment and is waiting for the carrier to accept it. Scheduled Confirmed and not checked in yet. Late Confirmed, not checked in, and past the scheduled start time by more than the facility's late threshold (30 minutes by default). No Show Confirmed, not checked in, and past the scheduled start time by the facility's no-show threshold (60 minutes by default). Checked In The truck has checked in at the facility. Unloading Unloading has started. Inbound appointments only. Loading Loading has started. Outbound appointments only. Unloaded Unloading has finished. Inbound appointments only. Loaded Loading has finished. Outbound appointments only. Checked Out The truck has checked out of the facility. Request Declined The facility declined the appointment request. Cancelled The facility cancelled the appointment, including through Cancel FacilityAppointment. Carrier Cancelled The carrier cancelled the appointment. Auto Cancelled Conduit cancelled the appointment because it was a no-show past the facility's auto-cancel cutoff. Load Rejected The facility rejected the load. Rebooked The facility moved the appointment to a different facility. The new appointment has its own id. Deleted The facility deleted the appointment. The cancelled statuses (
Request DeclinedthroughDeleted) take priority over every other status, so an appointment that was checked in and then had its load rejected showsLoad Rejected.cancelled_reasonholds the same information as a code.values- Requested
- Facility
Rescheduled - Scheduled
- Late
- No
Show - Checked
In - Loading
- Unloading
- typeType: "Inbound" or "Outbound"enumrequired
Either
Inboundfor deliveries orOutboundfor pickups. - updatedType: stringFormat: date-time
_at read-onlyrequiredthe date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- cancelledType: string | nullFormat: date-time
_at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- cancelledType: string | null
_note - cancelledType: string | nullenum
_reason Why the appointment was cancelled, or
nullif it wasn't.Reason Status FACILITY_DENIED_REQUESTRequest Declined FACILITY_CANCELLED_APPOINTMENTCancelled CARRIER_CANCELLED_APPOINTMENTCarrier Cancelled AUTO_CANCELAuto Cancelled FACILITY_REJECTED_LOADLoad Rejected FACILITY_REBOOKED_APPOINTMENTRebooked DELETEDDeleted values- F
A C I L I T Y _ D E N I E D _ R E Q U E S T - F
A C I L I T Y _ C A N C E L L E D _ A P P O I N T M E N T - C
A R R I E R _ C A N C E L L E D _ A P P O I N T M E N T - A
U T O _ C A N C E L - F
A C I L I T Y _ R E J E C T E D _ L O A D - F
A C I L I T Y _ R E B O O K E D _ A P P O I N T M E N T - D
E L E T E D
- F
- carrierType: string | null
- carrierType: string | null
_driver The driver's name.
- carrierType: string | null
_email deprecatedcarrier_emailsjoined with commas, ornullif there are none. Usecarrier_emailsinstead. - carrierType: string | null
_notes Notes from the carrier.
- carrierType: string | null
_phone - carrierType: string | null
_scac - checkedType: string | nullFormat: date-time
_in _at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- checkedType: string | nullFormat: date-time
_out _at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- confirmationType: string | null
_code Six-letter code the carrier and driver can use to look up the appointment.
- customerType: string | null
The customer the appointment is for, commonly used by 3PLs.
- dockType: string | null
The name of the dock door the appointment is assigned to.
- estimatedType: string | nullFormat: date-time
_start _datetime The carrier's ETA.
- forkliftType: string | null
The forklift driver assigned to the appointment.
- loadType: string | nullFormat: date-time
_finished _at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- loadType: string | nullFormat: date-time
_started _at the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z
- loadingType: "Live" or "Drop"enum
_type Whether the driver waits while the trailer is loaded or unloaded (
Live) or leaves the trailer (Drop). - notesType: string | null
Notes from facility staff that only facility staff can see.
- publicType: string | null
_notes Notes from facility staff that carriers can see.
- quantityType: integer | null
The amount of cargo, counted in
units. - sealType: string | null
_number - shipperType: string | null
_receiver The shipper for inbound appointments, or the receiver for outbound appointments.
- tractorType: string | null
_number - trailerType: string | null
_number - unitsType: string | null
The packaging type of
quantity, as configured by theFacility(e.g.Pallets,Boxes).
