Skip to content

Tracking API

Covers APIs for getting a list of couriers and retrieving waybill information.

Notes

For more information about pagination, see the Pagination documentation.

Query.carriers (Get a list of couriers)

Default

You can use Query.carriers to get a list of carriers.

Below is an example of importing 10 available couriers. For information related to pagination, see Pagination.

Query (GraphQL)
Variables
to see the response.

Specify a country

You can provide a hint (preference) to the courier sort order by specifying your preferred country in countryCode in Query.carriers.

warning

Currently, you can specify countryCode, but it is not reflected in the results and will be reflected after the GA release.

Query (GraphQL)
Variables
to see the response.

Search for couriers by text

You can use searchText in Query.carriers to search for the desired carrier.

Based on the text entered, it will infer the courier the user wants and provide a list of likely couriers.

Query (GraphQL)
Variables
to see the response.

Request to add a carrier

If you need to add a carrier that Delivery Tracker doesn't offer, then please refer to here.

Query.track (Get waybill information)

You can use Query.track to query waybill information via courier ID and waybill number.

warning

Periodically polling the Track API to track changes is not recommended. If you need to track changes, use the Tracking Webhook API.

The recommended timeout is up to 15 seconds.

Get last known information

Many users of delivery trackers require a last status lookup to determine whether a delivery has been completed. In Delivery Tracker, you can retrieve only the last event via [TrackInfo.lastEvent] (/docs/api-schema/types/objects/track-info).

Query (GraphQL)
Variables
to see the response.

Get more information

The example below shows an example of looking up the last 10 events for a specific waybill number. If you need more than 10 events, you can view more events via Pagination.

In addition, TrackInfo contains a variety of other information not mentioned in the documentation, such as sender information, see TrackInfo for more information.

Query (GraphQL)
Variables
to see the response.