This Method is a Premium API and allows you to book a Pick-Up for all supported Carriers with the same API call.
💡 With this Method you can:
Optimize your operations and fulfillment process booking the pick up at the time that best suits you.
Speed-up Carrier pick-ups.
Before you start
Please note that you must have at least a working Carrier connection to make any shipment. 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 BookPickup from our carrier comparison map.
How it works
This Method allows you to book a Carrier pick-up for the specified address.
You can also specify order numbers, parcels details, pick-up time windows and add a note for the Carrier.
The Method will reply with a status, message and a confirmation Carrier ID.
If you need to retrieve or cancel an existing pick-up, please check our GetPickups and CancelPickup API method.
📌When booking a pickup for UPS keep in mind that this carrier considers the time in GMT, so indicate the time accordingly in the "PickupTime" parameter.
BookPickUp API reference
Visit our API Documentation to view an example of Book Pickup API request and response.
Talk to our Experts to learn more about our APIs and take your business to the next level! 🚀