Docs Tracking API

Tracking API

The Tracking API provides a programmatic interface for developers to integrate shipment tracking & delivery capabilities into their custom applications. The API supports over 1020+ shipping carriers around the globe, offering a unified tracking experience for customers.

By integrating the TrackShip Tracking API into their custom applications, developers can streamline shipping processes and provide customers with real-time shipment updates, improving operational efficiency and customer satisfaction.

How it Works

The API utilizes RESTful web services and returns data in JSON format. The API supports multiple shipment carriers, allowing developers to track shipments from multiple carriers in one unified view.

With the API, developers can send tracking information for shipments via an API call to TrackShip. Upon shipment creation, TrackShip’s tracking engine will automatically start tracking the shipment and sending real-time shipment and delivery updates to the custom application via webhook. Developers must configure a webhook with an endpoint in their custom application to receive these updates.

To get started, developers must obtain an API key and review the available API documentation

API Quick Start

Our quick start documentation on how to use TrackShip's REST API and Webhooks. What is a shipment tracker?...

Authentication

All API calls must include this header to authenticate the usage of TrackShip API. Replace the API_KEY_HERE with...

Connect your custom app

To link your custom app, hover over the “Connect a Store” button on TrackShip’s dashboard or go to...

Create a tracking

Create a shipment tracker for Custom App URL https://api.trackship.com/v1/shipment/create/ Header Parameter: trackship-api-key : <your api key here> app-name...

Get a shipment status

This API endpoint allows you to retrieve the current status of a shipment. URL https://api.trackship.com/v1/shipment/get/ Header Parameter: trackship-api-key:...

Get shipments by order id

This API endpoint allows you to retrieve the shipment tracking status of all shipments associated with a specific...

Delete a shipment tracker

Delete a tracking. URL https://api.trackship.com/v1/shipment/delete/ Header Parameter: trackship-api-key: <your api key here> app-name: <your app name here> CURL...

Webhook

TrackShip can trigger webhook events to notify your system of every new tracking event. Securing Webhooks We currently...

API Request Errors

In the event of API request errors, TrackShip uses different HTTP response codes to indicate the correct behind...

Get all shipping providers

Get all shipping providers data. URL https://api.trackship.com/v1/shipping_carriers/supported CURL GET request: curl --location 'https://api.trackship.com/v1/shipping_carriers/supported' Response Body: { "success": true,...

API Reference

Find the complete reference documentation on how to use TrackShip REST API and webhook services. How to get...