Skip to main content

supplyDeliveryAppointmentOptions

Returns what can be booked for a shipment's delivery appointment: the warehouse, its load types, and, for a chosen load type, its open times and the fields it asks for. Read live from the scheduling integration.

Business Rules​

  • The shipment and the integration must belong to the active company (X-Company-Id), and the integration must support delivery appointments
  • The warehouse is the location the shipment's destination warehouse is linked to in that integration. Its fulfillment integration is not used
  • When the destination warehouse is not linked yet, warehouseMapped is false and every other field is empty, so the client can offer to map it
  • When the shipment's warehouse system reports its ASN is at a different warehouse than the shipment's destination, warehouseOrderMismatch explains it and every other field is empty
  • slots is returned when loadTypeId and date are given. date is a day in the warehouse's time zone
  • fields and blockingFields are returned when loadTypeId is given

Error Scenarios​

  • **GraphQL::ExecutionError**: "Shipment not found."
  • "Integration not found." or "This integration cannot schedule delivery appointments."
  • "The shipment has no destination warehouse."

Permissions Required​

  • supply:read_shipments
supplyDeliveryAppointmentOptions(
  date: ISO8601Date
  integrationId: ID!
  loadTypeId: ID
  shipmentId: ID!
): DeliveryAppointmentOptions!

Arguments​

supplyDeliveryAppointmentOptions.date ● ISO8601Date scalar common​

The day to list open times for, in the warehouse's time zone.

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

The scheduling integration to book with.

supplyDeliveryAppointmentOptions.loadTypeId ● ID scalar common​

The load type to list times and fields for.

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

The shipment to book an appointment for.

Type​

DeliveryAppointmentOptions object common​

What can be booked for a shipment at its warehouse, read live from the scheduling system.