Versions Compared

Old Version 2

changes.mady.by.user Michael Stivers

Saved on

compared with

New Version Current

changes.mady.by.user Michael Stivers

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

About APIs

An Application Programming Interface (API) provides an interface between two applications, enabling them to communicate and exchange information programmatically. In general, an API is  a set of routines, protocols, and tools for building and connecting software applications. 

APIs can be based on a variety of styles and standards. For example, web service APIs use the HTTP protocol for data requests and responses between a client and a server. ShipHawk’s APIs are web service APIs based on the popular REpresentational State Transfer (REST) style, in which data is exchanged in the JavaScript Object Notation (JSON) format. This format is lightweight and easy to parse, which  increases overall performance.

ShipHawk APIs

The ShipHawk TMS API documentation: API provides a simple way to integrate our warehousing and shipping intelligence into your existing systems. You can call the API from your online shopping cart, customer relationship management system, ERP, or order management system.

ShipHawk WMS API Documentation

ShipHawk TMS API Documentation

ShipHawk TMS Webhooks

ShipHawk supports webhooks. For  more information, see https://docsshiphawk.shiphawkforce.com/#overviewIntegrating with the ShipHawk WMS: Lref gdrive fileurlhttps://docs.google.com/document/d/1LbQatbTFnBRH9Ih2foqM6suL08TPVHnwtksjXJE4sDc/edit?usp=sharing/success/s/article/Does-ShipHawk-support-Webhooks

How Long Can It Take To Set Up A TMS Integration?

Typically, an experienced development team can set up  an integration in a few days (under one week). More complicated systems may require up to two weeks.

What is the setup process like?

Typically, the process includes four steps: 

  1.  Item Mapping – mapping your  items to ShipHawk,  so ShipHawk knows how to package them.

  2. Getting Rates – identify  where you want  rates implemented in your system. Note that it’s best to store the item mapping in your database to avoid making two ShipHawk  API calls when getting rates: this improves performance,  reducing the time it takes to get a rate. Remove as much item entry as possible. 

  3. Booking Shipments – when you are ready to send shipments to ShipHawk,  we help you with getting labels and BOLs.

  4. Tracking –  subscribe  to our tracking webhooks to seamlessly receive updates from ShipHawk.

What is the typical response time?

Typically,  rates are returned in under 2 seconds. It can  take up to 5 seconds, depending on the carrier. Accessing many carriers at once can slow the process down. Brokers can take  7 to 10 seconds.

How do I get a TMS or WMS API key?

You can get an API key for the TMS or WMS API from the ShipHawk TMS’s Developer API settings screen. See Developer API (Settings Screen).

Info

If working with the WMS API, please contact ShipHawk Support obtaining a WMS API key.

How do I find out the status of ShipHawk APIs?

You can see a live view of ShipHawk status at: https://status.shiphawk.com

You can subscribe to email updates. For more information, see https://shiphawk.force.com/success/s/article/Is-ShipHawk-having-issues-or-experiencing-downtime