Branded Tracking Portal

ShipStation API's Custom Tracking Portal is a customer-facing shipment tracking page that you can customize with your company logo, name, business details, colors, and social media links. To customize a tracking portal, you'll create a theme in the Tracking Portal settings. You can create as many themes as you like!

Visit our sample branded tracking portal to see it in action.

Requirements

The Branded Tracking Portal is only available for these plans and shipments:
- The Advanced plan or higher.
- Shipments to and from the US, Canada, United Kingdom, and Australia.
You must configure your theme in the dashboard.
Logo image must be a PNG or JPG file type, with a white or other solid color background (no transparent backgrounds).
With the exception of Fedex, UPS, and USPS any tracking pages created will also require your account to have a connection to the carrier used to send the shipment.

Create a Theme

Log into your dahboard.
Go to the Branding section and select Tracking.
Click the Add a Theme button to open the New Tracking Theme window, then follow the prompts to create your theme.

Once you’ve created the theme, you’ll see the Theme Name and an auto-generated Theme ID that you can use as the branded_tracking_theme_guid value when you create your Branded Tracking URL.

Create the Tracking Portal URL

The tracking_pge endpoint allows you to create a tracking page for a specific shipment. A unique URL will be generated for each tracking page.

You'll need the following information to create a tracking URL:

Tracking Number
Ship To Address
Ship From Address
Carrier Code
Shipping Service Code (optional)
Tracking Theme ID of the theme you want to use.

Once you have created the URL, you can access the page associated with that tracking number and share it with your customer.

Example Request & Response

POST /v-beta/tracking_page/

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
POST /v-beta/tracking_page HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
  "tracking_page" :[
  {
    "branded_tracking_theme_guid"   : "fc16e39d-9722-4514-aff5-75e1f24c5bbd",
    "tracking_number" : "012345678910",
    "carrier_code" : "ups",
    "service_code" : "ups_ground",
    "to_city_locality" :"austin",
    "to_state_province" : "tx",
    "to_postal_code" : "78756",
    "to_country_code" : "US",
    "from_city_locality" :"denver",
    "from_state_province" : "CO",
    "from_postal_code" : "80014",
    "from_country_code" : "US"
  }
  ]
}

Example response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "tracking_page": [
    {
      "carrier_code": "ups",
      "tracking_number": "012345678910",
      "branded_tracking_theme_guid": "fc16e39d-9722-4514-aff5-75e1f24c5bbd",
      "token": "MYkORKpDv02x-LX3yv7bdQ",
      "url": "http://track.shipengine.com/se/v1/MYkORKpDv02x-LX3yv7bdQ",
      "service_code": "ups_ground"
    }
  ],
  "page": 0,
  "pages": 0,
  "total": 1
}

Example URL

Click here or paste the URL below into a browser to see an example tracking page. We've wired up some fake data so you can see what it looks like.

1
https://track.shipengine.com/se/v1/f/gREEJpNUbEezRxfNkeBJHQ