Here is a simple guide to help you with the shipping API integration of ShippyPro APIs.
ShippyPro API is the easiest way to integrate your system with 155+ Carriers worldwide to ship your packages. As a multi carrier shipping API for ecommerce, it connects your existing tools to every carrier you work with from a single shipping platform.
To start using ShippyPro API, you should first:
Need an API key for a third-party pickup-point app? First, check that your ShippyPro subscription includes access to the API section, API calls and API key generation.
You can upgrade your subscription yourself from Plans in your account. For pricing and plan management, see ShippyPro Pricing, Payments and Plans.
For example, Globe Pick Up is a third-party app with its own pricing that lets your customers select a pickup point at checkout. It needs ShippyPro API access to transmit the selected pickup-point information to ShippyPro.
Globe Pick Up charges are separate from your ShippyPro subscription. Paying for Globe Pick Up does not replace the ShippyPro subscription required for API access.
For pickup-point shipment guidance, see How to add a Drop Off Point to my shipments.
You can add more than one API Key directly from your ShippyPro profile. Follow these simple steps:
Open the API section of your ShippyPro profile.
Click on Add API and the API key will form automatically.
You can choose the functionalities for your API keys from this drop-down menu:
| API key type | What it can do |
|---|---|
| Full Access | The API key can be used for all the API functionalities (shipments, rates retrieval, access to the Ship&Collect maps, etc.) |
| Maps | The API key can only be used to show the PUDO map for Ship&Collect functionalities |
| PII Excluded | All the Personal Information will be obscured by this key (Names, addresses, phone numbers, etc.) |
The API call parameters are case‑sensitive and must match the documentation exactly.
Using our API solution, you can get all your systems (like OMS, WMS, POS, ERP and many others) to communicate with your Carriers using a simple API integration.
Our API is written in 14 programming languages and in two different technologies, REST and SOAP.
Any API call has its own method: as per the latest updates, we currently only accept POST method.
You'll find your API Key by clicking on API.
Once you copied your API Key, follow the steps explained here: API Documentation > Authentication.
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.
Please remember to set the API Call as follows:
With ShippyPro you can make up to a maximum of 20 API calls every 10 seconds.
This means that you can do 10 API calls in one second but then you will only have 10 remaining API calls for the next nine.
When request submissions exceed this limit, API will return the following error: Error: 429 Too Many Requests.
Alternatively, we suggest you use different IP addresses and apply a load balancer logic in order to overcome this limit.
If you want to increase this limit, kindly contact sales@shippypro.com for a quotation.
From API, click on View API logs to see live requests and responses in more detail.
API (Request + Response) are in Json format.
Product & Resources
Connect your OMS, WMS, POS or ERP to your carriers with one shipping API.
Explore the API →See the carriers, marketplaces and e-commerce platforms you can connect.
View integrations →Create shipping labels and manage every carrier from one place.
Discover the platform →Methods, authentication and parameters for your shipping API integration.
Read the docs →Book a demo and see how ShippyPro API connects your systems to 155+ carriers.
You can test our API using API Documentation or an External Software that supports API calls.
Click on the right top button Use the API Console.
You will be redirected to our API documentation, where you can test the various API methods listed in the left-hand panel.
Please note that Ship and Edit calls will generate REAL shipping labels, which will be counted as part of the shipments included in your current Plan each month. We recommend using the Generic Carrier to test these calls.
To run a test, select the method you want to use and then execute a test via the "Test request" button on the right.
You will be shown an interface with the selected method — simply enter your API key in the Bearer Token section and press "Send" at the top of the screen.
Please be aware that since Generic is not a real carrier, it is not possible to generate a valid tracking number. Learn how to use the Generic Carrier by clicking here.
If you wish to use an API call that is not included among those listed in the API list, you will need to use a different tool such as Postman or Insomnia.
In short, only Shipments generated through Ship call will be counted, and therefore only the ones correctly generated. Those which faced Error won't be included.
Get Rates call simply show Prices and Options for the shipment, for this reason it doesn't concern shipment count.
Moreover, orders with Error won't be counted as a proper shipment.
You can decide to apply the best API Fields validation option you prefer at every moment from API section.
You can choose between three different options available, let's take a look at them!
| Validation option | What happens |
|---|---|
| Enable the blocking validation control on all API requests fields | If you wish to prevent the API call from being sent in case of missing data or an invalid API, you can select this option to block the generation of the call. This will result in an error in the request. |
| DO NOT BLOCK but include fields validation suggestions in the API responses | API call will still be sent, accompanied by helpful hints to identify any errors encountered. |
| DO NOT BLOCK and DO NOT INCLUDE any validation suggestions in the API responses | Allows you not to block the call and don't display any suggestion for the error. |
Kindly note that if you use our API Console you won't be able to edit the scheme of each call and the predefined validation would be the hard one.
If you don't want the shipment to go through despite validation errors, just enable the option Enable the blocking validation control on all API requests fields. This way you won't generate empty labels in the response.
Go to this link to check the most common errors & resolutions about API: How to fix API errors
A shipping API lets your own systems talk directly to carriers to create shipments and get rates. With ShippyPro API, your OMS, WMS, POS or ERP connects to 155+ carriers through one integration.
Up to 20 API calls every 10 seconds; above that you get a 429 Too Many Requests error. To raise the limit, contact sales@shippypro.com for a quotation.
Only shipments correctly generated through the Ship call count, and Get Rates calls don't. Ship and Edit calls create real labels, so test them with the Generic Carrier.
Related Articles
A roundup of logistics APIs worth knowing when you plan your integration.
Read more →Common causes of WooCommerce shipping API errors and how to solve them.
Read more →The real benefits of managing all your carriers from one platform.
Read more →The most common ShippyPro API errors and how to resolve them.
Open the guide →Book a demo and get your shipping API integration up and running with ShippyPro.