Skip to main content

supplyCancelDeliveryAppointment

Cancels a shipment's delivery appointment in its scheduling integration and unlinks it.

Business Rules​

  • appointmentId must still be the shipment's appointment; one replaced since then is left alone
  • The appointment is unlinked only after the integration confirms the cancellation. It is kept as history, and the shipment can be booked again
  • When the integration does not confirm, the appointment stays linked
  • 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.

Permissions Required​

  • supply:schedule_delivery_appointment
supplyCancelDeliveryAppointment(
  input: SupplyCancelDeliveryAppointmentInput!
): AsynchronousActionResponse!

Arguments​

supplyCancelDeliveryAppointment.input ● SupplyCancelDeliveryAppointmentInput! non-null input common​

Parameters for SupplyCancelDeliveryAppointment

Type​

AsynchronousActionResponse object common​

Asynchronous action response type