Integration methods

Overview

We offer 3 different methods to integrate your tracking page using our Javascript library, ShipupJS. We also offer the possibility to build your tracking page entirely by yourself using our API.

You can integrate the tracking page on distinct pages of your website, but we recommend that at least one of those pages is not restricted to authenticated users: Most of your tracking page's views will come from the "Track my order" button in Shipup notifications. It's a better experience for your customers if they don't need to be logged in, particularly while browsing on mobile.

Integration methods for ShipupJS

You can display your tracking page through :

ShipupJS, our embeddable JS library
👍: Most flexible integration, embed anywhere.
👎 : (Little) coding is necessary to integrate our Javascript snippet
See instructions here

Our Shopify one-click integration
👍: Easy setup, no code required, page lives in your store.
👎: Low customization, store needs to be built with Shopify.

Or we can host the tracking page for you
👍: No setup, you can use your domain name in front of the tracking page.
👎: Low customization, tracking page does not live in your store.

Integration methods by API

In case you want full control over how your tracking page looks, you can alternatively use our API to request all the data necessary to build your own tracking page. The available endpoints to retrieve such data are the Order and Tracker index endpoints. Since this API uses a private key that should not be shared with your users, you must retrieve the data to build your tracking page on the server.

While offering advanced customization capabilities, this alternative puts back the responsibility to build the tracking page in your hands. The complexity of such a task should not be understated. That's why we would suggest considering this option only if integrating with ShipupJS is not possible for your use case.