ShipHawk API Documentation

This is the complete API documentation for connecting to the ShipHawk API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet ShipHawk: connect business data and workflows through MindCloud's Universal API. Keep reading to get started.

Quickstart

Before you run your first ShipHawk request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one ShipHawk connection — create or choose one in Connections. Note its connectionId.

Every ShipHawk action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/shiphawk/latest/actions/{actionSlug}

You need a MindCloud API Key and a ShipHawk connection. Then call an action such as Get All Shipments:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/shiphawk/latest/actions/get-all-shipments" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authenticate with a MindCloud API Key plus a connectionId for your ShipHawk account. See ShipHawk API Authentication for the full flow and how to get your connection credentials.

ShipHawk actions

All 17 published actions for this ShipHawk version. Each page documents the endpoint, arguments, and response controls.

• POSTBulk Sku Import
• POSTCheck Address
• POSTCreate a New Rate Request
• POSTCreate a Proposed Shipment
• POSTCreate a Shipment
• POSTCreate an Order
• POSTCreate SKU
• GETGet a Shipment
• GETGet All Orders
• GETGet All Shipments
• GETGet Order by Number
• GETGet SKU
• GETSearch Orders
• GETSearch Skus
• POSTUpdate an Order
• PUTUpdate Order by ID
• PUTUpdate SKU

Related apps

More apps on the Universal API, behind the same REST shape. Or browse all apps.

Google SheetsGmailSlackGoogle CalendarGoogle DriveNotionGoogle FormsMailchimp