Overview

From 25 January 2025 USPS will decommission their Webtools Tracking API. This means customers using the old USPS-Endicia integration are required to migrate their preference so it is connected to Endicia via the Zenkraft API. For common questions and issues please see this guide.

We are continuously updating this guide with more questions and known issues.

Install the latest version of the package for sandbox or production.

What happens if I do not migrate?

USPS will deprecate their Webtools Tracking API therefore you will not be able to receive tracking updates.

How do I know if my preference is migrated?

You will find the newly generated ZK API Shipping ID under the Account Number field on the Shipping Preference. Your preference will also show as 'Migrated' under the Migration object.

What is my next step?

For step-by-step migration instructions follow the below steps.
For any questions or assistance, please reach out to our support team.

Migration steps for USPS Shipmate users

Here you can find a detailed step by step guide of migrating from USPS Shipmate to USPS - Endicia connected through the Zenkraft API in Multi-Carrier.

1. Install the latest version of the Multi-Carrier app

The package version in your environment should be at least v1.138.8. You can find the install link of the latest package under the Overview section of this page.

2. Upgrade to the latest version of the USPS Shipmate app

The package version in your environment should be at least v3.79.
Please use the following upgrade links for sandbox or production.

2. Install the latest version of the Migration Toolkit

Please use the Migration Toolkit v0.31 for sandbox or production.

3. Migrate your Shipmate Preferences

USPS Shipmate preferences can be migrated directly into the Multi-Carrier app.

IMPORTANT NOTES:
Once a preference is migrated it can NOT be reverted.

1. Navigate to the 'Bringg Migration' object in Migration Toolkit
2. Click on the'Migrate Single Carrier Preferences' button
3. Select 'USPS' from the carrier dropdown
4. Select the preference(s) you want to migrate
5. Click on the 'Migrate Preferences' button
6. Once completed you will see a 'Success' message and your preference will now be located under Shipping Preferences in the Multi-Carrier
7. To finish migrating the preferences to 'USPS - Endicia' proceed with Step 2 of Migrate to Multi-Carrier.

4. Migrate Historic Data

It is possible to save historic data from the Shipmate app.

1. Navigate to the 'Bringg Migration' object
2. Click on the 'Create Job' button
3. Select USPS from the carrier dropdown
4. Fill in the 'Description'
5. Select a preference option for the Single Carrier as well as the Multi-Carrier
6. Apply filters if needed
7. Add any custom field mapping needed. It is recommended to add the lookup relationships as a minimum so the shipment is related to the same record
8. Click on 'Start Migration'

You can find an example migration job below:

5. Recreate your configuration in Multi-Carrier

Once the shipping preferences are migrated to the Multi-Carrier you need to make sure to replicate and recreate any operational configuration. This includes, but not limited to:

• Custom Address Sources
• Package profiles
• Scheduled tracking

Migration steps for Multi-Carrier users using "USPS - Endicia"

Here you can find a detailed step by step guide of migrating your existing USPS - Endicia to connect through the Zenkraft API.

1. Install the latest version of the app

The package version in your environment should be at least v1.138.8. You can find the install link of the latest package under the Overview section of this page.

2. Migrate your Shipping Preferences

IMPORTANT NOTES:
Once a preference is migrated it can NOT be reverted.

1. Navigate to the 'Migration' object in Multi-Carrier
2. Go to the 'USPS Migration: Preferences' tab
3. Select the preference(s) you want to migrate
4. Click on the 'Migrate' button

Once a preference is migrated you find the newly generated ZK API Shipping ID under the Account Number field on the Shipping Preference. Your preference will also show as 'Migrated' under the Migration object.

3. Custom Address Sources

You can continue using the existing Custom Address Source configuration.

4. Disable the old Webtools Tracking

Check if you use USPS-Tracking under Zenkraft Settings > Other Settings. If it is enabled you need to disable it to use the new tracking connection via the Zenkraft API.

Migration steps for Multi-Carrier users using "USPS - Endicia (API)"

If you are already using USPS (API) through the ZK API then no actions are required.

Migration steps for Multi-Carrier users using "USPS - Tracking"

Here you can find a detailed step by step guide of migrating from USPS - Tracking to USPS - Endicia (API) or USPS (API).

1. Decide which API integration you want to use

If you only use the USPS-Tracking integration you need to decide whether to migrate to USPS - Endicia (API) or the direct USPS (API).
To use the 'USPS - Endicia (API)' integration you will need an Endicia account.
To use the 'USPS (API)' you need to reach out to USPS and request API credentials.

2. Install or upgrade the Multi-Carrier package to version 1.138.8+

You can find the install link of the latest package under the Overview section of this page.

3. Recreate your Shipping Preference

Create a new shipping preference for your chosen carrier.

4. Update the tracking processes

Update any any other processes referencing the old USPS-Tracking preference. This can include:

• Custom Address Sources
• Scheduled tracking jobs
• External tracking flows

API Only

Here you can find a detailed step by step guide of migrating from USPS - Tracking to USPS - Endicia (API) or USPS (API).

1. Decide which API integration you want to use

If you only use the USPS-Tracking integration you need to decide whether to migrate to USPS - Endicia (API) or the direct USPS (API).
To use the 'USPS - Endicia (API)' integration you will need an Endicia account.
To use the 'USPS (API)' you need to reach out to USPS and request API credentials.

3. Recreate your Shipping Preference

Create a new shipping account for your chosen carrier.

• USPS - Endicia (API)
• USPS (API)