USPS Setup
The following instructions apply to setting up integration credentials for the USPS REST API integration. The USPS REST API integration is native in Znode versions 9.9 and later.
Step A: Access the USPS REST API Developer Portal
The USPS product environment REST API Developer Portal can be found at https://developer.usps.com/.
Login with an existing USPS REST API Developer Portal account or follow the instructions at https://developer.usps.com/getting-started to get a developer portal account.
If your organization already has a USPS Developer Portal account, please consult your internal team to determine whether a new account should be created. New applications can be added to existing developer accounts if desired.
Step B: Create a Developer Portal App
After you login to the developer portal (Step 2 - Getting Started), if you do not already have a Znode App created, create a USPS App by following the instructions in Step 3 - Getting Started.
Use the following values when adding the App:
Enter a value for the “App name”. This value names the software that is connecting to the USPS APIs.
Leave the “Callback URL” blank.
Review the Terms and Conditions and Privacy Policy documentation. The ability to continue creating the app is contingent on your agreement. If you agree, check the box.
Add a “Description” for the app, if desired.
Under the “APIs” listing, select “Shipping Version 3”.
After the app has been created, you will be returned to the App listing screen and the newly created App should appear in the list as an “Approved” App.
Step C: Connect your USPS Account with your USPS App
Return to the USPS Getting Started page, follow Steps 4 and 5. Steps 4 and 5 should be completed while logged into the USPS Developer Portal.
Step D: Test vs Production Credentials
The previous instructions result in USPS production environment credentials being created. USPS does not have a full test environment available, so the production environment has been used for verification within the Znode application.
If you want to explore the USPS test environment capabilities more, start with the non-production Developer Portal found at https://developer-cat.usps.com/.
Step E: Configure Znode USPS Shipping
Step E.1: USPS Integration Credentials (USPS Developer Portal)
The credential values to be input into the Znode admin must be obtained from the USPS Developer Portal.
Consumer Key. The value associated with the “Consumer Key” heading for the USPS app in the Developer Portal.
Consumer Secret. The value associated with the “Consumer Secret” heading for the USPS app in the Developer Portal.
Step E.2: Configure USPS Environment in Znode
The URL is the USPS “address” where Znode will send requests for shipping estimates.
The USPS environment URL is configured in the web.config file. The production URL value should already be configured for you, however, please verify the value in accordance with the instructions herein.
web.config file Snippet
Step E.3: Configure USPS Credentials in Znode
This configuration is needed for each store that uses USPS shipping.
In the Znode Admin, browse to the “Stores & Reps” > “Stores” > “Shipping Origin” screen and scroll to the “USPS” section.
USPS Consumer Key. The value associated with the “Consumer Key” heading of the USPS App in the Developer Portal.
USPS Consumer Secret. The value associated with the “Consumer Secret” heading of the USPS App in the Developer Portal.
USPS Integration FAQs
Do I need new business account numbers?
No! The existing business account numbers you have with your shipping vendors should remain the same. The technical logins and credentials created as part of these documented instructions should be tied to your existing business account numbers.