> ## Documentation Index
> Fetch the complete documentation index at: https://developers.perform.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Tracking Page

> A branded tracking page on your own domain where shoppers follow a shipment, with layout, language and content configured per Tracking Page.

**Available to all Post-Purchase customers.**

## Summary

The Tracking Page is a branded web page, hosted on your own domain, where shoppers follow their shipment from order to delivery. You configure what it shows and how it looks, embed it as a widget on your site, and use it as the surface for ratings, campaigns and notification links.

## Who it’s for

E-commerce and customer service teams that want shoppers to track orders on the brand’s own site rather than on a carrier’s page. It answers the “where is my order” question before it reaches support, and keeps the shopper on your domain while they wait.

## Key benefits

* **Shoppers stay on your site.** The tracking widget embeds in your help centre, order status page or any other page, so there is no redirect to a third-party tracking tool.
* **The page matches your brand.** Layout, colours, typography and content blocks are configured per Tracking Page, and each page can show order details, carrier details and tracking information at the level you choose.
* **One page per market or brand.** You can run several Tracking Pages, each with its own language, reference and timezone. The page is available in more than 36 languages.
* **It works on every device.** The page is responsive for desktop and mobile across the major browsers.
* **It feeds the rest of Post-Purchase.** Notifications link to the Tracking Page of the shipment’s tracking experience, Campaign Manager places banners on it, and Delivery Experience Ratings are collected on it.

## How it works

### What a Tracking Page shows

Each Tracking Page is configured from a set of blocks: order details, carrier details, tracking information, and optional elements such as marketing banners and campaign slots. Shoppers look up a shipment by tracking number, and a Tracking Page can also accept the order number. For extra validation, lookup can require a combination such as order number plus email address or order number plus postal code.

A Tracking Page has one URL and one language. For another language, create another Tracking Page.

### Settings you control in the portal

You can edit the following directly in the portal for each Tracking Page: name, language, reference, timezone, social URLs, terms and conditions link, and privacy policy link. Design changes such as colours, fonts, layout, wording and supported languages are configured by Perform.AI from a configuration document; see the set-up section below.

### Tracking experiences and notifications

Each Tracking Page is a tracking experience. When a shipment is linked to a tracking experience, notifications sent for that shipment take their design and content settings from it, and tracking links in those notifications open that Tracking Page. Notification configurations can be filtered by tracking experience, so each brand or market can have its own notification set. Use the `tracking_page_reference` field when you create or update a shipment to link it.

### Embedding the widget

The tracking widget is delivered as a snippet with two parts: a `<div>` placeholder that marks where the widget renders, and a `<script>` tag that loads it. The script tag belongs just before the closing `</body>` tag and after the placeholder. Avoid wrapping the widget in a fixed-size box and avoid render-blocking scripts around it.

### Tracking Page overview report

The Tracking Page overview in the portal reports on the last 14 days:

| Section | What it shows |
| - | - |
| Visits by shipment phase | Visits and share of visits during order fulfilment, pick-up, in transit, out for delivery and delivered. |
| Visits by time of day | When shoppers open the page, to find peak hours. |
| Device and browser usage | Share of visitors by device type and browser. |
| Visits over time | Daily visits for the last 14 days. |
| Useful links | Shortcuts to customer ratings and notification settings. |

## Set up in the portal

Go to **Post-Purchase** > **Tracking Page**. The list shows every Tracking Page with its name and reference.

1. Select the Tracking Page and choose **Edit** to change its name, language, reference, timezone, social URLs, terms and conditions and privacy policy. Save your changes.
2. To embed the page, open the Tracking Page, copy the `<div>` snippet into your page’s HTML where the widget should appear, then copy the `<script>` snippet just before the closing `</body>` tag.
3. To change the design or content blocks, preview the Tracking Page, note the changes you want (colours, fonts, layout, wording, languages), and send them to your account team using the Tracking Page configuration document. Screenshots with markup speed this up.
4. To let shoppers look up shipments by order number as well as tracking number, ask your account team to enable it for the named Tracking Page, then test both lookups on the page.

## Use via API and MCP

* Link a shipment to a Tracking Page with `tracking_page_reference` when you [create a shipment](https://developers.perform.ai/guides/create-shipment.md) or [update a shipment](https://developers.perform.ai/guides/update-shipment.md). See the [Tracking Page guide](https://developers.perform.ai/guides/tracking-page.md) for the widget and lookup details.
* Filter shipments by Tracking Page with the `tracking_page_reference` parameter on [List Shipments](https://developers.perform.ai/api-reference/v5/shipments/list-shipments.md).
* MCP tools: `list_tracking_pages` and `get_tracking_page` return your Tracking Pages and their configuration. See [MCP tools](https://developers.perform.ai/mcp/tools.md).

## FAQ

### Can shoppers look up a shipment by order number?

Yes. A Tracking Page can accept the tracking number, the order number, or both. Ask your account team to enable order number lookup for the Tracking Page and tell shoppers which identifier to use. Extra validation, such as order number plus postal code, is also available.

### Can I run the Tracking Page in several languages?

Each Tracking Page has one language and one URL. Create one Tracking Page per language. The page itself is available in more than 36 languages.

### Can I change the colours and layout myself?

Not in the portal. You can edit the name, language, reference, timezone, social links and policy links yourself. Design and content changes go through your account team with the Tracking Page configuration document.

### How do notifications know which Tracking Page to link to?

Through the shipment’s tracking experience. Set `tracking_page_reference` on the shipment and the notification takes the design of that Tracking Page and links to it.

### Where do I see how shoppers use the page?

In the Tracking Page overview report, which covers the last 14 days. For other date ranges, use **Reports & Analysis**.

## Troubleshooting

| Symptom | Cause | Fix |
| - | - | - |
| The widget does not render on my page | The `<script>` tag is placed before the `<div>` placeholder, or a render-blocking script prevents it from loading | Place the `<div>` first and the `<script>` just before `</body>`. |
| The widget is cut off or scrolls inside a box | The widget was placed inside a fixed-size container | Remove the box around the widget so it can size itself. |
| Order number lookup returns nothing | Order number lookup is not enabled for this Tracking Page | Ask your account team to enable it, then test again with a known order. |
| Notification links open the wrong Tracking Page | The shipment is linked to another tracking experience, or to none | Set `tracking_page_reference` on the shipment to the intended Tracking Page. |
| A language is missing | Each Tracking Page has one language | Create a Tracking Page for that language. |

## Related

* [Delivery Notifications](https://developers.perform.ai/products/post-purchase/delivery-notifications.md)
* [Campaign Manager](https://developers.perform.ai/products/post-purchase/campaign-manager.md)
* [Delivery Experience Ratings](https://developers.perform.ai/products/post-purchase/delivery-experience-ratings.md)
* [Post-Purchase overview](https://developers.perform.ai/products/post-purchase/overview.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.