Our API provides a trackShipment
endpoint that allows you to track a shipment using its tracking number and delivery company name. This guide explains how to retrieve shipment tracking details, including status updates and tracking history.
Instructions
Step 1: API Endpoint
- To track a shipment, use the following POST endpoint:
Step 2: Authorization
- A valid Bearer Token must be included in the request headers for authentication
Step 3: Request Body Parameters
- The request body should be in JSON format and include the following fields:
Field Name | Required | Type | Description |
---|---|---|---|
trackingNumber | Yes | String | The tracking number of the shipment. |
deliveryCompanyName | Yes | String | The name of the delivery company handling the shipment. |
statusHistory | No | Boolean | Set to true to retrieve the shipment's status history. |
brandName | No | String | The brand name associated with the shipment. |
Step 4: Example Request
Using cURL:
Step 5: Example Response
- A successful response will include tracking details and shipment history (if requested):
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article