Skip to main content
Version: 1.0.0

Carrier API

The API has been designed to allow partners of Super Dispatch to share information back and forth between two [or more] systems. Our RESTful API allows an order to be sent through Super Dispatch, to be fulfilled using Super Dispatch's Mobile app and Dashboard [TMS], while allowing other [select] systems to receive requested updates during the order's lifecycle.

Key Features​

  • Send order to a carrier via Super Dispatch mobile application
  • Receive a confirmation
  • Vehicle inspection
  • Order tracking
  • Proof of delivery (ePOD)
  • Bill of lading (eBOL)

Requirements​

  • Use only https connection
  • We use REST for communications
  • We use Webhook to notify about order status updates
  • For all requests and responses we use application/json as a content type
  • Cross-origin resource sharing is enabled by default
  • We DO NOT recommend long-polling the API. The API is rate limited

Terminology​

  • Broker: An intermediary who arranges transactions between a buyer and a seller
  • Carrier: A transportation company that owns one or multiple trucks
  • Owner Operator: A company/professional who owns and operates their business with a single truck
  • Fleet: A company that runs and manages a group of trucks
  • Driver: A truck driver who is responsible for shipping vehicles
  • Vehicle: A single vehicle (usually associated with a specific VIN)
  • BOL (Bill of Lading): A document that describes inspection details of a particular vehicle

Order States​

  • Unassigned: An order is not assigned to a driver
  • Assigned: An order is assigned to a driver
  • Picked Up: An order is picked up by a driver from an origin
  • In Transit: An order is on its way
  • Delivered: An order is delivered by a driver to a destination
  • Archived: An order is archived
  • Billed: An order has been invoiced to a customer
  • Paid: A payment for the order has been received by a customer

Authentication​

The API supports OAuth 2 Client Credentials grant type. Get access_token by sending an authentication request with client_id and client_secret.

Security Scheme Type:

oauth2

OAuth Flow (clientCredentials):

Token URL: /oauth/token/

Scopes:

  • carrier: Carrier operations

  • driver: Driver operations

  • expense: Expense operations

  • invoice: Invoice operations

  • order: Order operations

  • webhook: Webhook operations