BObotbrains-io
➕ API for per-call plans

Get tracking results by tracking number

Changed on

This endpoint will return the tracking corresponding to the tracking number provided as a parameter.

The tracking object is detailed in the SCHEMAS section.

For better accuracy, we strongly advise to provide extra information such as the origin country, destination postcode & country, and the shipping date.

🛑 You need an active "Per-call" subscription to use this endpoint. Our standard "Per-shipment" product & plans remain the best choice as it offers more features, allow faster tracking information fetching with less dependency on courier's system availability at a lower cost overall.

🛑 As this endpoint is synchronously fetching tracking results from couriers, response time may be up to 1 minute, and results depend on the courier's system availability at the time of the call.

post/public/v1/tracking/search

Request

Request body

trackingNumberstring

Tracking number of the shipment.

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

Sender country code - 📌 Recommended to improve tracking accuracy

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

Created

Changes

  • 9d68f8b1d086Revision changes
    • breaking

      the ///// response's property format changed from date-time to no format for status

  • 49b1d626be36Revision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      added the pattern ^[a-zA-Z0-9- ._/]*$ to the request property

    • warning

      deleted the header request parameter Authorization

    • warning

      deleted the header request parameter Content-Type

    • warning

      the request property's maxLength was set to 32

    • 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