Guides LoginApp

Order Status Page Version Upgrade

Upgrade your tracking plugin to expand your Order Status page to its full capability with added customization options.

Overview of Changes

The changelog of the Order Status page is described in the following sections.

Updated JavaScript Plugin

You need to replace your current snippet with the new snippet in the <body /> of your Order Status page.

<div id="parcellab-track-and-trace">
  <img src="https://cdn.parcellab.com/img/loading-spinner-1.gif" alt="loading" />
</div>

<script>
  function plTrackAndTraceStart() {
    window.parcelLabTrackAndTrace.initialize({
      plUserId: TYPE_YOUR_USER_ID_HERE
    });
    var linkTag = document.createElement('link');
    linkTag.rel = 'stylesheet';
    linkTag.href = 'https://cdn.parcellab.com/css/v5/main.min.css';
    document.getElementsByTagName('head')[0].appendChild(linkTag);
  }
</script>
<script async onload="plTrackAndTraceStart()" 
src="https://cdn.parcellab.com/js/v5/main.min.js"></script>

Changes to URL Query Parameters

URL query parameters that serve as on/off switches to enable/disable components in the page now expect to receive the following values: FALSE|TRUE|YES|NO.

If you are using the disableVoting option, the values true or yes need to be set to disable any voting features that are configured for your Order Status page.

If you are using the pwrdBy_parcelLab option, the values false or no need to be set to disable the parcelLab reference on your Order Status page.

parcelLab User ID Option

When using the tracking plugin with orders, the plUserId option should be used.

https://myshop.com/track-and-trace?plUserId=1612197&orderNo=00PL004

The userId and u options are backward compatible, however plUserId takes precedence for retrieving the value of your parcelLab user ID.

Discontinued URL Options

The following URL options are no longer available:

  • animateTruck

  • customCss

  • margin

If you were using the margin option to control the margins of the tracking plugin, this should now be managed in the root container. The tracking plugin takes the full width of the screen (that is: capped at 750px in small devices, 970px in medium devices, and 1170px in large devices).

Custom ID for Plugin Root Container

You can now pass a custom ID to be used for the root container where the tracking plugin will be loaded. If a custom ID is not implemented, the ID of the root container falls back to parcellab-track-and-trace.

New HTML Classes for Styling

If you are using a custom stylesheet to override the default CSS styles, you may need to update your CSS rules to accommodate the discontinued URL options. You can also use the options described in the following table for additional customization of your Order Status page.

Option
Description
Sample/Default

icon_theme

Enables holiday-themed status icons.

xmas or easter

liveMapBackground

The background color of the live tracking map footer.

Hex color code

liveMapColor

The text color in the live tracking map footer.

Hex color code

tabIconColor

The color of tab icons for multi parcel deliveries.

Hex color code

tabActiveIconColor

The color of the active tab icon for multi parcel deliveries.

Hex color code

PreviousOrder Status Page ConfigurationNextRetrieving the Security Hash

Last updated

Was this helpful?