Skip to main content

supplyUpdateDeliveryAppointment

Changes a shipment's delivery appointment in its scheduling integration.

Business Rules​

  • Only the arguments sent are changed
  • appointmentId must still be the shipment's appointment; one replaced since then is left alone
  • A new time needs the dockId of the chosen slot
  • ccEmails replaces the whole list. More than 10, or one that is not a valid email address, refuses the change
  • 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's appointment is now 456. Reload and try again."

Permissions Required​

  • supply:schedule_delivery_appointment
supplyUpdateDeliveryAppointment(
  input: SupplyUpdateDeliveryAppointmentInput!
): AsynchronousActionResponse!

Arguments​

supplyUpdateDeliveryAppointment.input ● SupplyUpdateDeliveryAppointmentInput! non-null input common​

Parameters for SupplyUpdateDeliveryAppointment

Type​

AsynchronousActionResponse object common​

Asynchronous action response type