API Resources

All API URLs listed in this documentation are relative to https://api.goshippo.com/v1/. For example, the /addresses/ resource is reachable at https://api.goshippo.com/v1/addresses/.

SSL Prerequisite & Authentication

The API is available via Secure Socket Layer (SSL) only. Insecure attempts to access the API will return HTTP status 403/Forbidden. The Shippo API requires Basic HTTP Authentication with your user name and password.

Passing Request Data

Request data is passed to the API by POSTing JSON arrays with the appropriate key/value-pairs to the respective resource. The documentation for each API resource contains more details on the values accepted by a given resource.

The returned data is also formatted as JSON array.

Disposable Objects

The Shippo API is built with simplicity in mind. While you can GET and POST Addresses, Parcels, Shipments and Transactions, you can only GET all other resources. This means that once you created an object, you cannot change it. Instead, create a new one with the desired values.

Caveats

While our technical team is working 24/7 to fix all issues, please help us improve the API by reporting any bugs, problems, questions or other issues to support@goshippo.com. Our support team will help you. Thanks in advance for your support!

Browsable API

In addition to this API, you may at anytime refer to the Browsable Shippo API at https://api.goshippo.com/v1/addresses/ to familiarize yourself with the structure and try out your first calls right in your browser.

Questions? Problems?

Have you run into difficulties or a resource just doesn’t seem to work right? Let us know at support@goshippo.com. Our support team will help you.

The API has been documented completely at https://api.goshippo.com/docs/. Sign up on https://goshippo.com/register/ to get access to all developer resources.