Making Requests

Our API is accessible over HTTPS, is RESTful, and speaks JSON in both directions.

The current API version is v1. The version you wish to target can be specified using an Accept header with the value application/vnd.fourkites.v1+json.

If no Accept header is given, the latest version of the API is used. It is recommended to always send an Accept header, to ensure, there are no backward incompatible changes based on the API version.

As the API uses JSON for both requests and responses, we will assume that requests with a payload are using properly formatted JSON, however, we still recommend setting the Content-Type header to the value application/json.

We describe endpoints throughout the documentation which are meant to be understood as living under the API subdomain, i.e. the endpoint /shipments correspond to https://api.fourkites.com/shipments for the Production environment and for the Staging environment it will correspond to https://api-staging.fourkites.com/shipments