This Method retrieves the shipment tracking status for 170+ Carriers with the same API call.

💡With this Method you can:

  • Retrieve shipment tracking status

  • Show the shipment status on your website or OMS

  • Get all the shipment status information as Estimated Delivery Date and the Carrier logo

Summary

  1. Before you start

  2. How it works

  3. GetTracking API reference

1. Before you start

📌 Note: This API is not recommended for bulk use. To receive all tracking updates please evaluate to setup a Webhook. Discover how you can receive real-time updates through Webhooks .

📌 Kindly remind to add Delivery days - min + Delivery days - max from Carriers > Connection > Edit Prices to correctly display Webhook tracking updates via API:

Tracking status

To simplify your work, we associated each Carrier status with six statuses:

Status Code

Description

1

Info Received

2

In Transit

3

Out for Delivery

4

Missed Delivery

5

Exception

6

Delivered

2. How it works

To call the GetTracking API, these body params need to be passed:

Name

Data Type

Required

Empty

Description

Max length

code

string

true

false

Tracking Number

3. Reference

Visit our API Documentation to view an example of Get Tracking API request and response.

For each Ship Method you can get the following items in response:

Property

Data Type

Note

Carrier

String

UPS

CarrierLogo

String

https://www.shippypro.com/sites/all/themes/shippypro_theme/assets_pannello/images/corrieri/Logo_UPS.png

Completed

boolean

true

EstimatedDeliveryDate

String

1489659960

StatusCode

String

5.60

Details[]

Array

Contains the following field

date

String

1489659960

message

String

DELIVERED

city

String

MOTRIL

status_code

Number

6

Talk to our Experts to learn more about our APIs and take your business to a next level! 💪

Did this answer your question?