Skip to main content
Advanced Mode
← Back
Throughout This Page
You can jump to the specified sections by clicking on these titles.

Overview

This document outlines the essential first actions to take upon accessing your Shipping API account for the first time. We'll guide you through creating an API account, installing couriers, establishing smart shipping functionalities, and beyond.

Introduction to Shipping

Welcome to Shipping and your new home for courier label creation, tracking, troubleshooting and more.

We want to welcome you with some information about Shipping, how it helps your business be more efficient, and why using our platform is the right choice for your business.

First and foremost, Shipping is a translator of languages, not the spoken language but the language of code and the unfamiliar world of JSON, XML and other jargon that might not be your cup of Yorkshire Tea!

We have worked tirelessly to make the requests you send to us achieve two core things: 

  • Consistency:
    • Each request conforms to a standardised format applicable to any courier service you prefer.
  • Accessibility:
    • Requests are presented comprehensibly and decipherable even to those devoid of technical prowess.

We take this simple request that you send to us and convert it into many formats and languages that the couriers need to receive so that you don’t have to. We also take their responses in all sorts of formats and standardise them for you so that what you send to us and receive back from us is always familiar.

With Shipping, you can make fast decisions to change course on a courier based on shipping parameters such as weight and postcode, collection days and times to switch between couriers based on pick-up time or what day it is or even by keywords such as Flat or Farm.

If a courier arrives at your doorstep offering great prices, there is no need to worry about IT integration. We already have the necessary APIs, and you can start using our services as soon as you fill out the account form. This way, you can save money on IT development resources and get the best optimisation for your parcels based on their price and speed.

Our API is designed to securely register courier accounts without the need to pass sensitive credentials across the web. Instead of using courier account credentials, our system registers each courier with a friendly name, known as an "auth". If you have a single site, you can request the courier without specifying an auth. However, if you have multiple sites with multiple account numbers, you can assign each site a unique name, such as "Birmingham" or "Manchester", and link it to the corresponding account number. This ensures that your requests are directed to the correct account number without the need for sensitive information to be transmitted.

Your API user and token are guardians for your requests, accompanying each API transmission to us. Employing AES-256 encryption and multi-factor authentication, we fortify your data against unauthorised access, ensuring its integrity.

We're thrilled to embark on this journey with you and anticipate liberating your workflows from constraints.

Installing Postman

To install Postman, visit the official Postman website at Postman Downloads. Once there, you'll find the download button to choose the version compatible with your operating system—whether it's Windows, macOS, or Linux. After downloading the installation file, locate it in your designated download directory and install it by following the on-screen instructions.

If you haven't already, please create a Postman account to access its full features and services. You can quickly sign up for an account by visiting the Postman signup page at Postman Account Signup. Once you've installed Postman and created an account, you can efficiently utilise Shipping API.

Setting Up Postman

To access the documentation for the Shipping API, visit this page and save it to your Postman account.

  1. Click the "Run in Postman" button in the screen's top right corner.
  2. Choose the second option and select "Postman for Windows/Linux/Mac OS."
  3. Pick your workplace for importing the collection and confirm your selection.
  4. You'll find the Shipping API calls and examples in your Postman account upon completion.

Creating an API Account Using GUI

Before diving into features, setting up your API account within Shipping API is essential. This account is the foundation of your shipping operations, allowing you to access and utilise the platform's tools effectively. From label creation to shipment tracking, everything starts with your API account. It's the first step towards optimising your logistics process.

For instance, you can create groups within Shipping API and assign API accounts accordingly. This feature proves particularly useful for businesses operating across multiple locations, allowing for more organised tracking and usage. Each API account can install couriers independently, ensuring that courier connections and settings are unique to the account. Also, by creating separate API accounts and groups for different locations or offices, businesses gain the flexibility to tailor their shipping solutions to specific needs. Grouping locations helps you better manage your workflow and simplify operations.

Refer to our dedicated API Accounts documentation for detailed guidance on setting up your API account and obtaining your token.

Configuring Collection Variables in Postman

After obtaining your API username and token, configuring them in Postman is the next step. By saving them as collection variables, you can simplify the process and avoid repeated entries when calling API endpoints. Postman will retain this information, allowing you to focus solely on making endpoint calls.

  1. When viewing the collection, navigate to the "Variables" tab at the screen's centre.
  2. Input the required information as follows:
    • Variable: api_url
    • Variable: api-user
      • Initial Value: Insert your API username
    • Variable: api-token
      • Initial Value: Insert your API token
  3. Click on the "Save" button in the screen's top right corner.

Creating an API Account Using the API

The initial step to familiarise yourself with the API is creating an API account via the API interface. This straightforward process facilitates future workflow organisation, mainly when collaborating with multiple team members across various locations.

  1. Choose "Create a New API User" on your screen's left side.
  2. Customise the request according to your preferences. For instance, you may specify only the "name" field while removing others. The Shipping API will then generate a key and token for you.
  3. Click the "Send" button at the screen's top right corner.
  4. The response to your request will appear at the bottom of the page. You can save this information for later use.
  5. Navigate to "API Accounts" within Shipping to view the newly created API account in the graphical user interface (GUI).

Getting a List of Couriers

To view the available couriers along with their names and details, you can utilize this endpoint to access all pertinent information. It is how couriers are identified within the API and how to reference them later.

Follow these steps:

  1. Select "List Couriers" from the left-hand menu.
  2. Click "Send" to submit the request.
  3. You will find a list of available couriers in the request-response. You can identify each courier by the string contained within the "key" attribute.

Displaying Required Courier Parameters

Before proceeding to install couriers, it's essential to understand the parameters and information they require for installation. You can easily accomplish this by following these steps:

  1. Navigate to "Get Auth Rules" in the left-hand menu.
  2. Adjust the URL with the courier for which you need information. Replace the courier key in the middle as indicated:
    • {{api_url}}/API/couriers/v1/ENTER-YOUR-COURIER-KEY-HERE/register-auth-rules
  3. Click the "Send" button at the page's top right corner.
  4. In the request response, you will find the required and optional keys and their expected values, whether they are strings, integers, or dictionaries.

Installing a Courier Through the API

Now that you know the fundamentals of API user setup and couriers, let's guide you through creating your initial courier connection. Each API account possesses the capability to independently install couriers, ensuring that courier connections remain distinct to each account. This meticulous level of control empowers you to tailor your shipping configuration to the specific requirements of your business segments.

To install a courier via the API, follow these steps:

  1. Navigate to "Register Auth" in Postman's left-hand menu.
  2. Adjust the request URL, such as replacing the courier name with your desired choice. In this demonstration, we'll install DHL.
  3. Customise the request data according to the courier's specific requirements. You can refer to the previous section if you need guidance on this.
  4. Click the "Send" button at the screen's top left corner.
  5. Review the request response to determine whether the installation was successful or unsuccessful.
  6. To view the newly installed courier, proceed to Shipping and select "API Accounts" from the left-hand menu.
  7. In the API account where you installed the courier, click the "View Registered Auths" button.
  8. You can confirm that DHL is listed in the installed couriers' section, indicating a successful installation process.

Creating Smart Rules

Once you've set up your courier services, the next step is to configure smart shipping.

Smart shipping offers businesses an efficient approach to managing logistics and parcel delivery operations. It also simplifies selecting carriers and services based on predefined criteria using a user-friendly interface and API integration. 

You can create rule groups and smart rules to tailor your shipping strategies to specific needs within the smart shipping interface. This segmentation allows for precise control over shipping methodologies, catering to diverse customer preferences and optimising efficiency.

To learn how to set up Smart Shipping, visit the dedicated guide on this page.

Back to top