API

API > Return API

One API Call to create return labels for your shipments

Return API allows you to create return labels for your shipments as soon as your customers ask for a return. 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 Return API

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

Create returns for your shipments as soon as your customers ask for them

With Return API, you can create return labels for your shipments in a few seconds. This way, managing your return process becomes really quick for you and your customers!

Create returns for your shipments as soon as your customers ask for them

Need to optimize the whole return process? Try ShippyPro Easy Return

ShippyPro Easy Return is the perfect solution to offer an optimized return experience to your customers. Use ShippyPro Platform to create a ready to use return portal to be embedded on your website in a few steps. Automate your return policy implementation no matter the number of rules you have in place and make returns easy and fast both for you and for your customers.

Need to optimize the whole return process? Try ShippyPro <a href='https://www.shippypro.com/easy-return.html' class='c-violet stdBold' title='Easy Return'>Easy Return</a>

Explore Return API

Take a look at Return 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
With only one more field “IsReturn” you will be able to generate a return label. The rest of the call is the same as Ship

Request

{
	"Method": "Ship",
	"Params": {
		"to_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"
		},
		"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
			}
		],
		"TotalValue": "123 EUR",
		"TransactionID": "ORDER2365",
		"ContentDescription": "Milk",
		"Insurance": 0,
		"InsuranceCurrency": "EUR",
		"CashOnDelivery": 0,
		"CashOnDeliveryCurrency": "EUR",
		"CashOnDeliveryType": 0,
		"CarrierName": "DHLExpress",
		"CarrierService": "EXPRESS DOMESTIC",
		"CarrierID": 23,
		"OrderID": "12345",
		"RateID": "",
		"Incoterm": "DAP",
		"BillAccountNumber": "",
		"PaymentMethod": "Paypal",
		"Note": "Ship by 25/06/2018",
		"Async": false,
		"IsReturn": true,
	}
}

Response

{
	"Result": "OK",
	"NewOrderID": "1234567",
	"LabelURL": [
		"https://cdn.shippypro.com/labels/label-u2504n6612345-15640512345.zpl",
		"https://cdn.shippypro.com/labels/label-u2504n6612345-commercialinvoice-15640512346.zpl"
	],
	"PDF": [],
	"ZPL": [
		"myzpllabel1...",
		"myzpllabel2..."
	],
	"TrackingCarrier": "SpringXBS",
	"TrackingNumber": "UD26123123456",
	"TrackingExternalLink": "https://mailingtechnology.com/tracking/?tn=UD26123123456",
	"AdditionalTrackingNumbers": [],
	"Status": "1"
}
<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
	<Body xmlnxsi="http://www.w3.org/2001/XMLSchema-instance" xmlnxsd="http://www.w3.org/2001/XMLSchema">
		<Ship xmlns="http//www.shippypro.com">
			<to_address xmlns="">
				<name>John Doe</name>
				<company>ShippyPro</company>
				<street1>123 Main St</street1>
				<street2 />
				<city>Park City</city>
				<state>UT</state>
				<zip>84060</zip>
				<country>US</country>
				<phone>5551231234</phone>
				<email>johndoe@gmail.com</email>
			</to_address>
			<from_address xmlns="">
				<name>John Doe</name>
				<company>ShippyPro</company>
				<street1>123 Main St</street1>
				<street2 />
				<city>Park City</city>
				<state>UT</state>
				<zip>84060</zip>
				<country>US</country>
				<phone>5551231234</phone>
				<email>johndoe@gmail.com</email>
			</from_address>
			<parcels xmlns="">
				<length>5</length>
				<width>5</width>
				<height>5</height>
				<weight>10</weight>
			</parcels>
			<TotalValue xmlns="">123 EUR</TotalValue>
			<TransactionID xmlns="">ORDER2365</TransactionID>
			<ContentDescription xmlns="">Milk</ContentDescription>
			<Insurance xmlns="">0</Insurance>
			<InsuranceCurrency xmlns="">EUR</InsuranceCurrency>
			<CashOnDelivery xmlns="">0</CashOnDelivery>
			<CashOnDeliveryCurrency xmlns="" />
			<CarrierName xmlns="">DHLExpress</CarrierName>
			<CarrierService xmlns="">EXPRESS DOMESTIC</CarrierService>
			<CarrierID xmlns="">23</CarrierID>
			<OrderID xmlns="">12345</OrderID>
			<RateID xmlns="" />
			<Incoterm xmlns="">DAP</Incoterm>
			<BillAccountNumber xmlns="" />
			<Note xmlns="" />
			<PickNumber xmlns="">12345</PickNumber>
			<Async xmlns="">false</Async>
		</Ship>
	</Body>
</Envelope>

Response

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<AdditionalTrackingNumbers />
	<LabelURL>
		<element>https://cdn.shippypro.com/labels/label-u2504n6612345-15640512345.zpl</element>
		<element>https://cdn.shippypro.com/labels/label-u2504n6612345-commercialinvoice-15640512346.zpl</element>
	</LabelURL>
	<NewOrderID>1234567</NewOrderID>
	<PDF />
	<Result>OK</Result>
	<Status>1</Status>
	<TrackingCarrier>SpringXBS</TrackingCarrier>
	<TrackingExternalLink>https://mailingtechnology.com/tracking/?tn=UD26123123456</TrackingExternalLink>
	<TrackingNumber>UD26123123456</TrackingNumber>
	<ZPL>
		<element>myzpllabel1...</element>
		<element>myzpllabel2...</element>
	</ZPL>
</root>

How to start integrating
Return API

Read our API
Documentation

Read our API Documentation to get more details on how Return 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.

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

Speed up your
return process

Get the power of 120+ Carriers with only one API integration. Read our API Documentation and start testing Return 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 >