USPS Module
- 21 Feb 2023
- 2 Minutes to read
- Print
- DarkLight
USPS Module
- Updated on 21 Feb 2023
- 2 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
Module Details | |
| Last Modified | 11/03/2021 |
| Installation Location | Github |
| Requires Restart? | No |
| Step Location | INTEGRATION > USPS |
| Settings Location | System > Settings > USPS Settings |
| Prerequisites | An active account with USPS at Web Tools APIs; refer to their Development Guide for more information |
The USPS (United States Postal Service) module allows users to integrate with the USPS Web Tool Kit API, allowing developers access to the online services of the USPS.
The API provides easy access to shipping information and services for customers. By integrating these APIs into a website, customers can utilize the functions provided by the USPS without ever leaving the website.
Once the APIs are integrated into a website, the USPS Shipping API Server communicates over HTTP using XML (Extensible Markup Language).
The USPS module provides users with pre-built steps to get address information and validate the information. In addition to the USPS Module, the Get Address Information step under Integration > Google can return similar results, including the latitude and longitude of an address.
Example
This example will demonstrate how to configure the USPS module in Decisions.
- In the Decisions Studio, navigate System > Settings and click USPS Settings.
- From the Edit USPSSettings window, enter the UserId for the USPS Account. Click SAVE.
USPS Steps
The Flow steps for the USPS module are found in the steps browser at Integrations > All Integrations > USPS or in the Toolbox at INTEGRATION > USPS. Each step's input parameters can be configured on the Properties panel.
Get Cities By Zips step
The Get Cities By Zips step allows the user to enter a list of zip codes. The step will return the city of each zip code entered.
| Input Parameter | Description |
|---|---|
| Zip 5 Codes | String list of Zip Codes |
The Get City By Zip step allows the user to enter a zip code. The step will output the city of the zip code entered.
| Input Parameter | Description |
|---|---|
| Zip | Zip code of a city |
The Get Information By Zip allows a user to enter a zip code and have the city, zip, and state,
| Input Parameter | Description |
|---|---|
| Zip | Zip Code |
Get Zip By City
The Get Zip By City step uses an address field, city, and state to get the zip code
| Input Parameter | Description |
|---|---|
| Address1 | The physical address of the location |
| Address2 | The second line of address (i.e. apartment number, suite number, or other address designation that is not part of the physical address) |
| City | The city of the location address |
| State | The state of the location address |
The Is ZIp Valid For City is a Rule step that evaluates if the city and zip entered are correct matches.
| Input Parameter | Description |
|---|---|
| City | City of a location |
| Zip | ZIP Code of a location |
The Normalize Address step takes in an address will output the full address from the USPS database with the four-digit zip code extension.
| Input Parameter | Description |
|---|---|
| Address1 | The physical address of the location |
| Address2 | The second line of address (i.e. apartment number, suite number, or other address designation that is not part of the physical address) |
| City | The city of the location address |
| State | Two-letter abbreviation of the state of the location address |
For further information on Modules, visit the Decisions Forum.
Was this article helpful?
