Skip to main content

supplyBookDeliveryAppointment

Books a delivery appointment for a shipment in a scheduling integration and links it to the shipment.

Business Rules​

  • The integration must belong to the company and support delivery appointments
  • The shipment's destination warehouse must be linked to a location in that integration. Its fulfillment integration and ASN reference are not changed
  • The reference number is referenceNumber, or the shipment's ASN reference when it is not sent. A shipment without either can still be booked
  • ccEmails are trimmed, lowercased, and de-duplicated. More than 10, or one that is not a valid email address, refuses the booking
  • When the shipment's warehouse system reports its ASN is at a different warehouse than the shipment's destination, booking is refused
  • A shipment holds one appointment per integration. Booking is refused while one exists, and while an earlier booking is unconfirmed
  • When the integration does not confirm the booking, it is not sent again. Check the integration, then call supplyReconcileDeliveryAppointment
  • Runs in the background; follow the returned process for the outcome

Error Scenarios​

The process fails with the reason, for example the integration's refusal or "This shipment already has appointment 123. Update or cancel it instead."

Permissions Required​

  • supply:schedule_delivery_appointment
supplyBookDeliveryAppointment(
  input: SupplyBookDeliveryAppointmentInput!
): AsynchronousActionResponse!

Arguments​

supplyBookDeliveryAppointment.input ● SupplyBookDeliveryAppointmentInput! non-null input common​

Parameters for SupplyBookDeliveryAppointment

Type​

AsynchronousActionResponse object common​

Asynchronous action response type