Using a different carrier? See Package Tracking.

Introduction

Package Tracking shows a shipment's status and its scan history in your Zembula images. To track UPS packages, Zembula connects to UPS with an app that you create on the UPS Developer Portal.

Zembula only uses the UPS Tracking API to look up tracking numbers. It never creates shipments or changes anything in your UPS account.

This guide covers creating the UPS app, copying its credentials, and connecting it in the Zembula platform. You enter the credentials in Zembula yourself.

Who can do this

In UPS, you need a UPS.com ID (the login you use on ups.com) and a UPS shipper account linked to it.

In Zembula, only account Admins can connect UPS. Other users see the Package Tracking page with Ask an Admin to set this up.

Before you go live

Zembula looks up the tracking number each time the image loads. So each email open can use one UPS tracking call.

UPS sets a usage limit for each app. Check your app's plan on developer.ups.com before you go live, and make sure it covers the opens you expect.

Create the app

Go to developer.ups.com and sign in with your UPS.com ID.
Create a new app.
When UPS asks how you'll use the API, choose I want to integrate UPS technology into my business.
Select your shipper account, or add it.
Agree to the UPS API access agreement.
Add the Tracking API product. Authorization (OAuth) is added for you and can't be removed.
Save the app.

UPS doesn't let you change the app's contact email after the credentials are created.

Copy the credentials

Open the app's information page on developer.ups.com. Copy the Client ID and the Client Secret.

Keep the Client Secret private. Don't send it by email or chat. You enter it yourself in the Zembula platform in the next step.

Connect UPS in Zembula

In the Zembula platform, open Data Sync → Integrations and select the Data integrations tab.
Click Set up on the Package Tracking tile. If Package Tracking is already set up, the button reads Open instead.
If Package Tracking is off, click Turn on. The page shows Setting up the builder source… and then Use INTERFACES › Package Tracking in the builder.
Under Carriers, click Add on the UPS row.
The UPS row lists Client ID and Client Secret. Click Paste a key next to Client ID. The Paste your UPS keys dialog opens.
The dialog has two fields, Client ID and Client Secret. Paste each value into the field with its name. Zembula doesn't need your shipper number for tracking.
Click Connect.

The button reads Verifying… while Zembula saves your credentials. The UPS row then reads Connected — starts answering within the hour.

Zembula doesn't test your credentials with UPS when you connect. To check them, follow Try it on the Package Tracking page: add INTERFACES › Package Tracking to a draft image in the builder, turn on Simulate, and preview it with a UPS tracking number. If no tracking shows, check the credentials and replace them if needed.

If your account already uses order data for Package Tracking, the UPS row reads Connected — waiting: carriers and order data can't run together until the next release. To switch, click Use UPS instead. This turns order data off and UPS on. Content that sends only an order ID will then show your fallback.

Use UPS tracking in an image

In the builder, add the Package Tracking source under INTERFACES. Send it the tracking number in tracking_number and the carrier name in carrier.

Any carrier value that contains UPS as a word goes to your UPS connection, in upper or lower case. For example, UPS, ups, UPS Ground and UPS_SUREPOST all work. Always send the carrier: Zembula doesn't guess the carrier from the tracking number.

What shoppers see

Status: the shipment's current stage, such as Label Created, In Transit, Out for Delivery or Delivered. A UPS scan that Zembula can't classify reads In Transit.
Latest scan: the most recent scan UPS reports when the image loads, with its location and time.
Estimated delivery: the scheduled or rescheduled delivery date when UPS gives one. After delivery it reads Delivered, with the time of the delivery scan.
Tracking link: a link to the package on ups.com.
Manage delivery link: while the package is still on its way, a link to the same ups.com tracking page as the tracking link.

UPS keeps tracking data for 120 days. Content for older shipments may show no tracking.

Where your credentials are kept

The Client ID and Client Secret are saved as encrypted secrets. They can't be read back: the platform only shows their last four characters. They're listed under Data Sync → Secrets & Configs, and they can only be sent to UPS's API (onlinetools.ups.com).

Zembula also saves one more secret that it builds from these two, which it uses to sign in to UPS. You don't paste it.

To change your credentials, open the Package Tracking page and click Replace key next to Client ID or Client Secret on the UPS row. Zembula rebuilds its sign-in secret from the new value. To stop using UPS, click Disconnect.

More detail: Shared Secrets and Configs.