Access the boilerplate repository for the tracking app to clone it and begin development.

A tracking app published by a carrier will include an endpoint like this one:
https://app.io.vtex.com/{app_name}/{app_version}/{account}/{workspace}/tracking

Once every hour, the VTEX tracking hub makes a POST request to this endpoint containing a list of packages’ tracking numbers. The app should respond with the updated tracking information for each package.

Below are some examples, but you can learn more about this request on the tracking API request documentation.

Request body example:

[
  {
    "trackingNumber": "BR000000000"
  }
]

Response body example:

{
  <trackingNumber>: {
    "deliveredDate": Date,
    "events": [
      {
        "city": string,
        "date": Date,
        "description": string,
        "state": string
      }
    ],
    "hasReturnedToSender": bool,
    "isDelivered": bool
  }
}

🚧

Be aware that this call may contain several package's tracking numbers, and the app should respond with tracking information for each of them.

Learn more

See this guide on how to develop carrier apps on VTEX IO. You can also learn more about the integration flow and notification for carrier apps.


Did this page help you?