This document lists the ShipHawk API endpoints the integration calls. It is useful for firewall allowlisting, API troubleshooting, and understanding which ShipHawk endpoints a deprecation notice might affect.

ShipHawk provides a REST API. In the patterns below, [Base URL] is the ShipHawk API URL configured on your iPaaS.com subscription — the tenant-specific URL ShipHawk provides for your account, in the form https://[tenant].tms.myshiphawk.com (for example, https://sandbox-example.tms.myshiphawk.com for a sandbox). Endpoints use the /api/v4/ path.

Used during FROM iPaaS.com transfers to retrieve an existing ShipHawk order (for example, to locate an order before an update or when reconciling a duplicate order number), where {Id} is the ShipHawk order identifier.

Used during FROM iPaaS.com transfers to create a new order in ShipHawk.

Used during FROM iPaaS.com transfers to update an existing ShipHawk order, where {Id} is the ShipHawk order ID.

Used during shipment tracking transfers to retrieve a shipment from ShipHawk, where {Id} is the ShipHawk shipment ID.

Registers the shipment tracking webhook in ShipHawk when the subscriber enables the tracking scope in iPaaS.com.

Retrieves the webhooks registered in ShipHawk.

Removes a registered webhook from ShipHawk, where {Id} is the ShipHawk webhook ID.

ShipHawk uses API Key authentication rather than a separate authorization endpoint. The API Key is sent with every request in the X-Api-Key header. The key is entered on the ShipHawk subscription settings in iPaaS.com and generated in the ShipHawk portal under Settings > Developer API.