Skip to main content

supplyDeliveryAppointments

Returns a shipment's current delivery appointments, one for each scheduling integration it has an appointment in.

Business Rules​

  • Includes appointments in integrations that are inactive or archived, so they can still be refreshed or cancelled. integrationActive is false for those
  • Returns the details Endless stored when each appointment was booked, linked, updated, or last refreshed. It does not call any integration; use supplyReconcileDeliveryAppointment to refresh them
  • timezone is the warehouse's time zone stored with the appointment, or null when it could not be read
  • state is BOOKING or UNKNOWN until the booking is confirmed. UNKNOWN means the integration did not confirm it; reconcile before booking again
  • A cancelled appointment is kept as history and is not returned
  • Returns an empty list when the shipment has no appointment
  • Reads the shipment in the active company (X-Company-Id) only

Error Scenarios​

  • **GraphQL::ExecutionError**: "Shipment not found."

Permissions Required​

  • supply:read_shipments
supplyDeliveryAppointments(
  shipmentId: ID!
): [DeliveryAppointment!]!

Arguments​

supplyDeliveryAppointments.shipmentId ● ID! non-null scalar common​

The shipment whose appointments are returned.

Type​

DeliveryAppointment object common​

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