Versions Compared

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. 

...

The ShipHawk 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.

WIth ShipHawk’s API,  your development team has the building blocks necessary to access ShipHawk’s unique packing and shipping data. It works like a set of instructions on how to make requests to ShipHawk for data and the kinds of responses that are returned; letting your system  know what to send to ShipHawk and it  gets back from ShipHawk. 

ShipHawk’s API gives you control over a process that has long been risky and uncertain. The  API is the gateway to our entire platform, which includes fully landed rates, booking, automatic dispatch, status tracking, and shipping document generation. The API supports standalone use cases such as parcel label printing, as well as more powerful functions to enable shipping process automation from rating to delivery, and beyond. Access endpoints that enable rating, booking, dispatch, tracking, and reconciliation to automate both eCommerce workflows as well as more traditional offline sales channels.

For implementation and integration, the ShipHawk API  uses standard REST HTTP methods (GET, POST, PUT, and DELETE). You pass in JSON and we  take care of interfacing with legacy carrier EDI and SOAP/XML. If you’re using Magento, our plugin makes integration even simpler.  By passing in just a few parameters, you can leverage the ShipHawk API to reduce overhead and ship with confidence.

With the ShipHawk  API, you can take the features and benefits of ShipHawk and integrate  them within your own system. If you are not yet a ShipHawk customer, to learn more about ShipHawk and  the ShipHawk API, see: https://shiphawk.com/shipping-api/ .

ShipHawk API Documentation

  • ShipHawk Shipping Platform offers comprehensive API documentation, located here:
    https://docs.shiphawk.com/

  • For the ShipHawk WMS API, see:

    Lref gdrive file
    urlhttps://docs.google.com/document/d/1LbQatbTFnBRH9Ih2foqM6suL08TPVHnwtksjXJE4sDc/edit?usp=sharing

...

ShipHawk WMS API Documentation

ShipHawk TMS API Documentation

ShipHawk TMS Webhooks

ShipHawk supports webhooks. For  more information, see https://shiphawk.force.com/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.

...

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 user interface’s 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?

...