Back to Support

API Integration

There are 4 ways to automatically enter jobs into GetSwift:

  1. Email importer: Enter jobs by automatically pulling information from order notification emails
  2. Third-party integrations: Enter jobs through direct integrations with other platforms
  3. API integration: Enter jobs through a direct connection with GetSwift through our open API
  4. Booking form: Enter jobs by inviting your customers to use our built-in booking form

To read about how to enter jobs manually into GetSwift, click here

 

Enter JOBS THROUGH THE GETSWIFT API

The GetSwift API V2 allows automated access to the GetSwift proprietary logistics platform. You can obtain quotes, book deliveries, track orders and view your order history via a simple RESTful interface

This document will explain the basics of using the API. For request and response examples click on the "Show JSON" links at the end of each section. For a more in-depth explanation of everything, please see the full technical documentation

To get started, below is an example of the simplest JSON needed to book a delivery on Swift. Send this object as a POST request (with the "Content-Type" header set to "application/json") to https://app.getswift.co/api/v2/deliveries using your merchant API key

---

{
   "apiKey": "MERCHANT_KEY",
   "booking":{
       "pickupDetail": {
           "address": "57 luscombe st, brunswick, melbourne"
       },
       "dropoffDetail": {
           "address": "105 collins st, 3000"
       }
   }
}

---

To generate and activate your API Key:

  1. Navigate to the Integration page
  2. Generate an API Key
  3. Select ‘API Key Active’
  4. Press Update and the bottom of the page