简介

The USPS Web Tools Application Program Interfaces (APIs) allow developers of web-based and shrink-wrapped applications access to the online services of the United States Postal Service (USPS). They provide easy access to shipping information and services for your customers. By integrating these APIs into your web site, your customers can utilize the functions provided by the USPS without ever leaving your web site. Once the APIs are integrated into your website, the USPS Shipping API Server communicates over HTTPS using XML (Extensible Markup Language).

Implementing these APIs requires experienced programmers who are familiar with Internet and web site development tools and techniques.

This document provides guidance and step-by-step instructions for installing the USPS APIs, as well as fulfilling various administrative requirements. The administrative requirements vary between different APIs (e.g., submitting samples of labels for some APIs, signing a licensing agreement for certain software, etc.), and this document provides guidance to navigate through the process for the API you are implementing. It is imperative that developers read this manual first, as it provides necessary information and procedures prior to use.

There is a Web Tools User’s Guide for each API available at http://zh.usps.com/webtools/. These user guides provide information of the XML transactions to the USPS Shipping API server.

User ID Restrictions

The user ID that you have received is for you or your company to use in accordance with the Terms and Conditions of Use to which you agreed during the registration process. This user ID are not to be shared with others outside your organization, nor are they to be packaged, distributed, or sold to any other person or entity. Please refer to the Terms and Conditions of Use Agreement for additional restrictions on the use of your user ID, as well as this document and the APIs contained herein.

警告： If the U.S. Postal Service discovers use of the same user ID from more than one web site, all users will be subject to immediate loss of access to the USPS server and termination of the licenses granted under the Terms and Conditions of Use.

The documentation and sample code contained in the Web Tools User Guide series may be reused and/or distributed to your customers or affiliates to generate awareness, encourage Web Tool use, or provide ease-of-use. However, it is your responsibility to ensure that your customers do not use your user ID. Direct your users to www.usps.com/webtools/ so that they can register, agree to the Terms and Conditions of Use agreement, and receive their own unique user ID.

Note to Software Distributors: The user ID restrictions discussed above are intended for e-tailers that use the USPS Web Tools exclusively within their own web sites. If you plan to distribute software with the USPS Web Tools embedded, you must refer to the “Software Developers” Terms and Conditions of Use” available at http://zh.usps.com/webtools/.

For more information regarding the USPS Web Tools APIs user ID policy, or for questions regarding the distribution of documentation, please send an email to the Internet Customer Care Center (ICCC) at https://Emailus.usps.com/.

Notice on Web Tools Account Duration: A Web Tools user ID will be deactivated if it has not been used within the last 18 months. If your Web Tools credentials have been deactivated due to inactivity, a new account will need to be created. Reference the Web Tools registration page https://registration.shippingapis.com to create new Web Tools account.

USPS Corporate Branding Guidelines

The U.S. Postal Service requests that it is referenced and acknowledged as the source of information for all U.S. Postal Service data that has been acquired through the Internet and/or from other sources. However, this is not mandatory. The following guidelines should be followed for those that want to authenticate and/or validate the data displayed from the U.S. Postal Service.

Preferred Reference

Use one of the following when the USPS is the only referenced source:

· “Information provided by www.usps.com“

或

· Use the official USPS corporate logo or USPS product-specific logos.

Digital copies of USPS corporate trademarks/logos are available through the U.S. Postal Service, Public Policy and Communications Department, Washington, D.C. You can request the USPS corporate logo and/or product-specific logos by e-mailing ilogo@email.usps.gov. Requests will be responded to by e-mail within 10 days. We will review your web site, and if appropriate, provide the logo for usage in accordance with these guidelines and the license grant contained in the Terms and Conditions of Use for Internet Shipping Application Program Interfaces (APIs). If your web page is not available over the Internet, please provide a screen shot of the page where the logo will reside.

When requesting logo(s) you must provide the following information:

· company name

· URL and page where logo will reside

· type of business

· how and where the logo will be used

· contact name

· telephone number

· e-mail address

· desired graphic format, e.g., GIF, TIF, JPEG, etc.

· logo desired:

____USPS Corporate Eagle Logo

____Express Mail

____Priority Mail

____other (describe)

Alternative Reference

Use one of the following when the USPS is listed with other shipping carriers or web sites:

· United States Postal Service

· U.S. Postal Service

· U.S.P.S. (use period after each initial)

The above alternatives are listed in the order of U.S. Postal Service preference.

Examples:

“U.S. Postal Service delivery standard is two days.”

“U.S.P.S. Priority Mail rate is $3.95.”

Registered Trademarks

The USPS trademarks listed on page i, as well as any logos requested from USPS Public Policy and Communications Department, should not be altered or abbreviated. You can request product-specific logos by emailing ilogo@email.usps.gov.

Trademark Ownership and Use

USPS trademarks are trademarks owned solely and exclusively by USPS and may be used only in the form, manner and with appropriate legends prescribed by USPS. All advertising and other uses of USPS trademarks must include a legend indicating that USPS trademarks are the property of USPS and that they are being used under license from USPS, together with any other legends or marking that may be required by law. Nothing contained in this document shall be deemed to convey any title or ownership interest to any user except for the nonexclusive rights granted under the Terms and Conditions of Use for Internet Shipping Application Program Interfaces and this document. All use of USPS Trademarks shall inure to the benefit of USPS.

开始

Administrative Steps

For each step described below, it is shown which of the APIs listed requires the action(s) in the step. Many of the steps apply to all APIs.

第 1 步：注册

Applicable APIs: 保留

To use the USPS Web Tools APIs, you must be a registered user. If you have not registered, go to http://zh.usps.com/webtools/ and follow the instructions to register for the APIs.

Upon completion of the registration process, your Web Tools USERID will be sent via email to the email address specified during registration. Please refer to the Restrictions on page 3 for an important notice regarding the use of your user ID.

API access and permissions are added separately after registration. Reference https://zh.usps.com/business/web-tools-apis/documentation-updates.htm underneath “API User Guides” for a complete list of APIs. To request access, send an email to webtools@usps.gov and specify in the subject line “Web Tools API Access Request”. Within the body of the email include the following information:

- USPS Web Tools USERID:

- USPS Mailer ID (MID): more information below*

- Company Website:

- List of API(s) for which you are requesting access:

- Expected volume per API: (i.e., peak daily, weekly, monthly, etc.)

- Are you a shipper or software provider?: Please provide details on how your business will use the APIs.

- If you are using a third-party software/software provider that necessitates a Web Tools credentials and API access, please specify the name of the third-party software.

- Any Additional Information you would like us to consider when evaluating your access request.

*Mailer ID Information: A mailer identification number (MID) is a 6 or 9-digit number assigned to a customer through the USPS Business Customer Gateway (BCG). Please refer to the following links for help.

https://gateway.usps.com/eAdmin/view/knowledge?securityId=MID

https://postalpro.usps.com/mailing/mailer-id

步骤 2: eVS Label API Permissions

Applicable APIs: eVS, eVSCertify, eVSCancel, eVSExpressMailIntl, eVSExpressMailIntlCertify, eVSPriorityMailIntl, eVSPriorityMailIntlCertify, eVSFirstClassMailIntl, eVSFirstClassMailIntlCertify, eVSICancel

The only option for creating outbound shipping labels through our APIs requires eVS setup/enrollment. The Electronic Verification System (eVS ®) is all about doing parcel business with the Postal Service using electronic technology. This manifesting system allows parcel mailers to document and pay postage by transmitting electronic manifest files to the eVS database, which is part of the PostalOne!® https://gateway.usps.com/eAdmin/view/signin system. In general, eVS:

- Requires 50 pieces or 50 pounds per mailing

- Requires a permit imprint

- Requires payment via ACH debit daily (no other forms of payment)

- Handles origin entered mail (no destination entry or presort)

- Requires enrollment and new Mailer IDs (MIDs) and permits

- Supports domestic/international/APO/FPO/DPO/PTFAS locations

- Supports Priority Mail Cubic (Contact your Technical Integration Specialist for further details)

For eVS registration, please visit https://zh.usps.com/postalone/evs.htm and see https://postalpro.usps.com/pub205 for the Electronic Verification System (eVS®) Business and Technical Guide. Contact eVS@usps.gov for support. If that will not work for you, then you can follow up with sales@usps.gov (or your local Postmaster or USPS Sales Manager) for additional solutions outside of the USPS Web Tools APIs.

第 3 步：Return Label APIs

Applicable APIs: USPSReturnsLabel, USPSReturnsLabelCertify

The Web Tools USPS Returns Label API enables customers to receive USPS Returns service labels which are processed using the new automated returns process via Package Platform. USPS Returns service account holders will pay postage and fees through an Enterprise Payment System (EPS) account so that items can be returned by their customers (at no charge to their customers) using merchant provided USPS Returns service labels. The API allows integrators to request USPS Returns service labels for items that can be mailed using Ground Advantage Return Service, Priority Mail Return Service, and Priority Mail Express Return Service. See https://zh.usps.com/business/return-services.htm for additional USPS Returns service details.

Initial onboarding will include:

- Package Platform enrollment

- USPS Returns enrollment

- EPS account enrollment for electronic funds transfer for payment of USPS Returns service postage

- USPS Web Tools API registration resulting in generation of Web Tools USERID.

- Mailer ID (MID) enrollment

- Customer Registration ID (CRID) enrollment

- Configuration of Destination Delivery Address (where applicable)

The USPS Returns Label API will support the following configuration options determined during initial customer onboarding:

- Non-manifesting (SSF) Option: Supports creation of returns label to a single delivery destination address configured per Web Tools USERID with the option of Signature Confirmation extra service. Unique ZIP4 for returns supported. 说明：The ability to generate returns labels to multiple delivery destinations requires separate Web Tools USERIDs for each destination address.

- Manifesting (SSF) Option: Supports creation of returns label to a configured delivery destination address with options for Signature Confirmation and Insurance extra services. Unique ZIP4 for returns supported. A Shipping Services File will be submitted by Web Tools for returns labels on behalf of the integrator.

- Manifesting (SSF) eFulfillment for Returns Option: Supports creation of returns label for eFulfillment returns customers to a delivery destination address collected in the API request with options for Signature Confirmation and Insurance extra services. A Shipping Services File will be submitted by Web Tools for returns labels on behalf of the integrator. 说明：The USPSReturnsLabel API will validate destination addresses provided by eFulfillment customers for a ZIP+4 or an error will return that includes an invalid ZIP+4.

第 4 步：Tracking API Permissions

Applicable APIs: TrackV2, PTSEmail, PTSPod, PTSTPod, PTSRre

The Track and Confirm Web Tools API provides tracking status and delivery information for USPS packages. The data returned by the Package Tracking Web Tools API is intended for display only. Submit your Package Tracking access request at https://usps.force.com/emailus/s/web-tools-inquiry and provide your Web Tools USERID. Select ‘Tracking APIs’ and ‘Access for Tracking APIs’ and paste the following information inside the Additional Information text box:

- Web Tools USERID:

- Mailer ID (MID): more information below*

- Company Name:

- Company Website:

- Requester First and Last Name:

- Requester Email:

- Requester Phone Number:

- Mailing Address:

- Mailing City:

- Mailing State:

- Mailing Zip Code:

- Web Tools Registration Date:

- API Access Requested: Package Tracking (API=TrackV2)

- Anticipated API volume: (note if daily, weekly, monthly, or annually)

- Shipping done with USPS: Please describe.

- Any additional information:

https://gateway.usps.com/eAdmin/view/knowledge?securityId=MID

https://postalpro.usps.com/mailing/mailer-id

Please note set up of your MID must be completed prior to granting access. Please contact NCSC-Delivery Confirmation (Email: Delivery.confirmation@usps.gov; Phone: 1-877-264-9693, Option 1).

Four service APIs are offered in conjunction with the Package Tracking API: Track and Confirm by Email (PTSEmail), Proof of Delivery (PTSPod), Track Proof of Delivery (PTSTPod), and Return Receipt Electronic (PTSRre). If requesting access to these other APIs, please follow the above steps and be sure to identify your anticipated API request volume, mailer ID and how you will be utilizing the API.

The Track and Confirm by Email API allows the customer to submit their email address to be notified of current or future tracking activity. Proof of Delivery is a letter that includes the recipient's name and a copy of their signature. The Proof of Delivery API allows the customer to request proof of delivery notification via email. The Track Proof of Delivery API allows the customer to request proof of delivery notification via email. The Return Receipt Electronic API allows the customer to request a copy of the proof of delivery record via email. Track Proof of Delivery is a letter that includes the recipient's name and a copy of their signature.

步骤 5: Run XML and Integrate.

Applicable APIs: 保留

At this point, you have completed all required initiation steps and are now ready to send data to Web Tools servers and begin the full API service. The Web Tools User's Guide for the API you are using will have XML schema information.

For expanded functional testing support of the Web Tools APIs in the testing/staging environment, users should contact USPS Internet Customer Care Center at https://emailus.usps.com/s/web-tools-inquiry and select ‘API Authorization and Testing’ and then ‘Staging/Testing Access’.

Staging/Testing endpoint: https://stg-secure.shippingapis.com/shippingapi.dll

Production endpoint: https://secure.shippingapis.com/shippingapi.dll

Administrative Forms

The following forms are provided in this section:

1. Licensing Agreement for the API Connector Code

Print the Licensing Agreement and email the completed agreement to https://Emailus.usps.com/.

2. USPS API Printer Certification Submission Form

Print and complete the Printer Certification Submission form and mail, along with the ten barcoded labels, to:

National Customer Support Center

收件人：Barcode Certification - Web Tools (API)

United States Postal Service

225 N Humphreys Blvd Ste 501

Memphis, TN 38188-1001

You can either print the form from this PDF file and fill out with a pen or copy the form to a Microsoft Word file and fill out electronically before printing and signing.

重要：When printing PDF files with barcodes, be sure that the "Fit to Page” option in the print dialogue box of Adobe Acrobat Reader is unchecked.

Technical Instructions

Client Protocols

HTTPS protocols are used for exchange of data. Requests for Web Tools APIs are sent to a secure server group using a URL of the form:

https://secure.shippingaps.com/ShippingAPI.dll?

API=APINAME&XML=<APINAMERequest USERID="Your account" PASSWORD="Your account password">

Label API users must include the PASSWORD field with the USERID in the XML request otherwise an error will return. Web Tools PASSWORDs are 15 characters. Current integrators are strongly encouraged to provide this information for all APIs in advance of future changes to avoid any service disruptions or integration issues.

Coding to utilize TCP/IP sockets can also provide a basis for a solution though it should be considered only for extreme processing conditions.

Other options are Java objects and Microsoft ActiveX objects that are documented and robust enough for production use. For Java, please reference the Apache Jakarta Project at https://jakarta.apache.org/. For Microsoft, reference material for Windows HTTP Services can be located at https://learn.microsoft.com/.

XML Overview

The exchanges presented in this document are presented in XML, since that is how the actual data will be structured and transmitted, and it is also a convenient method to document this interface. XML uses a hierarchical (tree) element structure. Each element consists of a start tag of the form <Name>, and an end tag of the form </Name>, between which can be data and other elements. <Name/> is shorthand for <Name></Name>, an element with no data. Attributes such as USERID and PASSWORD can be included with the start tag. All data and attribute values in this document are for illustration purposes and are to be replaced by the actual values. Developers must use the order and case for tag names of the sample code contained in this document. However, the Tabs and Carriage Returns in the XML structures are for readability only; there is no need for white space in the actual transmissions.

The XML API offers an interface that enables both request(s) and responses to be fully structured. As shown in the following example, XML’s set of self-defining tags allows multiple packages to be tracked with a single request. The ID field is used to match a particular entity in the request with the corresponding entity in the response.

For the latest information on XML from Microsoft and other leading vendors, browse:

· http://www.w3.org/XML

· http://www.xml.com

Software Development

An API request is the start of a transaction that concludes when the response is returned. Every request is stateless, and no cookies or URL rewrites are used during the exchange. The easiest model to describe is that a request behaves like an HTML page with a <FORM> submission. An example of this looks as such:

<BODY>

</FORM>

</BODY>

</HTML>

The web servers will accept either GET* or POST http requests.

The return content is XML structured data. Refer to the Apache XML web site at http://xml.apache.org/ for further information on character encodings and characteristics. A return will have this form (formatted for readability):

<?XML version=“1.0” ?>
<APINAMEResponse>

<tag>return data</tag><tag1>additional</tag1>

</APINAMEResponse>

All request and response tags are case sensitive and misspelled tags will generate errors. In addition, order is important because the coordination of some requests require specific tags in a specific order.

Label requests return the label in the requested format encoded as base64 text within the XML. Microsoft XML Core Services can be used to decode the text stream into a binary representation of the requested image. Currently decoding will generate a TIFF (Tagged Information File Format with CCITT group4 compression) or a PDF (http://www.adobe.com/).

*注意： GET http requests have length restrictions, whereas POST http requests do not. Please take this under consideration when determining the request-response method that you choose.

Error Handling

When an error condition exists, a specific XML return is generated. The following example shows the tags that are returned:

<?xml version=“1.0” encoding=“UTF-8”?>
<Error>
<Number>-2147217951</Number>
<Source>EMI_Respond :EMI:clsEMI.ValidateParameters:
clsEMI.ProcessRequest;SOLServerIntl.EMI_Respond</Source>
<Description>Missing value for To Phone number.</Description>
<HelpFile></HelpFile>
<HelpContext>1000440</HelpContext>
</Error>

For APIs that can handle multiple transactions, the error conditions for requests for multiple responses to be returned together are handled at the response level. 例如：a request for rates for two packages. If the addresses are non-existent, an “Error document” is returned to the user. On the other hand, if the address for the first package is acceptable but not the second, the response document contains the information for the first address, but under the XML tag for the second address there is an error tag.

Errors that are further down in the hierarchy also follow the above format.

There is not a compendium of error messages or states that is available. The <Description> tag has the identified problem and should be used to diagnosis the situation. Problems can arise even after thoroughly testing an application because of changes to USPS rates, policies or procedures may be implemented periodically may generate errors that didn’t occur previously. If a request to the Internet Customer Care Center (ICCC) is made for help with diagnosing a problem, please have both the response XML and the request XML available.

测试

There is no capacity for load testing in the USPS Web Tools infrastructure. Any account performing capacity/stress testing without prior authorization may be terminated.

A minimal testing function is available for client applications. Some APIs have canned tests that use an explicit XML request and allow for the testing of general programming techniques. As these tests are explicit, they are identified as available only for selected APIs. Processing returns, errors, and parsing techniques can be programmatically done using these canned test scenarios.

There are categories of APIs that provide repeatable responses such as the domestic and international rates APIs or address verification. These APIs are the easiest to use because of the small number of tags. These APIs are included in the default permissions.

If there are questions relating testing options, contact USPS Internet Customer Care Center at https://emailus.usps.com/s/web-tools-inquiry.

Certify APIs

APIs that return printed labels or barcodes become available after applying for advanced permissions from the USPS APIs Functional Team. To test label accuracy, a label certification API is available for each label type. These certify APIs can also be used for limited testing because “live” labels are not generated.

Any Web Tools API that contains "Certify" is for testing purposes and will not generate usable labels or tracking numbers. A printed Certify labels will have a "SAMPLE" watermark. To generate a real label and tracking number, you must remove "Certify" from your Web Tools API requests. Integrators should note that our Certify APIs are intended for limited functional verification of API requests and responses. Any secondary processes, such as the creation of a SCAN Form or Shipping Services File, is not supported by Certify APIs.

Web Tools API Examples

The XML request and response samples below illustrate API inputs and outputs for the purpose of illustrating the function of each API.

Replace the USERID and PASSWORD values with the information received from the registration process.

Address Info

Sample Request #1 – Verify

This API collects, “cleanses” an address, and completes the ZIP Code to validate and standardize an address before shipping with USPS.

https://secure.shippingapis.com/ShippingAPI.dll?API=Verify

&XML=<AddressValidateRequest USERID="xxxxxxx" PASSWORD="">

<City>Greenbelt</City>

</Address>

</AddressValidateRequest>

<City>GREENBELT</City>

<ReturnText>Default address: The address you entered was found but more information is needed (such as an apartment, suite, or box number) to match to a specific address.</ReturnText>

</Address>

Sample Request #2 – City State Lookup

This API is used to find the City and State associated with a ZIP Code.

https://secure.shippingapis.com/ShippingAPI.dll?API=CityStateLookup
&XML=<CityStateLookupRequest USERID="xxxxxxx" PASSWORD="">

</ZipCode>

</CityStateLookupRequest>

</ZipCode>

</CityStateLookupResponse>

Sample Request #3 – City State Lookup

This API will return associated City and State for given ZIP Codes.

https://secure.shippingapis.com/ShippingAPI.dll?API=CityStateLookup

&XML=<CityStateLookupRequest USERID="xxxxxxx" PASSWORD="">

</ZipCode>

</ZipCode>

</ZipCode>

</CityStateLookupRequest>

<City>GREENBELT</City>

</ZipCode>

</ZipCode>

</ZipCode>

</CityStateLookupResponse>

包裹跟踪

Sample Request #1

This request returns the package tracking status for a given barcode. 说明：access to this API requires additional approval.

https://secure.shippingapis.com/ShippingAPI.dll?API=TrackV2
&XML=<TrackRequest USERID="xxxxxxx" PASSWORD="">

</TrackRequest>

<TrackSummary>Your item was delivered at 8:10 上午 on June 1 in Wilmington DE 19801.</TrackSummary>

<TrackDetail>May 30 11:07 上午 NOTICE LEFT WILMINGTON DE 19801.</TrackDetail>

<TrackDetail>May 30 10:08 上午 ARRIVAL AT UNIT WILMINGTON DE 19850.</TrackDetail>

<TrackDetail>May 29 9:55 上午 ACCEPT OR PICKUP EDGEWATER NJ 07020.</TrackDetail>

</TrackInfo>

</TrackResponse>

Domestic Price Calculator – RateV4 API

Sample Request #1

https://secure.shippingapis.com/ShippingAPI.dll?API=RateV4

&XML=<RateV4Request USERID="xxxxxxx" PASSWORD="">

<Service>USPS ADVANTAGE</Service>

<Container>VARIABLE</Container>

</Package>

</RateV4Request>

<Container>VARIABLE</Container>

<MailService>USPS Ground Advantage<sup>™</sup></MailService>

<ServiceName>Adult Signature Required</ServiceName>

</SpecialService>

<ServiceName>Adult Signature Restricted Delivery</ServiceName>

</SpecialService>

<ServiceName>Certified Mail<sup>®</sup> Adult Signature Required</ServiceName>

</SpecialService>

<ServiceName>Certified Mail<sup>®</sup> Adult Signature Restricted Delivery</ServiceName>

</SpecialService>

<ServiceName>Collect on Delivery</ServiceName>

<DueSenderRequired>false</DueSenderRequired>

</SpecialService>

<ServiceName>Collect on Delivery Restricted Delivery</ServiceName>

<DueSenderRequired>false</DueSenderRequired>

</SpecialService>

<ServiceName>Insurance</ServiceName>

<DueSenderRequired>false</DueSenderRequired>

</SpecialService>

<ServiceName>Insurance Restricted Delivery</ServiceName>

<DueSenderRequired>false</DueSenderRequired>

</SpecialService>

<ServiceName>Registered Mail<sup>™</sup></ServiceName>

<DueSenderRequired>false</DueSenderRequired>

</SpecialService>

<ServiceName>Registered Mail<sup>™</sup> Restricted Delivery</ServiceName>

<DueSenderRequired>false</DueSenderRequired>

</SpecialService>

<ServiceName>Scan Retention</ServiceName>

</SpecialService>

<ServiceName>USPS Label Delivery Service</ServiceName>

</SpecialService>

<ServiceName>Signature Confirmation<sup>™</sup></ServiceName>

</SpecialService>

<ServiceName>Signature Confirmation<sup>™</sup> Restricted Delivery</ServiceName>

</SpecialService>

<ServiceName>Signature Confirmation<sup>™</sup> Electronic</ServiceName>

</SpecialService>

<ServiceName>Signature Confirmation<sup>™</sup> Electronic Restricted Delivery</ServiceName>

</SpecialService>

<ServiceName>USPS Tracking<sup>®</sup></ServiceName>

</SpecialService>

<ServiceName>USPS Tracking<sup>®</sup> Electronic</ServiceName>

</SpecialService>

</SpecialServices>

</Postage>

</Package>

</RateV4Response>Sample Request #2

https://secure.shippingapis.com/ShippingAPI.dll?API=RateV4
&XML=<RateV4Request USERID="xxxxxxx" PASSWORD="">

<Container>VARIABLE</Container>

<ReturnLocations>false</ReturnLocations>

<ReturnServiceInfo>false</ReturnServiceInfo>

<ReturnFees>false</ReturnFees>

</Package>

</RateV4Request>

<MailService>Parcel Select Destination Entry Machinable DDU HAZMAT</MailService>