Using the Shippit APIs

The Shippit APIs are available for you to integrate shipping and logistics directly into your applications and workflows. They’re designed to handle everything from getting shipping quotes to printing labels, tracking packages, and even managing returns.

This guide is for software developers and integrators who are responsible for building and maintaining connections between Shippit and other systems. You should be familiar with REST APIs and JSON data formats.

You can use the Shippit APIs to automate and streamline your shipping processes. By connecting your systems to Shippit’s platform, you can:

  • Eliminate manual data entry: say goodbye to tedious copying and pasting of order details.
  • Offer real-time quotes: provide your customers with accurate shipping costs at checkout, potentially reducing cart abandonment.
  • Gain end-to-end visibility: track your shipments from the moment they leave your warehouse to the moment they reach your customer’s doorstep.
  • Simplify returns: Make returns easy for you and your customers, with automated return label generation and tracking.

The Shippit APIs empower you to create a seamless, efficient, and customer-friendly shipping experience.

You can access the Shippit APIs using the base URL of https://app.shippit.com/api/3.

Shippit also provides a staging URL for testing purposes, at https://app.staging.shippit.com/api/3.

Get started

Before you start, make sure have your Shippit account set up. When your account is ready, you receive an email that confirms you have access to the platform. Follow the instructions in the email and log in to your Shippit account.

When you are logged in, make sure you have enabled some carriers in your Shippit account, you have added billing details, and copied your API key. For more information about how to do this, see the Get Started with Shippit APIs article.

Make sure you use a staging environment when developing against the Shippit APIs. You can access Shippit’s staging environment at https://app.staging.shippit.com/api/3/.

Implement robust error handling in your code to catch and manage API errors effectively. For more information about troubleshooting common errors, see the troubleshooting section.

The Shippit workflow

When you create an application to use the Shippit APIs, the general workflow is:

  1. Authenticate: Securely connect to the API using your unique API keys.
  2. Get quotes (optional): Request shipping rates from multiple carriers based on your order details.
  3. Create an order: Submit your order details, including delivery address, items, and parcel information.
  4. Retrieve labels (optional): Generate and print shipping labels.
  5. Book a carrier: book your orders with a carrier.
  6. Track orders: Monitor the progress of your shipments and receive real-time updates.
  7. Manage returns (optional): Handle return requests and generate return labels.

For more information on the Shippit order flow, see the order flow section.

Stay up to date

Shippit regularly updates and improves the API. Stay informed about changes and update your integration accordingly. For release notes, see the release notes collection on the Shippit help centre. For the change log, see the change log on the Shippit developer centre. You can also sign up for regular communications from the Shippit team.

SOC2 compliance

Shippit is SOC2 Type 2 compliant. This means that Shippit have implemented a range of processes and procedures designed to keep your data safe, and to ensure that we meet best software development practices. SOC2 compliance covers items like managing user access, vulnerability scanning, business continuity and disaster recovery plans, data encryption, and responsible disclosure. If you need further information about SOC2 Type 2 compliance, or require letters or statements confirming Shippit’s compliance, talk to your Shippit account manager, or contact Shippit support.