Skip to main content

warehouseTransfersBookDeliveryAppointment

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

Business Rules​

  • The integration must belong to the company and support delivery appointments
  • The transfer’s destination building must be linked to a location in that integration. Its fulfillment integration is not changed
  • The reference number is referenceNumber, or the transfer’s warehouse order id when it is not sent. A transfer 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
  • A transfer holds one appointment per integration. Booking is refused while one exists, and while an earlier booking is unconfirmed
  • Booking is refused for a canceled transfer, including a booking queued before the cancel
  • When the integration does not confirm the booking, it is not sent again. Check the integration, then call warehouseTransfersReconcileDeliveryAppointment
  • 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 transfer already has appointment 123. Update or cancel it instead.”

Permissions Required​

  • warehouse:schedule_transfer_delivery_appointment
warehouseTransfersBookDeliveryAppointment(
  input: WarehouseTransfersBookDeliveryAppointmentInput!
): AsynchronousActionResponse!

Arguments​

warehouseTransfersBookDeliveryAppointment.input ● WarehouseTransfersBookDeliveryAppointmentInput! non-null input common​

Parameters for WarehouseTransfersBookDeliveryAppointment

Type​

AsynchronousActionResponse object common​

Asynchronous action response type