Welcome to the Web Tools API Portal

USPS has the solution to your e-commerce API and shipping API needs. The Web Tools^® API library enables external e-commerce shopping cart and shipping software to access valuable USPS® data—free of charge! From shipping rates to tracking information to scheduling a package pickup, Web Tools makes shipping with the U.S. Postal Service^® easier than ever. Get started now or read on to learn more.

Announcements

Web Tools 2018 Release Notes (PDF)

Updated documentation is now available (Updated 9/25/2018).

New label API restrictions will take effect February 23, 2018.
• Label API Restrictions Notice - PDF
• Label API Restrictions FAQs - PDF
• Customer Options – Postage Labels - PDF

Get Email Updates

Receive email notifications about Web Tools maintenance updates.

Subscribe Now

Image of female business owner standing in front of her computer.

Easy as 1, 2, 3!

Image of hands typing on a laptop keyboard.

STEP 1.
SIGN UP

Complete the online registration form. You’ll receive an email with your User ID.

STEP 2.
DOCUMENTATION

Explore API Technical Docs and use the Quick Code provided below to test in your favorite browser.View Documentation & Updates

STEP 3.
PERMISSIONS

Want to access even more services available through Web Tools®? Request access to the advanced Label and Package Pickup APIs. Email Us

Download release notes, developer guides, and API technical documentation

See All Technical Documentation & Updates

Developer Center

Start making live calls to Web Tools APIs and integrate with USPS Web Tools® to make shipping easier for you and your clients.

Once registered, you’ll receive an email with your assigned Web Tools User ID. You’ll then have access to our most popular offerings like the shipping rate, tracking information, and ZIP™ code APIs. For access to more secure APIs, like Label Printing and Package Pickup, you’ll need additional permissions. Contact our Internet Customer Care Center ([email protected]) with the following information:

“Web Tools API Access” in the subject line of the email
Which Label APIs you want to access
If you’ll be modifying the label image

Image of three guys in conversation in front of a laptop and half-eaten pizza.

Get Started with Price Calculator Expand Collapse FAQ question

Explore Web Tools Right from Your Browser's Search Bar

Once you have completed registration, explore the most popular Web Tools® APIs and begin make a live calls to Web Tools® right from your browser. To begin making live calls:

Open a new .txt or word .doc and copy and paste the User ID from the email you received from [email protected]. Keep it on hand for the following steps.
Insert your Web Tools® user ID into the USERID="" value
Insert today's date into the value of the "ShipDate" tag (if applicable)
Select the entire XML code below and paste it into the search bar of your browser
Hit enter to make the call and receive a response in your browser
Experiment with Web Tools® and change some of the values of the XML tags

Try the Domestic Rate Calculator

Calculate postage rates quickly and easily online for domestic and international shipping. Try the Domestic Rate API below or jump into the technical documentation and start developing.

View Technical Document

Test XML Request

http://production.shippingapis.com/ShippingApi.dll?API=RateV4&XML;=&ltRateV4Request; USERID="xxxxxxxxxxxx">

&ltPackage; ID="1ST">

&ltService;&gtPRIORITY;</Service>
&ltZipOrigination;&gt44106;</ZipOrigination>
&ltZipDestination;&gt20770;</ZipDestination>
&ltPounds;&gt1;</Pounds>
&ltOunces;&gt8;</Ounces>
&ltContainer;>NONRECTANGULAR</Container>
&ltSize;&gtLARGE;</Size>
&ltWidth;&gt15;</Width>
&ltLength;&gt30;</Length>
&ltHeight;&gt15;</Height>
&ltGirth;&gt55;</Girth>

</Package>

</RateV4Request>

Try the International Price Calculator

The International Rate API calculates international postage rates quickly and easily. Try it out below or jump into the technical documentation and start developing.

View Technical Document

Sample XML Request

http://production.shippingapis.com/ShippingApi.dll?API=IntlRateV2&XML;=&ltIntlRateV2Request; USERID="xxxxxxxxxxxx">

&ltRevision;&gt2;</Revision>

&ltPackage; ID="0">

&ltPounds;&gt2;</Pounds>
&ltOunces;&gt0;</Ounces>
&ltMachinable;&gtTrue;</Machinable>
&ltMailType;&gtpackage;</MailType>
&ltValueOfContents;&gt2499;</ValueOfContents>
&ltCountry;&gtUnited; Arab Emirates</Country>
&ltContainer;&gtrectangular;</Container>
&ltSize;&gtlarge;</Size>
&ltWidth;&gt13;</Width>
&ltLength;&gt3;</Length>
&ltHeight;&gt3;</Height>
&ltGirth;&gt0;</Girth>
&ltOriginZip;&gt22201;</OriginZip>
&ltCommercialFlag;&gtY;</CommercialFlag>
&ltExtraServices;>
&ltExtraService;&gt1;</ExtraService>
</ExtraServices>

</Package>

</IntlRateV2Request>

Verify an Address Expand Collapse FAQ question

Save time and money by reducing shipping errors due to incorrect address entry. This tool corrects errors in street addresses, including abbreviations and missing information. It also supplies a ZIP+4® Code.

View Technical Document

Test XML Request

Address Validation

http://production.shippingapis.com/ShippingAPI.dll?API=Verify&XML;=<AddressValidateRequest USERID="xxxxxxxxxxxx">

&ltAddress;>

&ltAddress1;></Address1>
&ltAddress2;&gt6406; Ivy Lane</Address2>
&ltCity;&gtGreenbelt;</City>
&ltState;&gtMD;</State>
&ltZip5;></Zip5>
&ltZip4;></Zip4>

</Address>

</AddressValidateRequest>

Zip Code Lookup

http://production.shippingapis.com/ShippingAPI.dll?API=ZipCodeLookup&XML;=&ltZipCodeLookupRequest;%20USERID="xxxxxxxxxxxx">

&ltAddress;>

&ltAddress1;></Address1>
&ltAddress2;&gt6406; Ivy Lane</Address2>
&ltCity;&gtGreenbelt;</City>
&ltState;&gtMD;</State>

</Address>

</ZipCodeLookupRequest>

City/State Lookup

http://production.shippingapis.com/ShippingAPI.dll?API=CityStateLookup&XML;=&ltCityStateLookupRequest;%20USERID=" xxxxxxxxxxxx">

&ltZipCode; ID= "0">

&ltZip5;&gt90210;</Zip5>

</ZipCode>

</CityStateLookupRequest>

Track a Package Expand Collapse FAQ question

Get estimated delivery information and track any package shipped via Priority Mail Express®, Global Express Guaranteed®, or Priority Mail Express International™ services. Check the tracking information for packages shipped with USPS Tracking®, Signature Confirmatiom™, Certified Mail®, or Registered Mail™ services.

View Technical Document

Test XML Request

http://production.shippingapis.com/ShippingApi.dll?API=TrackV2&XML;=&ltTrackFieldRequest; USERID="xxxxxxxxxx">

&ltTrackID; ID="XXXXXXXXXXXXX">
</TrackID>

</TrackFieldRequest>

Print a Shipping Label Expand Collapse FAQ question

Integrate with our Shipping Label APIs to print shipping labels with a tracking barcode.

Electronic Merchandise Return Service Labels API

Let online customers print return labels for Priority Mail, First-Class Mail, Standard Post, Media Mail, and Library Mail services.

View Technical Document

Lookup Delivery Dates Expand Collapse FAQ question

Get estimated and guaranteed delivery dates with Service Standards and Commitments APIs.

Test XML Request

Priority Mail Service Standards

http://production.shippingapis.com/ShippingAPI.dll?API=PriorityMail&XML;=&ltPriorityMailRequest; USERID="xxxxxxxxxxxx">

&ltOriginZip;&gt21403;</OriginZip>
&ltDestinationZip;&gt90210;</DestinationZip>
</PriorityMailRequest>

View Technical Document

First Class Mail Service Standards

http://production.shippingapis.com/ShippingAPI.dll?API=FirstClassMail&XML;=&ltFirstClassMailRequest; USERID=" xxxxxxxxxxxx ">

&ltOriginZip;&gt902;</OriginZip>
&ltDestinationZip;&gt211;</DestinationZip>
</FirstClassMailRequest>

View Technical Document

Priority Mail Express® Service Commitments

http://production.shippingapis.com/ShippingAPI.dll?API=ExpressmailCommitment&XML;=&ltExpressMailCommitmentRequest; USERID=" xxxxxxxxxxxx ">

&ltOriginZIP;&gt207;</OriginZIP>
&ltDestinationZIP;&gt11210;</DestinationZIP>
&ltDate;></Date>
</ExpressMailCommitmentRequest>

View Technical Document

Service Delivery Calculator

http://production.shippingapis.com/ShippingAPI.dll?API=StandardB&XML;=&ltStandardBRequest; USERID="xxxxxxxxxxxx">

&ltOriginZip;&gt22201;</OriginZip>
&ltDestinationZip;&gt90210;</DestinationZip>
</StandardBRequest>

View Technical Document

Shipper Support Center
Shipper Support Center
USPS Web Tools® are e-commerce application program interfaces (APIs) that can be used for online stores or customer service centers – free of charge.

Have an E-commerce Website?

Get access to our Web Tools through a simple registration process.
Register Now View FAQs about Online Shipping

Once registered, you’ll receive an email with your assigned Web Tools User ID. You’ll then have access to the most popular APIs. For access to more secure APIs, like Label Printing and Package Pickup, you’ll need additional permissions. Contact our Internet Customer Care Center ([email protected]) with the following information:

Price Calculators

Package Tracking

Service Standards & Commitments

Address Information

Want to hire a professional?

To assist companies that need help integrating USPS Web Tools® into their sites, the Postal Service™ publishes contact information for some companies willing to provide services that meet our criteria. These lists are not exhaustive and being listed is not an endorsement by USPS®.
USPS Web Tools® Integrators

Some companies that may be able to assist with the integration of USPS Web Tools® or help you build a customer solution using Web Tools e-commerce APIs.
View List of Integrators (RTF)

USPS Web Tools® Product Providers

Some companies that sell products with Web Tools already integrated.
View List of Product Providers (RTF)
Contact Us

If you have technical questions or need more information, contact the Internet Customer Care Center (ICCC).

Contact Information

Email: [email protected]

Phone: 1-800-344-7779

Hours of Operation

Monday-Friday: 8:00am-8:30pm EST
Saturday: 8:00am-6:00pm EST
Closed: Sunday and Postal Holidays
Open Holidays: 9:00am-6:00pm EST

Martin Luther King Day

President's Day

Columbus Day

Veteran's Day
Shipper Support Center FAQs

Expand All FAQs Collapse All

Why are my Web Tools credentials not working when I try to login on USPS.com? Expand Collapse FAQ question

The login page on USPS.com is not related to APIs. There is no "log in" functionality for your Web Tools credentials. Your username and password will allow you to gain access to the Web Tools servers.

Use your credentials to:

Log into the interface of your third party software

Add authentication to your back-end programming in the API, XML

The login page shown on the usps.com website is not associated to APIs. Please review the technical documentationif you need more information about integration.

I have registered for Web Tools, what are the next steps? Expand Collapse FAQ question

For shippers using a third party shipping software or shopping cart provider, we recommend you refer to your software provider for instructions to begin offering USPS® services and, take note of relevant information provided in the registration email and links below. For developers integrating Web Tools into a custom application, we specifically recommend:

Step-by-Step Instructions for All USPS Web Tools® (important information when getting started)

API User’s Guides (API specific technical/integration information)

USPS Web Tools website (contains all these resources and more)

Why are the production server URLs I received not working when I click on them? Expand Collapse FAQ question

The production URLs included in the email confirming your registration with Web Tools are not links to a viewable website. These URLs must be included in the XML Request used to connect to our APIs (please refer to our technical documentation) for more information. If you are using a third party ecommerce software, it’s possible that these URLs are not required, and therefore, do not apply to all customers using our APIs. Please contact your software provider for more specific details concerning integration requirements.

I am using a third party ecommerce software to connect to USPS® APIs and I am having issues retrieving prices or services from USPS. Expand Collapse FAQ question

Since USPS does not know every specific integration requirements of all the possible software options available, we recommend that customers first contact their provider to troubleshoot integration-specific questions.

I have contacted my software provider and I still have questions for USPS, how do I proceed? Expand Collapse FAQ question

We will be happy to assist all customers provided the following information is included when contacting our Internet Customer Care Center at [email protected].

Customers must provide:

Copy of a sample XML request resulting in the issue or error, pasted into the body of the email

Complete description of exact issue you are experiencing

Name of API

Name of third party software provider

Please note that without the above information, our USPS agents will not have sufficient information to investigate Web Tools API issues properly.

Are the USPS APIs free? Expand Collapse FAQ question

How do I get access to USPS APIs and receive my user ID? Expand Collapse FAQ question

Get access to USPS APIs when you register for a Web Tools user account.

Once registered, you will automatically receive an email containing your assigned Web Tools User ID. After you receive this email, you can use the following APIs:

Price Calculators
Package Tracking
Service Standards & Commitments
Address Information
Package Pickup

The labels I am able to print contain a “SAMPLE-DO NOT MAIL” watermark. How can I print actual labels? Expand Collapse FAQ question

The API containing "Certify" is our testing API and will print labels with the sample watermark. In order to generate actual labels, you must remove "Certify" from all of your Web Tools XML requests.

Does USPS® have an EDDM® API available? Expand Collapse FAQ question

We currently only offer Every Door Direct Mail® (EDDM) services through our online application at.

Learn More

Have there been any recent or upcoming changes to Web Tools API? Expand Collapse FAQ question

In order to provide the very best API offering, we periodically update our systems which may require current customers to update their software. To determine if these changes/updates apply to you, refer to our most recent Release Notes. This document contains all new changes and steps to resolve if you are affected. Please remember to first contact your software provider for any integration-related questions.

Oct	NOV	Dec
	08
2017	2018	2019

English Use arrow key to access related widget.

Welcome to the Web Tools API Portal