API

API > Pickup API

Book, retrieve or cancel your pickups from any location

With Pickup API, you can schedule, view and cancel your carriers' pickups without contacting Carriers directly. All it takes is one single API call for all your Carriers!

Start your free 30 orders trial today
No credit card required.

120+

available carriers'
integrations

One

single API for all
your Carriers

Uptime

guaranteed

What can you do
with Pickup API

Our APIs are built to empower your existing ecosystem. That's why they can be used to speed up different shipping workflows.

Book your carriers' pickups

With Pickup APIs, you can schedule your pickups with one simple API call for all the supported Carriers. Specify parcels' dimensions, leave notes for your Carriers and set your pickup date and time.

Book your carriers' pickups

Get your scheduled pickups

View the scheduled pickups for a specific order by entering the order ID. Retrieve the scheduled pickup time, the pickup address and the confirmation ID.

Get your scheduled pickups

Cancel your pickups anytime

Need to cancel or re-schedule a pickup? With Cancel Pickup API, you can cancel specific pickups anytime by entering the carrier name and the order ID.

Cancel your pickups anytime

Explore Pickup API

Take a look at Pickup API request and response and visit our API Documentation to get started. Our APIs are written in 14 programming languages and in 2 different technologies, REST and SOAP.

Text successfully copied!
REST
SOAP

Request

{
	"Method": "BookPickup",
	"Params": {
		"to_address": {
			"country": "US"
		},
		"from_address": {
			"name": "John Doe",
			"company": "",
			"street1": "123 Main St",
			"street2": "",
			"city": "Park City",
			"state": "UT",
			"zip": "84060",
			"country": "US",
			"phone": "5551231234",
			"email": "johndoe@gmail.com"
		},
		"parcels": [
			{
				"length": 5,
				"width": 5,
				"height": 5,
				"weight": 10
			}
		],
		"CarrierName": "DHLExpress",
		"CarrierID": 20,
		"PickupTime": 1517564402,
		"PickupNote": "Urgent",
		"PickupMorningMintime": "09:00",
		"PickupMorningMaxtime": "12:00",
		"PickupAfternoonMintime": "14:00",
		"PickupAfternoonMaxtime": "18:00"
	}
}

Response

{
	"Result": "OK",
	"Message": "Booked",
	"ConfirmationID": "1598"
}
<?xml version="1.0" encoding="UTF-8"?>
<root>
	<Method>BookPickup</Method>
	<Params>
		<CarrierID>20</CarrierID>
		<CarrierName>DHLExpress</CarrierName>
		<PickupAfternoonMaxtime>18:00</PickupAfternoonMaxtime>
		<PickupAfternoonMintime>14:00</PickupAfternoonMintime>
		<PickupMorningMaxtime>12:00</PickupMorningMaxtime>
		<PickupMorningMintime>09:00</PickupMorningMintime>
		<PickupNote>Urgent</PickupNote>
		<PickupTime>1517564402</PickupTime>
		<from_address>
			<city>Park City</city>
			<company />
			<country>US</country>
			<email>johndoe@gmail.com</email>
			<name>John Doe</name>
			<phone>5551231234</phone>
			<state>UT</state>
			<street1>123 Main St</street1>
			<street2 />
			<zip>84060</zip>
		</from_address>
		<parcels>
			<element>
				<height>5</height>
				<length>5</length>
				<weight>10</weight>
				<width>5</width>
			</element>
		</parcels>
		<to_address>
			<country>US</country>
		</to_address>
	</Params>
</root>

Response

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<ConfirmationID>1598</ConfirmationID>
	<Message>Booked</Message>
	<Result>OK</Result>
</root>
Read our API documentation

How to start integrating
Pickup API

Read our API
Documentation

Read our API Documentation to get more details on how Pickup API works.

Join ShippyPro for free

Create a free account on ShippyPro to get started with your API implementation.

Connect at least one
Carrier with a few clicks

Connect at least one of your Carriers to start testing our APIs. Learn how to do it in a few steps here.

Get your API key

Start your free trial of the Fast Growing Plan to get access to your API key.

Test all our APIs inside
our API Console

Try getting shipping rates, create shipping labels, schedule pickups and many more tasks directly from our API Console.

Integrate our APIs
inside your system

Now you're ready to integrate with our APIs! Check out our Help Center articles to learn how to make the most out of ShippyPro APIs.

Are you an Enterprise looking for a solution to empower your shipping process?

TALK TO OUR EXPERTS

Powerful APIs, powerful tools
to manage them

Get the best out of your API integration! Test your APIs with real Carriers before integrating them, view all your API Logs and avoid some errors with our advanced tools.

API Logs

•
View all your API Logs and get useful insights for each API call.
•
Check the real request and response of all your APIs.

API Logs

API Errors

•
Get help if something goes wrong in real–time and automatically.
•
Learn how you can improve the management of your APIs at a glance.

API Errors

API Console

•
Connect your Carriers and test all ShippyPro APIs in real–time and get instant response.
•
This way you know exactly how each API works before integrating it.

API Console

Webhook Logs

•
Insert your endpoint and get notified upon changes of delivery state.
•
Get access to some useful insights of tracking updates we send you in real–time.

Webhook Logs

Don't need to use our
APIs if you don't want to

Looking for a simpler solution to optimize your shipping process? Use ShippyPro platform instead of integrating our APIs. And why not both? Our platform is always updated with interesting insights.

START YOUR FREE TRIAL

Help when you need it

Get started quickly integrating our APIs with our API Documentation, dedicated Help Center articles and our Integration Managers ready to help you at every stage.

Comprehensive docs

Read our API Documentation to get more details about our APIs and how to manage them.

Read our API Documentation >

Dedicated Help

Browse through our dedicated Help Center articles to learn how to make the best out of ShippyPro APIs.

Visit our Help Center >

Dedicated Dev Team

Our Dev Team is happy to answer to your questions. We'll be in touch as soon as we can!

Contact Us >

Doubts regarding the
integration of ShippyPro API?

What Carriers and Sales Channels can I integrate with your APIs?

What programming languages do your APIs support?

Where can I test your APIs?

Working with the most
innovative businesses

Built by developers for developers

Built for
developers

Easy documentation, Help Center articles and API reference in 14 different programming languages (Python, PHP, NodeJs etc…).

Fully tested
and testable

All our API integrations are tested with millions of shipments. You can also test them yourself with our API Console.

We're here to help
in five languages

Talk directly to our multilingual Team and get answers on your API integration instantly. Our Team is happy to help!

What our customers love about ShippyPro API

ShippyPro e-commerce integrations

“
With ShippyPro we were able to connect all our carriers over one single API. They distinguish themselves through competent, multilingual support which makes them the optimal partner for us.

”

Olga Hedderich, Frontend Developer - Burg-Apotheke

Manage your carriers'
pickups easily

Get the power of 120+ Carriers with only one API integration. Read our API Documentation and start testing Pickup API for free!

You can try all other functions for free
and then decide whether to upgrade or not.

🎁

LIMITED OFFER: ShippyPro now offers you the Professional plan with 500 free orders to support you during the Peak Season time. Click here >