USPS Module
  • 25 Jan 2022
  • 2 Minutes to read
  • Dark
    Light
  This documentation version is deprecated, please click here for the latest version.

USPS Module

  • Dark
    Light

Article summary

Overview

Module Details

Last Modified11/03/2021
Installation LocationCore (v6.20-), Github (v6.20+)
Requires Restart?Yes
Step Location INTEGRATION > USPS
Settings Location System > Settings > USPS Settings
Prerequistes

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 to allow 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.


Example

This example will demonstrate how to configure the USPS module in Decisions.

  1. In the Decisions Studio, navigate to System > Settings. Right-click USPS Settings and select Edit.
  2. 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 ParameterDescription
Zip 5 CodesString list of Zip Codes



Get City By Zip

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 ParameterDescription
ZipZip code of a city



Get Information By Zip

The Get Information By Zip allows a user to enter a zip code and have the city, zip, and state, 

Input ParameterDescription
ZipZip Code



Get Zip By City 

The Get Zip By City step uses an address field, city, and state to get the zip code

Input ParameterDescription
Address1The physical address of the location
Address2The second line of address (i.e. apartment number, suite number, or other address designation that is not part of the physical address)
CityThe city of the location address
StateThe two-letter abbreviation of the state of the location address




Is Zip For City

The Is ZIp Valid For City is a Rule step that evaluates if the city and zip entered are correct matches.

Input ParameterDescription
CityCity of a location
ZipZIP Code of a location



Normalize Address

The Normalize Address step takes in an address that will output the full address from the USPS database with the four-digit zip code extension.

Input ParameterDescription
Address1The physical address of the location
Address2The second line of address (i.e. apartment number, suite number, or other address designation that is not part of the physical address)
CityThe city of the location address
StateTwo-letter abbreviation of the state of the location address



Was this article helpful?

What's Next