BObotbrains-io
📦 Trackers

Update an existing tracker

Changed on

This endpoint allows to modify an existing Tracker matching with the given identifier.

Once the Tracker has gathered shipment tracking information, certain fields related to the shipment data cannot be modified. These include:

  • courierCode
  • originCountryCode
  • destinationCountryCode
  • destinationPostCode
  • shippingDate
patch/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.

Request body

isSubscribedboolean

Setting at false will unsubscribe you from the Tracker. Once unsubscribed, you will still be able to fetch the existing tracking results but Ship24 won't search for new data or send webhook notifications. Trackers are automatically disabled after the parcel delivery or after a long period without any new events. Manually unsubscribing your tracker is not useful, except if you wish to stop receiving webhooks on it or if you need to reuse the clientTrackerId value in a new Tracker.

originCountryCodestring ISO 3166-1 alpha-2/alpha-3

Sender country code.

destinationCountryCodestring ISO 3166-1 alpha-2/alpha-3

Recipient country code - 📌 Recommended to improve tracking accuracy

destinationPostCodestring

Recipient Post code (or ZIP code) - 📌 Recommended to improve tracking accuracy

shippingDatestring date-time

Date at which the shipment has been shipped - 📌 Recommended to improve tracking accuracy: providing the shipping date helps us accurately identify the shipment and improves our ability to retrieve the correct data. However, an inaccurate shipping date could cause our system to exclude the right shipment. Therefore, please ensure the provided shipping date aligns closely with the actual shipment date, give or take a few days. Format

Response

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

    • warning

      deleted the header request parameter Content-Type

    • 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

    • info

      added the non-success response with the status