BObotbrains-io
📦 Trackers

Get an existing tracker

Changed on

This endpoint return an existing Tracker for a given identifier.

get/public/v1/trackers/{trackerId}

Request

Path parameters

trackerIdstring required

Required Id of the tracker, provided by Ship24 at creation. clientTrackerId can also be used in this field by employing the searchBy parameter.

Query parameters

searchBy'trackerId' | 'clientTrackerId'

Parameter allowing to search either by trackerIdor clientTrackerId. Default behavior is by trackerId.

Response

OK

trackerIdstring required

The id of the tracker that is providing this tracking.

trackingNumberstring required

The tracking number which the tracker is following.

shipmentReferencestring nullable required

Your reference for this shipment, provided at the tracker's creation. Unlike clientTrackerId, this value is not validated for uniqueness.

clientTrackerIdstring nullable required

Your unique identifier for this shipment, provided at the tracker's creation. Ship24 validates its uniqueness across all your active trackers.

isSubscribedboolean required

Indicates whether the tracker is active. A value of false means the tracker is archived and will not be used for tracking.

isTrackedboolean required

Indicates whether we are actively tracking the parcel. A value of true means new data is being searched for, while false indicates tracking has stopped due to delivery, inactivity, or unsubscription. Existing tracking results will remain accessible; however, new data will not be fetched, and notifications will no longer be sent.

createdAtstring date-time required

The date and time at which the tracker was created.

Changes

  • 49b1d626be36Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Authorization was added to the API

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status