To start the integration with ShippyPro API, you should first:

Create a ShippyPro Account by clicking here

Connect your Carriers Account from Carriers > Connection and complete the Carrier setup. For more details, please read the relative article How to set the carriers’ rates

After setting up your ShippyPro profile, read our API-Documentation carefully by clicking here: https://www.shippypro.com/ShippyPro-API-Documentation/. You'll find all the information you need in order to use our API there.

Our APIs are written to be RESTful.

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



Once you copied your API Key, follow these steps: API Documentations > Authentication

Please remember to set the API Call as follows:

API KEY as Username
Leave the Password blank

ShippyPro API CALLS

Here the most used API requests:

GET RATE

ShippyPro RATE API allows you to get the rates of all your couriers ordered by price with just one simple API Request. The response will also include estimated delivery days.

SHIP

Ship allows you generate labels according to your label settings for any supported carriers.

Please note that the values CarrierName, CarrierService and CarrierID have to be added from here.



Remember that if you put Async = true, you'll have to use a Webhook in order to generate a label.

TRACKING

With this API you can track your shipments and get notified to a webhook whenever your shipment receives a new status.

How can I test ShippyPro API?

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

PS: Given that Generic is not a real Carrier, it won't generate any real tracking number.
Learn how to use Generic Carrier here

Click here if you'd like to see live requests and responses in more detail.

Was this article helpful?
Cancel
Thank you!