Skip to main content

Getting started

Subscribe to a plan (free plan available)​

To use our Tracking API, you must subscribe to a plan. If not already done, head over to your ship24 dashboard and select a plan. We have a free plan available that you can use during your integration and testing phase.

Not sure which plan to choose? See our pricing or contact us!

Get your API key​

The Ship24 API uses API keys to authenticate requests. You can view and manage them in your Dashboard. A Default API key is created after you subscribe to a plan.

Dashboard API keys

To authenticate your requests, include an Authorization HTTP header to all your requests with the following value: Bearer your_api_key. (Replace your_api_key with the one from your dashboard and don't forget the Bearer prefix.)

For example, if your API Key is apik_kNjWKmmK68q8V2sC57B7SIgQJGdGOD, your header must be as below:

Header KeyHeader Value
AuthorizationBearer apik_kNjWKmmK68q8V2sC57B7SIgQJGdGOD
caution

Keep in mind that your API keys have a lot of power, so keep them safe! Do not post your secret API keys on GitHub, in client-side code, or anywhere else that is publicly accessible.

Do you first call​

You should be ready to do your first call to our API, from here you can:

tip

Don't have tracking numbers to test? Download and use our list of sample tracking numbers. When using those tracking numbers, please avoid filling randomly other shipment-related fields such as destinationCountryCode, destinationPostCode, shippingDate when calling our API, as you probably won't get results if this data is not matching with the shipment's real destination and date.