Swyft API (2020-04)

Download OpenAPI specification:Download

Introduction

Swyft is a last-mile delivery service that offers same and next-day shipping to customers at affordable rates. The Swyft technology platform with its network of warehouses and delivery companies provides merchants and their customers the best delivery experience possible.

API Overview

Welcome to the API documentation!

To use our API, make sure to set up your Swyft account by contacting your Merchant Success Manager or by contacting Swyft Support. Most user actions that can be done in our Merchant Dashboard can be done though our REST API.

Common Use Cases:

  • Creating a label
  • Deleting a label
  • Tracking a label
  • Printing a label
  • Getting package delivery rates

Authentication

AccessToken

Security Scheme Type API Key
Header parameter name: X-Swyft-Access-Token

Rates

Rates will differ depending on the package size code, in addition to the options that are configured to it.

Package size matrix:

Swyft Size Code Max Vol (cuft) Max Weight (lbs) Max Length on any side (in)
Small 0.5 5 26
Medium 1 10 26
Large 2 20 26

[2020-04] Fetch Rates

Fetch rates for given origin and destination.

Authorizations:
Request Body schema: application/json
required
object (Address)

Address where the package will be picked up

required
object (Address)

Address of the package's destination

signature_required
boolean (signatureRequired)

The customer must provide their signature on delivery through the driver phone application. For condos:

  • If there's a doorman, they can accept the package and sign for it.
  • Even if signatureRequired is false, if the driver can't find a safe place to store the package, it will not be delivered.
package_count
number (Package Count)
Default: 1

Number of packages to be delivered to a single location.

Responses

Request samples

Content type
application/json
{
  • "origin": {
    },
  • "destination": {
    },
  • "signature_required": true,
  • "package_count": 1
}

Response samples

Content type
application/json
{
  • "rates": [
    ]
}

[2020-04] Bulk Fetch Rates

Fetch rates for a bulk list of origins and destinations.

Authorizations:
Request Body schema: application/json
Array of objects

Responses

Request samples

Content type
application/json
{
  • "rates": [
    ]
}

Response samples

Content type
application/json
{
  • "rates": [
    ]
}

[2021-09] Bulk Fetch Rates

Fetch rates for a bulk list of origins and destinations. Request can only either Dimensions or Package Type.

Authorizations:
Request Body schema: application/json
One of
Array of objects

Responses

Request samples

Content type
application/json
Example
{
  • "rates": [
    ]
}

Response samples

Content type
application/json
{
  • "created_at": "2021-09-21T13:23:15.000Z",
  • "rates": [
    ]
}