Introduction to Web Tools

This document contains a Reference Guide to the USPS Tracking/Delivery Confirmation Label APIs. See the Developer’s Guide to learn the administrative process for gaining access to the Web Tools APIs as well as the basic mechanism for calling the APIs and processing the results. The Developer’s Guide also contains information on testing and trouble-shooting.

Note: The Request Parameter sections present the XML input tags for generating live requests along with the restrictions on the values allowed. An error message will be returned if an incorrect value is entered.? Also, be aware of the maximum character amounts allowed for some tags.? If the user enters more than those amounts, an error will not be generated. The Web Tool will simply pass in the characters up to the maximum amount allowed and disregard the rest.? This is important since the resulting value could prevent a correct response.

When building the XML request, pay particular attention to the order and case for tags. An error message will be returned if an incorrect value is entered.? Remember that all data and attribute values in this document are for illustration purposes and are to be replaced by your actual values. For instance, a line of sample code may be:

<TrackID> EJ123456780US </TrackID>

In this instance, you will replace “EJ123456780US” with the tracking ID for the package.

Before you get started:

For information on registering and getting started with Web Tools, please refer to the Step-By-Step guide found on the Technical Documentation section of the Web Tools page on usps.com/webtools.

Access to the USPS Tracking API is granted upon registration but the remaining APIs in this guide required additional access. Contact the Internet Customer Care Center at uspstechnicalsupport@mailps.custhelp.com to request access. Indicate “Specialty Tracking API Access” in the subject line and explain in the body of the email.

USPS Tracking API

Overview

The Track/Confirm Web Tool lets customers determine the delivery status of their Priority Mail, Express Mail, and Package Services (Standard Post, Bound Printed Matter, Library Mail, and Media Mail) packages with Delivery Confirmation.? It will also provide tracking data right from your web site, without making your customer go to the USPS web site.? Additionally, the Track/Confirm Web Tool can be appended to your Intranet, allowing, for example, a customer service representative to answer customer queries about the status of their shipments.? The Web Tool Server returns tracking and/or delivery confirmation information for packages requested by the client.? The Track/Confirm Web Tool limits the data requested to ten (10) packages per transaction.

Note: The data returned by the Track/Confirm Web Tool is intended for display only.? The content or sequence of the string data returned by the Web Tool may change.? Consequently, if you desire to apply any kind of logic against the tracking data, then you will need to use the Track/Confirm Fields Web Tool.

API Signature

Note: The “stg-production.shippingapis.com” signature host is for testing purposes. If you experience any issues connecting to this test server, please contact our helpdesk at uspstechnicalsupport@mailps.custhelp.com.

Request Description

Sample Request and Response

?

Track/Confirm Fields API

The Track/Confirm Fields request is identical to the Track/Confirm request except for the request name and the return information.? Data returned still contains the detail and summary information, but this information is broken down into fields instead of having only one line of text.? Up to 10 tracking IDs may be contained in each request input to the Web Tool server.

API Signature

Note: The “stg-production.shippingapis.com” signature host is for testing purposes. If you experience any issues connecting to this test server, please contact our helpdesk at uspstechnicalsupport@mailps.custhelp.com

Request Description

?

Sample Requests

Response Description

Response Description (Revision = 1)

Sample Response

?

?

Tracking Service APIs

Four service APIs are offered in conjunction with “Revision = 1” of the Track/Confirm Fields Web Tool: Track and Confirm by Email, Proof of Delivery, Return Receipt Electronic and Restore for tracking information.? The response data from Track/Confirm Fields request determines which services are available for a tracking ID.? Each request input to the Web Tool server for the tracking service APIs is limited to 1 tracking ID.

These APIs are restricted to USPS internal use only.

Track and Confirm by Email 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.

The table below presents the XML input tags for generating Live requests and the restrictions on the values allowed.? An error message will be returned if an incorrect value is entered.? Also, be aware of the maximum character amounts allowed for some tags.? If the user enters more than those amounts, an error will not be generated.? The Web Tool will simply pass in the characters up to the maximum amount allowed and disregard the rest.? This is important since the resulting value could prevent a correct response.

When building the XML request, pay particular attention to the order and case for tags.? An error message will be returned if an incorrect value is entered.? Remember that all data and attribute values in this document are for illustration purposes and are to be replaced by your actual values.? For instance, a line of sample code may be:

<TrackID> EJ123456780US </TrackID>

In this instance, you will replace “EJ123456780US” with the tracking ID for the package.

API Signature

Note: The “stg-production.shippingapis.com” signature host is for testing purposes. If you experience any issues connecting to this test server, please contact our helpdesk at uspstechnicalsupport@mailps.custhelp.com

Request Description

Sample Request and Response

?

Proof of Delivery API

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.

Proof of Delivery Request

The table below presents the XML input tags for generating Live requests and the restrictions on the values allowed.? An error message will be returned if an incorrect value is entered.? Also, be aware of the maximum character amounts allowed for some tags.? If the user enters more than those amounts, an error will not be generated.? The Web Tool will simply pass in the characters up to the maximum amount allowed and disregard the rest.? This is important since the resulting value could prevent a correct response.

When building the XML request, pay particular attention to the order and case for tags.? An error message will be returned if an incorrect value is entered.? Remember that all data and attribute values in this document are for illustration purposes and are to be replaced by your actual values.? For instance, a line of sample code may be:

<TrackID> EJ123456780US </TrackID>

In this instance, you will replace “EJ123456780US” with the tracking ID for the package.

API Signature

Note: The “stg-production.shippingapis.com” signature host is for testing purposes. If you experience any issues connecting to this test server, please contact our helpdesk at uspstechnicalsupport@mailps.custhelp.com

?

Request Description

Sample Requests and Response

Return Receipt Electronic API

The Return Receipt Electronic API allows the customer to request a copy of the proof of delivery record via email.

Return Receipt Electronic Request

The table below presents the XML input tags for generating Live requests and the restrictions on the values allowed.? An error message will be returned if an incorrect value is entered.? Also, be aware of the maximum character amounts allowed for some tags.? If the user enters more than those amounts, an error will not be generated.? The Web Tool will simply pass in the characters up to the maximum amount allowed and disregard the rest.? This is important since the resulting value could prevent a correct response.

When building the XML request, pay particular attention to the order and case for tags.? An error message will be returned if an incorrect value is entered.? Remember that all data and attribute values in this document are for illustration purposes and are to be replaced by your actual values.? For instance, a line of sample code may be:

<TrackID> EJ123456780US </TrackID>

In this instance, you will replace “EJ123456780US” with the tracking ID for the package.

API Signature

Note: The “stg-production.shippingapis.com” signature host is for testing purposes. If you experience any issues connecting to this test server, please contact our helpdesk at uspstechnicalsupport@mailps.custhelp.com

Request Description

Sample Request and Response

?

Restore API

The Restore API allows the customer to restore tracking information from the archives.

Restore Request

The table below presents the XML input tags for generating Live requests and the restrictions on the values allowed.? An error message will be returned if an incorrect value is entered.? Also, be aware of the maximum character amounts allowed for some tags.? If the user enters more than those amounts, an error will not be generated.? The Web Tool will simply pass in the characters up to the maximum amount allowed and disregard the rest.? This is important since the resulting value could prevent a correct response.

When building the XML request, pay particular attention to the order and case for tags.? An error message will be returned if an incorrect value is entered.? Remember that all data and attribute values in this document are for illustration purposes and are to be replaced by your actual values.? For instance, a line of sample code may be:

<TrackID> EJ123456780US </TrackID>

In this instance, you will replace “EJ123456780US” with the tracking ID for the package.

API Signature

Note: The “stg-production.shippingapis.com” signature host is for testing purposes. If you experience any issues connecting to this test server, please contact our helpdesk at uspstechnicalsupport@mailps.custhelp.com

Request Description

Sample Request and Response

?

RRAM API

The Return Receipt After Mailing API allows the customer to receive a delivery record of an item after the item has been mailed. Current customers must request and purchase a return receipt (POD Letter) after mailing at the Post Office. This ability will provide an additional access channel for customers to request RRAM online through the USPS Tracking website.

Restore Request

The table below presents the XML input tags for generating Live requests and the restrictions on the values allowed.? An error message will be returned if an incorrect value is entered.? Also, be aware of the maximum character amounts allowed for some tags.? If the user enters more than those amounts, an error will not be generated.? The Web Tool will simply pass in the characters up to the maximum amount allowed and disregard the rest.? This is important since the resulting value could prevent a correct response.

When building the XML request, pay particular attention to the order and case for tags.? An error message will be returned if an incorrect value is entered.? Remember that all data and attribute values in this document are for illustration purposes and are to be replaced by your actual values.? For instance, a line of sample code may be:

<TrackID> EJ123456780US </TrackID>

In this instance, you will replace “EJ123456780US” with the tracking ID for the package.

API Signature

Note: The “stg-production.shippingapis.com” signature host is for testing purposes. If you experience any issues connecting to this test server, please contact our helpdesk at uspstechnicalsupport@mailps.custhelp.com

?

Request Description

Sample Request and Response

Error Responses

Error conditions are handled at the main XML document level.? When parsing, it is best to check for an error document first before checking for good data.? Error documents have the following format:

<Error>

<Number></Number>

<Source></Source>

<Description></Description>

<HelpFile></HelpFile>

<HelpContext></HelpContext>

</Error>

Where:

• Number = the error number generated by the Web Tools server.
• Source = the component and interface that generated the error on the Web Tools server.
• Description = the error description.
• HelpFile = [reserved for future use].
• HelpContext = [reserved for future use].

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

An <Error> element may be returned at the top (response) level if there is a problem with the syntax of the request, or if a system error occurs.

?

If you need assistance with an error response, contact the Internet Customer Care Center uspstechnicalsupport@mailps.custhelp.com
测试返回结果

string(1292) "<?xml version="1.0" encoding="UTF-8"?>
<TrackResponse><TrackInfo ID="LS26111008622CN"><TrackSummary>Your item was delivered to the front desk or reception area at 12:35 pm on November 25, 2015 in OLYMPIA, WA 98516.</TrackSummary><TrackDetail>Out for Delivery, November 25, 2015, 6:56 am, OLYMPIA, WA 98516</TrackDetail><TrackDetail>Sorting Complete, November 25, 2015, 6:46 am, OLYMPIA, WA 98516</TrackDetail><TrackDetail>Arrived at Unit, November 25, 2015, 4:30 am, LACEY, WA 98503</TrackDetail><TrackDetail>Departed USPS Facility, November 25, 2015, 1:23 am, FEDERAL WAY, WA 98003</TrackDetail><TrackDetail>Arrived at USPS Destination Facility, November 24, 2015, 8:46 pm, FEDERAL WAY, WA 98003</TrackDetail><TrackDetail>Departed USPS Facility, November 22, 2015, 11:24 pm, SAN FRANCISCO, CA 94128</TrackDetail><TrackDetail>Arrived at USPS Facility, November 22, 2015, 9:02 am, SAN FRANCISCO, CA 94128</TrackDetail><TrackDetail>Processed Through Sort Facility, November 22, 2015, 7:53 am, ISC SAN FRANCISCO (USPS)</TrackDetail><TrackDetail>Processed Through Sort Facility, November 19, 2015, 6:11 pm, FUZHOU EMS, CHINA</TrackDetail><TrackDetail>Origin Post is Preparing Shipment</TrackDetail><TrackDetail>Acceptance, November 18, 2015, 8:56 pm, CHINA</TrackDetail></TrackInfo></TrackResponse>"
array(1) {
  ["TrackResponse"]=>
  array(1) {
    ["TrackInfo"]=>
    array(2) {
      ["TrackSummary"]=>
      string(114) "Your item was delivered to the front desk or reception area at 12:35 pm on November 25, 2015 in OLYMPIA, WA 98516."
      ["TrackDetail"]=>
      array(11) {
        [0]=>
        string(63) "Out for Delivery, November 25, 2015, 6:56 am, OLYMPIA, WA 98516"
        [1]=>
        string(63) "Sorting Complete, November 25, 2015, 6:46 am, OLYMPIA, WA 98516"
        [2]=>
        string(60) "Arrived at Unit, November 25, 2015, 4:30 am, LACEY, WA 98503"
        [3]=>
        string(73) "Departed USPS Facility, November 25, 2015, 1:23 am, FEDERAL WAY, WA 98003"
        [4]=>
        string(87) "Arrived at USPS Destination Facility, November 24, 2015, 8:46 pm, FEDERAL WAY, WA 98003"
        [5]=>
        string(76) "Departed USPS Facility, November 22, 2015, 11:24 pm, SAN FRANCISCO, CA 94128"
        [6]=>
        string(77) "Arrived at USPS Facility, November 22, 2015, 9:02 am, SAN FRANCISCO, CA 94128"
        [7]=>
        string(85) "Processed Through Sort Facility, November 22, 2015, 7:53 am, ISC SAN FRANCISCO (USPS)"
        [8]=>
        string(78) "Processed Through Sort Facility, November 19, 2015, 6:11 pm, FUZHOU EMS, CHINA"
        [9]=>
        string(33) "Origin Post is Preparing Shipment"
        [10]=>
        string(45) "Acceptance, November 18, 2015, 8:56 pm, CHINA"
      }
    }
  }
}

备注 ?由中国发出邮件 可通过EMS 查询

转载请注明：(●--●) Hello.My Weicot » Usps 快递API文档 最新版