All Collections
API
Pickup Booking API
How Cancel Pickup API works
How Cancel Pickup API works

Discover how to cancel a scheduled pickup for all your Carriers with one API call

Updated over a week ago

This Method is a Premium API that allows you to cancel a scheduled pickup for all supported Carriers with the same API call.

💡 With this Method you can:

  • Optimize your operations and fulfillment process deleting a scheduled pick-up

  • Speed-up Carrier pick-ups

Summary

Before you start

Please note that you must have at least a working Carrier connection to make any calls. For help or any information on how to connect a Carrier, please check our help article here. After you have connected at least one Carrier, you will be able to get CarrierID, CarrierName, and CarrierService at the bottom of the API Keys ShippyPro page.

Please check if your Carriers currently support pickup from our carrier comparison map.

How it works

This Method allows you to cancel a previously scheduled Carrier pick-up.

You should specify some parameters, like Carrier Name, Carrier ID, Pick-up confirmation ID and Pick-up time.

The Method will reply with a status and a message to confirm the pick-up cancellation.

If you need to retrieve an existing pick-up, please check our GetPickups.

If you need to book a new pick-up please check our BookPickup API Method.

CancelPickUp API reference

Visit our API Documentation to view an example of Cancel Pickup API request and response.

Talk to our Experts to learn more about our APIs and take your business to the next level!

:muscolo:

Did this answer your question?