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:
Log in to your Shippit account, if you haven't already. This activates your account.
Enter your payment details. You need to have valid payment details to generate an API key.
Copy your API key. You'll need this to access the Shippit APIs.
Get started with the Shippit APIs.
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
Open the drop down menu in the top right of your screen, and click Billing Details to open your account payment information.
In the Payment details section, provide a credit card and contact details.
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:
Open the drop down menu in the top right of your screen, and click Settings to open your profile.
Navigate to the Integrations section.
Your API key for the current store is shown in the API Secrets section.
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:
For more information about getting started with the Shippit APIs, check out Using the Shippit APIs in the Shippit developer centre.
For more information about creating order payloads, see Create an order in the Shippit developer centre. For extensive order payload examples, see the Examples section in the Shippit developer centre.
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!
Troubleshooting
This section contains information about some common issues you might encounter getting started with the Shippit APIs. If you can't find an answer to your question here, contact our support team for assistance.
The API is giving me an error
Sometimes, the API might reply to a request with this:
{"error":"invalid_merchant_account","error_description":"An unknown error has occurred."}
This can happen for a few different reasons:
Make sure you have successfully logged in to your Shippit account. Logging in activates your account and allows you to start using it.
In your Shippit account, check that you have added your billing details. This is required even if you are using Shippit on a trial or Lite plan.
Make sure you have copied the API key correctly.
Double check that your order payload is constructed correctly. You can visit the Shippit developer centre for information about constructing your payload, including extensive example orders.
Join Noemi as she explains the five Shippit APIs