Rush - Help Center

Appearance

Build Your Own Tracking Page via API ​

Overview ​

This article is geared towards app developers who want to build a custom Tracking Page utilizing the Tracking Page API. Consider utilizing the Do-It-Yourself theme of tracking page and styling your tracking page with the help of TailwindCSS to match your brand style.

Consider utilizing the Do-It-Yourself theme of tracking page → style your tracking page with the help of TailwindCSS to match your brand style.

Preconditions ​

  1. Your plan should include the API Access feature. You can verify that by looking at the Settings tab features.

    Note that API Access is available only in Advanced plans or in almost all yearly plans.

  2. You need to have your Store API Key.

    Be aware that once you implement the API tracking page, we will not be able to attribute the orders coming from your custom implementation of the page, making the Analytics report unusable.

  3. Your API endpoints result is based on your tracking page configurations.

    API endpoint will act in accordance with your tracking page configurations. Examples:

    • If carriers are hidden, it will not return carrier information.
    • If only customers' emails are allowed, tracking via order number, phone number, etc., will not work.

    So you can see that actually, all your configurations are applicable to the API, as well as to your default tracking page. This is done to ease migration between both.

REST API Implementation ​

Moving forward, if you still want to build your own tracking page, seamlessly integrated into your website UI, you can use the Tracking Page REST API. You can read the full API documentation here as well as test it on the fly.

The basic implementation flow is:

  1. Once the customer submits a search string (email, order number, tracking number, etc.), you need to call the GET /search/{query} endpoint.

  2. Based on results (can be multiple if the customer has multiple orders to the same email address), you can list them for the customer to pick between.

  3. To get detailed statuses of a specific order/shipment, you need to call GET /track/{permlink} where the permalink is returned by the GET /search/{query} endpoint.

Examples of REST API Pages ​

Did this answer your question?