APIs

The International Prices API provides International USPS product pricing based on the characteristics of what is being shipped for Global Express Guaranteed, Priority Mail Express International, Priority Mail International, and First-Class Package International. Given inputs, such as origin and destination ZIP Codes, package weight and dimensions, processing category, destination rate indicator, price type, and desired Mail Class and Extra Services, this API will return the price of postage and Extra Services.

The International Prices API provides International USPS product pricing based on the characteristics of what is being shipped for Global Express Guaranteed, Priority Mail Express International, Priority Mail International, and First-Class Package International. Given inputs, such as origin and destination ZIP Codes, package weight and dimensions, processing category, destination rate indicator, price type, and desired Mail Class and Extra Services, this API will return the price of postage and Extra Services.

The Locations API can be used to find USPS destination entry facility addresses, hours of operations, available services and more. The purpose of this API is for users to lookup eligible entry locations to receive destination entry rates. USPS has specific rules for these entry types where the volume is only accepted at specific locations. This API reduces the development effort needed to implement and deploy the large complicated FAST Mail Direction Files. When you call this API with a destination ZIP Code it responds with one facility for the DDU entry, one for SCF, and one for NDC (all of which could be different facilities).

This API supports returning destination entry facilities (i.e., drop off locations) for a given ZIP Code to enable Parcel Select Destination Entry, USPS Connect, and Parcel Select Lightweight. This API also provides additional information about working hours, delivery type, mail class, shape, palletization, and facility type.

The Drop-Off Locations API enables businesses using USPS Connect products/services to determine the most convenient USPS location at which to drop off their packages and mail.

Your exclusive access to USPS APIs is protected using OAuth 2.0 industry standards.

All USPS APIs require an OAuth 2.0 access token to be conveyed in the 'Authorization' header, using the 'Bearer' token scheme.

Once you sign-in to the API developer portal, you may get the OAuth credentials you will need to register your application 'Add App'. See "Getting Started" for further information about: signing-in, registering your application, and additional USPS account credentials you will need to integrate your application with USPS APIs.

You are responsible for securing the application credentials once issued. Please contact USPS if your credentials have been disclosed to external parties and we will issue new credentials.

Your exclusive access to USPS APIs is protected using OAuth 2.0 industry standards.

All USPS APIs require an OAuth 2.0 access token to be conveyed in the `Authorization` header, using the `Bearer` token scheme.

Once you sign-in to the API developer portal, you may get the OAuth credentials you will need to register your application `Add App`.  See "Getting Started" for further information about signing-in, registering your application, and additional USPS account credentials you will need to integrate your application with USPS APIs.

You are responsible for securing the application credentials once issued.  Please contact USPS if your credentials have been disclosed to external parties and we will issue new credentials.

OAuth 2.0 API

OAuth access tokens are used to grant authorized access to USPS APIs. Access tokens will expire, requiring applications to periodically check the expiration time and get new ones.

The OAuth 2.0 client credentials grant type is the only OAuth flow presently supported. Other OAuth flows will become supported in future releases.

You will need to add an app in the API Developer Portal to get Consumer Key and Consumer Secret values.

You will need a valid customer registration ID (CRID) and mailer ID (MID) in order to get an access token. Contact your USPS Business Customer Gateway Business System Administrator (BSA) for this information.

The API supports registration of new companies to USPS.  This API will create a new customer registration ID and mailer ID if the customer is not known to USPS.  If USPS has a record of the company, the API will not create a new customer registration ID or mailer ID.  

Caches payment account information so that it is entered once then used to create multiple labels. 

Caches payment account information so that it is entered once then used to create multiple labels. 

Shipment Confirmation Acceptance Notice(SCAN) form allows integrators to link multiple domestic and international labels through one Electronic File Number (EFN) and physical SCAN Form (PS Form 5630 or 3152). 

Shipment Confirmation Acceptance Notice(SCAN) form allows integrators to link multiple domestic and international labels through one Electronic File Number (EFN) and physical SCAN Form (PS Form 5630 or 3152). 

This API supports the service standards for the number of days between the acceptance and delivery of a piece of mail that the Postal Service™ considers to be timely delivery. Service standards are delivery benchmarks for how long customers can expect for the Postal Service to deliver different types of mail from origin to destination — Point A to Point B. Service standards are not necessarily the same as the actual service performance.