All Collections
Setting up my account
Get started with Shippit APIs
Get started with Shippit APIs

A complete walkthrough to get started with the Shippit APIs, and start building your bespoke integration

Updated over a week ago

Welcome to Shippit! This article walks you through all the steps you need to start building your bespoke integration, using the Shippit APIs.

💡Note: Before you start, make sure have your account set up, and you or your Shippit Project Manager have enabled carriers in your Shippit account.

There are four main steps that you need to go through:

  1. Log in to your Shippit account, if you haven't already. This activates your account.

  2. Enter your payment details. You need to have valid payment details to generate an API key.

  3. Copy your API key. You'll need this to access the Shippit APIs.

  4. Get started with the Shippit APIs.

A diagram showing the five Shippit APIs, and how they work together with merchants and partners, carriers, and end recipients

Log in to your Shippit account

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

Enter your payment details

Your must have valid billing details on your account to book consignments and generate a Shippit API Key.

Entering your payment details

  1. Open the drop down menu in the top right of your screen, and click Billing Details to open your account payment information.

  2. In the Payment details section, provide a credit card and contact details.

  3. Click Update to save your payment details.

⚠️ Important: If you can't see the Billing Details screen, make sure that you are logged in as a Merchant. If you need help, contact [email protected] or get in touch with your Shippit project manager.

Copy your API key

You have a Shippit API key for each of your stores. These work as a unique identifier for each store, allowing you to authenticate each call against the Shippit APIs. This allows you to create orders, and perform labelling and manifesting for each individual store.

Copying your API key

You can find your API key in 2 simple steps:

  1. Open the drop down menu in the top right of your screen, and click Settings to open your profile.

  2. Navigate to the Integrations section.

  3. Your API key for the current store is shown in the API Secrets section.

  4. Each store has its own unique API key. Use the drop down box at the top of the page to change store and see its unique API key.

Get started with the Shippit APIs

Now that you have your API keys, you are ready to start creating orders, and labelling and manifesting from your platform through the Shippit APIs.

For more information about the various APIs, see our developer documentation:

  • Quote API - Allows you to quote prices for an order before booking

  • Order API - Creates the order in Shippit

  • Label API - Returns a URL to a label for an order

  • Book API - Initiates a booking with the respective carriers

  • Track API - Allows you to request tracking information, or subscribe to our webhook.

For more information about getting started with the Shippit APIs, check out our Getting Started with API integrations article.

For more information about order payloads, along with some examples, check out our API payloads article.

And if you have any questions, or run into any problems along the way, get in touch with your Shippit Project Manager. We're here to help you every step of the way!

Join Noemi as she explains the five Shippit APIs

Did this answer your question?