All Collections
How API works
How to start integrating API
How to start integrating API

Here is a simple guide to help you with the integration of ShippyPro APIs.

Updated this week

ShippyPro API is the easiest way to integrate your system with our integrations worldwide to ship your packages. 

Let's see how to integrate APIs step by step 🔍

1. API Documentation 📄

To start using our APIs you need to carefully read our API Documentation. This way, you'll get all the information you need to know about how our APIs work.

2. Join ShippyPro for free 📝

You can join ShippyPro for free! Create an account to get started with API implementation. If you'd like to know how to create an account step by step, click here.

3. Connect at least one Carrier. 🚚

Connect a Carrier Account from Carriers > Connection and complete the Carrier setup. For more details, please read the relative article here.  

4. Get your API Key. 🔑

We're almost there, now what you need to do is activate the API Key.

💡Note: Our APIs are written to work as either a RESTful or SOAP service

You'll find your API Key by clicking on Integrations  > API.

Once you copied your API Key, follow these steps explained here:

API Documentation > Authentication

Please remember to set the API Call as follows:

  • API KEY as Username

  • Leave the Password blank

In case you obtain the error "API Key cannot access PII methods", you should create a new API key from scratch and perform calls with the newly created one.


5. Test API 💻

You can now finally test our APIs using Generic as Carrier. We created this carrier in order to test all ShippyPro features.

💡Note: Generic is not a real Carrier, it won't generate any real tracking number

Learn how to use Generic Carrier here.


You can test our API Calls from Integrations & API > API. Click on the right top button Use the API Console.

You'll get access to ShippyPro API Console, where you can test all our API Calls:

📌 Please note that if you'd like to use an API call that is not included among the ones listed in the API Console you should employ a different software like Postman or Insomnia.

Would you like to test our APIs for free? Click on the button below to know how:


6. What can I do from the API section on ShippyPro?

From Integrations > API, click on View API logs you'll be able to see live requests and responses in more detail.

By clicking on API Errors instead, it's possible to consult all the history of errors faced.

Through Webhook Logs, by inserting your endpoint you'll get notified upon changes of delivery status and be able to access useful insights about tracking updates

Discover here how Webhooks work!

7. You're ready to go! ✨

Now you're ready to start integrating our APIs, take a look at our dedicated Help Center Articles to learn how to get the most out of ShippyPro APIs.

If you need more information on how the pricing works, check out our pricing page. 🚀

💡Note: remember to first accept our General Conditions from Label Creator > To Ship before using APIs.

Did this answer your question?