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 API provides a simple way to integrate our 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:

ShipHawk 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 an 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:

Item Mapping – mapping your items to ShipHawk, so ShipHawk knows how to package them.
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.
Booking Shipments – when you are ready to send shipments to ShipHawk, we help you with getting labels and BOLs.
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 an API key?

You can get an API key from the ShipHawk user interface’s Developer API settings screen. See Developer API (Settings Screen) .

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