Welcome to the Web Tools API Portal

USPS Web Tools® APIs enable 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.

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

Easy as 1, 2, 3!

  1. Developer Center

    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.

    Register NowView 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 (uspstechnicalsupport@mailps.custhelp.com) 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
    • How you intend to pay for label postage

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

    View API Technical Documentation

    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">

    <Address>
    <Address1></Address1>
    <Address2>6406 Ivy Lane</Address2>
    <City>Greenbelt</City>
    <State>MD</State>
    <Zip5></Zip5>
    <Zip4></Zip4>
    </Address>

    </AddressValidateRequest>

    Zip Code Lookup

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

    <Address>
    <Address1></Address1>
    <Address2>6406 Ivy Lane</Address2>
    <City>Greenbelt</City>
    <State>MD</State>
    </Address>

    </ZipCodeLookupRequest>

    City/State Lookup

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

    <ZipCode ID= "0">
    <Zip5>90210</Zip5>
    </ZipCode>

    </CityStateLookupRequest>

    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=<TrackFieldRequest USERID="xxxxxxxxxx">

    <TrackID ID="XXXXXXXXXXXXX">
    </TrackID>

    </TrackFieldRequest>

    Integrate with our Label APIs to print domestic or international shipping labels with a tracking barcode. Note: The Web Tools Label API does not allow customers to pay label postage directly to USPS through Web Tools web services. Postage payment can be administered at your local Post Office or through other postage payment services.

    USPS Tracking® Labels API

    Generate USPS Tracking barcoded labels for Priority Mail®, First-Class Mail® parcels, and package services parcels.

    View Technical Document

    Signature Confirmation™ Labels API

    Generate a complete address label, including a Signature Confirmation barcode, for Priority Mail, First-Class Mail parcels, and package services parcels.

    View Technical Document

    Priority Mail Open & Distribute® Labels API

    Use this tool to generate labels to be placed on a Tag 161 or Tag 190 for Priority Mail Open & Distribute containers.

    View Technical Document

    Priority Mail Express® Labels API

    Generate a single-ply Priority Mail Express shipping label with complete addresses, a barcode, and a mailing record.

    View Technical Document

    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

    International Shipping Labels API

    Generate international shipping service labels with addresses, barcode, customs form, and mailing receipt.

    View Technical Document

    Customs Forms API

    Generate customs forms (PS Form 2976 or PS Form 2976-A) online with complete addresses and barcodes.

    View Technical Document

    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=<PriorityMailRequest USERID="xxxxxxxxxxxx">

    <OriginZip>21403</OriginZip>
    <DestinationZip>90210</DestinationZip>
    </PriorityMailRequest>

    View Technical Document

    First Class Mail Service Standards

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

    <OriginZip>902</OriginZip>
    <DestinationZip>211</DestinationZip>
    </FirstClassMailRequest>

    View Technical Document

    Priority Mail Express® Service Commitments

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

    <OriginZIP>207</OriginZIP>
    <DestinationZIP>11210</DestinationZIP>
    <Date></Date>
    </ExpressMailCommitmentRequest>

    View Technical Document

    Service Delivery Calculator

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

    <OriginZip>22201</OriginZip>
    <DestinationZip>90210</DestinationZip>
    </StandardBRequest>

    View Technical Document

  2. 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 NowView 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 (uspstechnicalsupport@mailps.custhelp.com) 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®.

    Image of female business owner standing in her shop.

    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: uspstechnicalsupport@mailps.custhelp.com

    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

    Why are my Web Tools credentials not working when I try to login on usps.com? 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:

    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.

    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.

    We will be happy to assist all customers provided the following information is included when contacting our Internet Customer Care Center at uspstechnicalsupport@mailps.custhelp.com.

    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.

  3. Documentation & Updates

    Documentation & Updates

    Use our technical documents to get step-by-step information on how to integrate USPS Web Tools® into a web site or shipping application. For technical questions, contact us at uspstechnicalsupport@mailps.custhelp.com.

    Get Adobe Acrobat ›

    Announcements & Updates

    • September 2015 Release Notes (updated 9/1/15) - RTF
    • July 2015 Release Notes (updated 7/22/15) - RTF
    • Web Tools SSL Security Certificate (updated 6/7/15) - DOC
    • Transition Guide: Service Delivery Calculator API - RTF
    • New: Simplified Onboarding Process - RTF
    • Transition Guide: RateV3 to RateV4 - RTF
    • Updated Step-by-Step Instructions for All USPS Web Tools - RTF
    • Web Tools FAQs - RTF

    Web Tools Release Notes

    Current Release Notes

    • September 2015 Release Notes (updated 7/22/2015) - RTF
    • July 2015 Release Notes (updated 7/22/2015) - RTF
    • May 2015 Release Notes (updated 5/19/2015) - RTF
    • Transition Guide: Service Delivery Calculator API - RTF

    Show Past Release Notes about Web Tools™

    Past Release Notes

    • January 2015 Release Notes (posted 1/23/2015) - RTF
    • September 7th Maintenance Release Notes (v1.5, posted 9/4/14) - RTF
    • International Delivery Confirmation Release Notes - RTF
    • PMEI Guarantee to Canada Release Notes - RTF
    • June 2014 - RTF
    • Transition Guide: RateV3 to RateV4 - RTF
    • May 2014 - RTF
    • March 2014 - RTF
    • February 2014 - RTF
    • January 2014 - RTF
    • July 2013 - RTF
    • May 2013 - RTF

    Developer Guides & Instructions

    Step-by-Step Instructions for All USPS Web Tools - RTF | HTM | PDF

    Policies and Procedures for Software Distributors - RTF | HTM

    API User's Guides

    Address APIs - PDF | HTM

    • Address Validation/Standardization
    • City & State Lookup
    • Zip Code™ Lookup

    Tracking & Delivery Information APIs - PDF | HTM

    • Tracking
    • Tracking by Email
    • Proof of Delivery
    • Restore Archived Tracking
    • Return Receipt Electronic

    Price Calculator APIs - PDF | HTM

    • Domestic Price Calculator
    • International Price Calculator

    Shipping Label APIs: Domestic

    • Domestic Shipping Labels (Priority Mail, Standard Post, First Class Package Service) - PDF | HTM
    • Domestic Shipping Labels with Signature Confirmation™ - PDF | HTM
    • Priority Mail Express® Labels - PDF | HTM
    • eVS Labels - PDF | HTM
    • Hold For Pickup Labels - PDF | HTM
    • Merchandise Return Service Labels - PDF | HTM
    • Merchandise Return Service Bulk Labels - PDF | HTM
    • Open and Distribute™ Labels - PDF | HTM
    • Scan Form - PDF | HTM

    Shipping Label APIs: International - PDF | HTM

    • Priority Mail Express International™
    • Priority Mail International®
    • First-Class Mail International® and First-Class Package International Service

    Shipping Label APIs: Custom Forms - PDF | HTM

    • Custom Form 2976/CN22
    • Custom Form 2976A/CP72

    Package Pickup APIs - PDF | HTM

    • Check pickup availability
    • Schedule a pickup
    • Cancel a pickup request
    • Update a pickup request

    Service Standards & Commitments APIs

    • Domestic Mail Service Standards - PDF | HTM
    • Service Delivery Calculator - PDF | HTM

General Web Tools FAQs

Are the USPS APIs free? Expand Collapse FAQ question

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

Register Now

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

We do not currently offer the ability to pay for postage directly to USPS® through Web Tools APIs. For lower-volume customers, you can pay for postage at your local retail location, through a third party PC postage provider, or print and pay for labels directly through Click-N-Ship®.

Get Information on other Postage Payment Options

Permissions for creating shipping labels without postage and scheduling Package Pickups are added separately. To get permission, contact our Internet Customer Care Center (uspstechnicalsupport@mailps.custhelp.com) and include "Web Tools API Access" in the subject line. For Label API permission requests, include in the body of the email:

  • Which Label APIs you would like to access
  • If you will be modifying the label image
  • How you intend to pay for label postage. Payment cannot currently be remitted directly to USPS® through the API.

Get Information on Postage Payment Options

The Web Tools APIs only print labels without postage and the APIs are not linked to your USPS.com® account or payment methods. Lack of integrated payment through our APIs is a common complaint and we are working hard to add this, however, we are still in the very early stages.

We recommend customers pay for postage using either a third party postage meter or at the Post Office™ location.

Get Information on Postage Payment Options

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.

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

Learn More

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 NotesThis 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.