Track & Confirm

API
USPS Web Tools™
Application Programming Interface
User Guide
Version 4.7 (10/07/2024)
USPS Web Tools User Guide

Table of Contents
1.0 Introduction .................................................................................................................................... 4
1.1 Before you get started: ................................................................................................................ 4
1.2 Tracking Service APIs ................................................................................................................. 4
2.0 Package Track API ......................................................................................................................... 5
2.1 Overview ...................................................................................................................................... 5
2.1.1 API Signature Table ................................................................................................................ 5
2.2 Request Descriptions ................................................................................................................... 6
2.2.1 Sample Request ...................................................................................................................... 6
2.3 Response Descriptions ................................................................................................................ 6
2.3.1 Sample Response ................................................................................................................... 7
3.0 Package Tracking “Fields” API .................................................................................................... 8
3.1 Overview ...................................................................................................................................... 8
3.1.1 API Signature .......................................................................................................................... 8
3.2 Request Descriptions ................................................................................................................... 8
3.2.1 Sample Request ...................................................................................................................... 9
3.2 Response Descriptions .............................................................................................................. 10
3.3.2 Sample Response ................................................................................................................. 18
4.0 Track and Confirm by Email API ................................................................................................ 21
4.1 Overview .................................................................................................................................... 21
4.1.1 API Signature ........................................................................................................................ 21
4.2 Request Descriptions ................................................................................................................. 21
4.2.1 Sample Request .................................................................................................................... 23
4.3 Response Descriptions .............................................................................................................. 23
4.3.1 Sample Response ................................................................................................................. 24
5.0 Proof of Delivery API ................................................................................................................... 24
5.1 Overview .................................................................................................................................... 24
5.1.1 API Signature ........................................................................................................................ 24
5.2 Request Descriptions ................................................................................................................. 24
5.2.1 Sample Request .................................................................................................................... 26
5.3 Response Descriptions .............................................................................................................. 27
5.3.1 Sample Response ................................................................................................................. 27
6.0 Return Receipt Electronic API .................................................................................................... 27
6.1 Overview .................................................................................................................................... 27
6.1.1 API Signature ........................................................................................................................ 27

2
USPS Web Tools User Guide

6.2 Request Descriptions ................................................................................................................. 28

6.2.1 Sample Request .................................................................................................................... 29
6.3 Response Descriptions .............................................................................................................. 29
6.3.1 Sample Response ................................................................................................................. 30
7.0 Track Proof of Delivery API ......................................................................................................... 30
7.1 Overview .................................................................................................................................... 30
7.1.1 API Signature ........................................................................................................................ 30
7.2 Request Descriptions ................................................................................................................. 30
7.2.1 Sample Request .................................................................................................................... 32
7.3 Response Descriptions .............................................................................................................. 32
7.3.1 Sample Response ................................................................................................................. 32

3
USPS Web Tools User Guide

1.0 Introduction
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 troubleshooting.
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. Web Tools 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.

1.1 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 Web Tools Technical Documentation Page.

1.2 Tracking Service APIs

To obtain Package Tracking API (API=TrackV2) access, users will need to follow the below steps.

1. Register for Web Tools at https://registration.shippingapis.com/.

2. Obtain a valid registered mailer identification number (MID). This 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.
o https://gateway.usps.com/eAdmin/view/knowledge?securityId=MID
o https://postalpro.usps.com/mailing/mailer-id
Important Note: Set up of your MID must be completed prior to requesting access or your
request will be rejected. Please contact the NCSC-Delivery Confirmation (email:
[email protected]; phone: 1-877-264-9693, Option 1) for assistance.
3. Once the above steps are completed 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’, select ‘Access for Tracking APIs’ and submit the following information below in
the “Additional Information” text box:
• Web Tools USERID:
• Mailer ID (MID):
• Company Name:
• Company Website:
• Requester First and Last Name:
• Requester Email:
• Requester Phone Number:

4
USPS Web Tools User Guide

• Mailing Address:
• Mailing City:
• Mailing State:
• Mailing Zip Code:
• Web Tools Registration Date:
• API access requested: Package Tracking (API=TrackV2)
• Anticipated volume: (daily, weekly, monthly, or annually)
• Shipping done with USPS: Please describe.
• Any additional information:
Four service APIs are offered in conjunction with “Revision=1” of the Package Tracking “Fields” API:
Track and Confirm by Email (PTSEmail), Proof of Delivery (PTSPod), Track Proof of Delivery (PTSTPod),
and Return Receipt Electronic (PTSRre). The response data from Track/Confirm Fields request
determines which services are available for a tracking ID. Each request input to the Web Tools server for
the tracking service APIs is limited to one tracking ID. These APIs require additional permissions and in
order to gain access follow the above steps.

2.0 Package Track API

2.1 Overview
The Track/Confirm Web Tools API provides tracking status and delivery information for USPS packages.
The Track/Confirm API limits the data requested to thirty-five (35) packages per transaction.
Note: The data returned by the Package Track Web Tools API is intended for display only. The content or
sequence of the String data returned by the API 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.

2.1.1 API Signature Table

Scheme Host Path API XML

https:// secure.shippingapis.com /ShippingAPI.dll? API=TrackV2 &XML=(see below)

5
USPS Web Tools User Guide

2.2 Request Descriptions

Tag Name Occurs Descriptions Type Validation

TrackRequest Required API=TrackV2 (Alias)

This attribute specifies your Web
TrackRequest / Required NMTOKEN
Tools user ID. See the Developer's
USERID
Guide for information on obtaining
your USERID.
For Example: USERID="XXXXXXX"
This attribute specifies your Web
TrackRequest / Optional NMTOKEN
Tools password. See the
PASSWORD
Developer's Guide for information
on your Password.
For Example:
PASSWORD="XXXXXXX"

TrackRequest / Required Must be alphanumeric characters. String minOccurs="1"

TrackID
For example: <TrackID
ID="EJ123456780US">
</TrackID>

2.2.1 Sample Request

Request: Package Track
<TrackRequest USERID="XXXXXXXXX" PASSWORD="">
<TrackID ID="XXXXXXXXXXX1"></TrackID>
<TrackID ID="XXXXXXXXXXX2"></TrackID>
</TrackRequest>

2.3 Response Descriptions

Tag Name Occurs Descriptions Type Validation

TrackResponse Required (Alias)

TrackResponse / Required (Group)

TrackInfo
max 10

TrackResponse / Required Tracking ID Token

TrackInfo ID

TrackResponse / Optional String minOccurs="0"

TrackInfo /
DeliveryNotificationDate

6
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

TrackResponse / Optional Expected delivery date String minOccurs="0"

TrackInfo /
ExpectedDeliveryDate

TrackResponse / Optional Expected Delivery Time String minOccurs="0"

TrackInfo /
ExpectedDeliveryTime

TrackResponse / Optional Guaranteed Delivery String minOccurs="0"

TrackInfo / Date: certain countries
GuaranteedDeliveryDate provide a guarantee
delivery
For Example: April 15,
2020
Or
3 Business Days

TrackResponse / Optional Summary of the status of String

TrackInfo / the shipment, ie In-
TrackSummary Transit, Delivered, etc.
For example: February 5
7:28 pm ENROUTE
33699

TrackResponse / Optional Scan statuses from points String minOccurs="0"

TrackInfo / TrackDetail in transit.

TrackResponse Required (Alias)

2.3.1 Sample Response

Response: Package Track
<TrackResponse>
<TrackInfo ID="XXXXXXXXXXX1">
<TrackSummary> Your item was delivered at 6:50 am on February 6 in BARTOW FL
33830.</TrackSummary>
<TrackDetail>February 6 6:49 am NOTICE LEFT BARTOW FL 33830</TrackDetail>
<TrackDetail>February 6 6:48 am ARRIVAL AT UNIT BARTOW FL 33830</TrackDetail>
<TrackDetail>February 6 3:49 am ARRIVAL AT UNIT LAKELAND FL 33805</TrackDetail>
<TrackDetail>February 5 7:28 pm ENROUTE 33699</TrackDetail>
<TrackDetail>February 5 7:18 pm ACCEPT OR PICKUP 33699</TrackDetail>
</TrackInfo>
<TrackInfo ID="XXXXXXXXXXX2">
<TrackSummary There is no record of that mail item. If it was mailed recently, It may not yet be tracked.
Please try again later. </TrackSummary>
</TrackResponse>

7
USPS Web Tools User Guide

3.0 Package Tracking “Fields” API

3.1 Overview
The Package Tracking “Fields” API is similar to the Package Track API except for the request fields, API
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 API request to the Web Tools server.
3.1.1 API Signature

Scheme Host Path API XML

https:// secure.shippingapis.com /ShippingAPI.dll? API=TrackV2 &XML=(see below)

3.2 Request Descriptions

Tag Name Occurs Descriptions Type Validation

TrackFieldRequest Required API=TrackV2 (Alias)

This attribute specifies your Web Tools user
TrackFieldRequest Required NMTOKE
ID. See the Developer’s Guide for
/ USERID N
information on obtaining your USERID.
For Example: USERID="XXXXXXX"
This attribute specifies your Web Tools
TrackFieldRequest Optional NMTOKE
password. See the Developer’s Guide for
/ PASSWORD N
information on your Password.
For Example: PASSWORD="XXXXXXX"

TrackFieldRequest Required This is for versioning of the API's and for Integer minOccurs="
/ Revision triggering response tags for future versions. 0"
In this API use a value of 1 to return all
available response tags and trigger new
functionality.
For example: <Revision>1</Revision>

TrackFieldRequest Optional User’s IP address. ClientIP is required when String minOccurs="

/ ClientIp <Revision>=1 0"
For example: <ClientIp>127.0.0.1</ClientIp>

Note: Web Tools will always collect the

physical IP address from the system
generating the API call. This will be passed
on the backend to a separate internal
package tracking system.

TrackFieldRequest Required External integrators should pass company String minOccurs="

/ SourceId name. SourceID is required when 0"
<Revision>=1.

8
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

For example: <SourceId>XYZ Pattern="[0-

Corp</SourceId> 9]{5}"

TrackFieldRequest Required Package Tracking ID. Must be alphanumeric String minOccurs="

/ TrackID characters. 1"
For example: <TrackID
ID="EJ123456780US"></TrackID>

TrackFieldRequest Optional 5-digit destination ZIP Code. String minOccurs="

/ TrackID / 0"
For example:
DestinationZipCode
<DestinationZipCode>12345</DestinationZip
Code>

TrackFieldRequest Optional Mailing date of package. Format: YYYY-MM- String minOccurs="

/ TrackID / DD 0"
MailingDate
For example: <MailingDate>2010-01-
01</MailingDate>

TrackFieldRequest Required API=TrackV2 (Alias)

3.2.1 Sample Request

Request: Track and Confirm
<TrackFieldRequest USERID="XXXXXXXXX" PASSWORD="">
<Revision>1</Revision>
<ClientIp>127.0.0.1</ClientIp>
<SourceId>XYZ Corp</SourceId>
<TrackID ID="xxxxxxxxxxxxxxxxxxx"/>
</TrackFieldRequest>

9
USPS Web Tools User Guide

3.2 Response Descriptions

Tag Name Occurs Descriptions Type Validation

The tracking number ID

TrackResponse / Required String
submitted through the
TrackInfo ID
request
For example:
EA123456795US
Optional Additional package
TrackResponse / String
information
TrackInfo / AdditionalInfo
Optional Additional ADP scripting
TrackResponse / String
specific to the ADP Type
TrackInfo / ADPScripting
code
Optional Information regarding
TrackResponse / String
availability of Restore
TrackInfo /
service function
ArchiveRestoreInfo
For example: Yes
Optional Additional Label on the mail
TrackResponse / String
piece
TrackInfo /
For example:
AssociatedLabel
EA123456785US
This is not currently
populated.
Optional True/False field indicating
TrackResponse / Boolea Enumerations
the item qualifies for the
TrackInfo / n =
customer to electronically
CarrierRelease
authorize shipment release. • True
• False
Optional Mail Class of the mail piece
TrackResponse / String
(human readable). This will
TrackInfo / Class
also include the service
standard message if it
exists.
Optional Mail Class of the mail piece
TrackResponse / String
(code). For example: EX,
TrackInfo /
PM, CP, IP
ClassofMailCode
Optional The destination city. For
TrackResponse / String
example: Rochester
TrackInfo /
DestinationCity
Optional The destination country
TrackResponse / String
code. For example: MX, CA
TrackInfo /
DestinationCountryCode
Optional The destination state. For
TrackResponse / String
example: NY
TrackInfo /
DestinationState

10
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

Optional The destination ZIP code.

TrackResponse / String
For example:20024
TrackInfo /
DestinationZip
Edited Label ID or Full Label
TrackResponse / Optional, String
ID. Used only when Source
TrackInfo / used only
ID is IVR For
EditedLabelID when
example:EA123456795US
Source ID
is IVR
Optional Signifies if USPS Tracking Enumeration
TrackResponse / Boolea
by Email service is enabled. • True
TrackInfo / n
EmailEnabled • False
Optional
TrackResponse / Populated with the end-of- String
TrackInfo / EndOfDay day time provided by TRP
when TRP API indicates the
window is “End of Day” or
when the piece is eligible for
the PTR default end of day.
For example: by 5:00pm
Note: an end of day
scenario occurs when the
TRP API response indicates
a 0 length window.
Optional Signifies if the mailpiece is Enumeration
TrackResponse / Boolea
eSOF eligibile. • True
TrackInfo / eSOFEligible n
• False
Optional Expected delivery date. For
TrackResponse / String
example:December 31,
TrackInfo /
2013
ExpectedDeliveryDate
Optional Expected Delivery Time. For
TrackResponse / String
example: 3:00 PM
TrackInfo /
ExpectedDeliveryTime
Optional Populates “Expected
TrackResponse / String
Delivery by” if there is an
TrackInfo /
EDD. For example:
ExpectedDeliveryType
Expected Delivery by
Optional Guaranteed Delivery Date:
TrackResponse / String
certain countries provide a
TrackInfo /
guaranteed delivery.
GuaranteedDeliveryDate
For example: April 15, 2011
or 3 Business Days
Optional Guaranteed Delivery Time
TrackResponse / String
provided for Priority Mail
TrackInfo /
Express. For example: 3:00
GuaranteedDeliveryTim
PM
e

11
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

Optional Populates “Scheduled

TrackResponse / String
Delivery by” if there is a
TrackInfo /
GDD. For example:
GuaranteedDeliveryTyp
Scheduled Delivery by
e
Optional Special messaging related
TrackResponse / String
to the guarantee. For
TrackInfo /
example: “Loss Only
GuaranteedDetails
Guarantee”
Optional Enumeration:
TrackResponse / Boolea
• True
TrackInfo / n
KahalaIndicator • False
Optional For internal USPS use only
TrackResponse / String
TrackInfo /
MailTypeCode
Optional Internal date stamp.
TrackResponse / String
2010-03-30
TrackInfo / MPDATE
19:30:48.224343
Optional Internal suffix.
TrackResponse / Integer
TrackInfo / MPSUFFIX
Optional Field indicating if the item Enumeration:
TrackResponse / Boolea
will be delivered on time as • True
TrackInfo / OnTime n
specified in the Expected or • False
Guaranteed delivery date.
Optional The origin city
TrackResponse / String
TrackInfo / OriginCity
Optional The origin country code
TrackResponse / String
TrackInfo /
OriginCountryCode
Optional The origin state
TrackResponse / String
TrackInfo / OriginState
Optional The origin ZIP code
TrackResponse / String
TrackInfo / OriginZip
Optional Predicted delivery date.
TrackResponse / String
December 30, 2013
TrackInfo /
PredictedDeliveryDate
Optional Predicted Delivery Time
TrackResponse / String
3:00 PM or blank.
TrackInfo /
PredictedDeliveryTime
Optional Populates “Expected
TrackResponse / String
Delivery ‘by or on’”, if the
TrackInfo /
source of the PDD is TRP
PredictedDeliveryType
API.

12
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

Populates “Expected
Delivery on” if the source of
the PDD is a PTR calculated
date.
For example: Expected
Delivery by or Expected
Delivery on
Optional States which system
TrackResponse / String
provided the Predicted
TrackInfo /
Delivery prediction.
PredictedDeliverySource
TRP, AA
Optional Predicted Delivery Window
TrackResponse / String
start time in am/pm format.
TrackInfo / PDWStart
In an EndOfDay scenario,
the PDWStart tag is null.
11:00am
For example: (null)
Optional Predicted Delivery Window
TrackResponse / String
end time in am/pm format.
TrackInfo / PDWEnd
In an EndOfDay scenario,
the PDWEnd tag is null.
1:00pm
For example: (null)
Optional Contains the Purge By Date
TrackResponse / String
of the mail piece.
TrackInfo / PurgeByDate
Example: December 31,
2024
Optional The related label ID
TrackResponse / String
between a tracking barcode,
TrackInfo / RelatedRRID
the core product, and a
PS3811, Green Card Return
Reciept. This field can
contain either the core
product label ID or the
Green Card label ID. There
is only a one to one
relationship.
Core Product ID:
EA123456795US
Or Green Card ID;
9590940112345671234567
Optional Signifies if Restore tracking Enumeration:
TrackResponse / Boolea
information service is • True
TrackInfo / n
RestoreEnabled
enabled • False
Optional Field indicating the date the
TrackResponse / String
item will be Returned to
TrackInfo /
Sender.
ReturnDateNotice

13
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

Optional Signifies if Proof of Delivery Enumeration:

TrackResponse / Boolea
service is enabled. • True
TrackInfo / PodEnabled n
• False
Optional Signifies if Tracking Proof of Enumeration=
TrackResponse / Boolea
Delivery service is enabled • True
TrackInfo / TpodEnabled n
• False
Optional Signifies if RRAM service is Enumeration:
TrackResponse / Boolea
enabled • True
TrackInfo / n
RramEnabled • False
Optional Signifies if Return Receipt Enumeration:
TrackResponse / Boolea
Electronic service is enabled • True
TrackInfo / RreEnabled n
• False
Optional Additional services
TrackResponse / String
Unbounde purchased
TrackInfo / Service
d

Optional Service Type Code of the

TrackResponse / String
max 1 mail piece
TrackInfo /
M, AD, VI, 03, 70, 716
ServiceTypeCode
Optional For example: Delivered
TrackResponse / String
TrackInfo / Status
Optional For example: In Transit
TrackResponse / String
TrackInfo /
StatusCategory
Optional Status summary
TrackResponse / String
For example: Your item was
TrackInfo /
delivered at 12:55 pm on
StatusSummary
April 05, 2010 in
FALMOUTH, MA 02540
Optional Internal description of mail
TrackResponse / String
piece as it relates to PTR
TrackInfo / TABLECODE
(live, history, or archived
piece) T, H, A (CMC830 V3
– T is the only value
defined)
Optional Value of Article for when the
TrackResponse / String
Source ID is PIN
TrackInfo /
ValueofArticle
<placeholder>
Optional Product weight in ounces
TrackResponse / String
TrackInfo /
ProductWeight

14
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

Conditional
TrackResponse / Tracking Summary (group)
Required
TrackInfo / Information. The group is
TrackSummary max 1 listed once.

TrackResponse / Optional The time of the event. String

TrackInfo /
TrackSummary /
EventTime

TrackResponse / Optional The date of the event. String

TrackInfo /
TrackSummary /
EventDate

TrackResponse / Optional The event type String

TrackInfo /
TrackSummary / Event

TrackResponse / Optional The city where the event String

TrackInfo / occurred.
TrackSummary /
EventCity

TrackResponse / Optional The state where the event String

TrackInfo / occurred.
TrackSummary /
EventState

TrackResponse / Optional The ZIP Code of the event. String

TrackInfo /
TrackSummary /
EventZIPCode

TrackResponse / Optional The country where the event String

TrackInfo / occurred.
TrackSummary /
EventCountry

TrackResponse / Optional The company name if String

TrackInfo / delivered to a company.
TrackSummary /
FirmName

TrackResponse / Optional The first initial and last String

TrackInfo / name of the person signing
TrackSummary / Name for delivery (if available).

TrackResults / TrackInfo Optional True/False field indicating Boolea Enumerations

/ TrackSummary / the person signing as an n =
AuthorizedAgent Authorized Agent. • True
• False

15
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

TrackResponse / Optional The event code String

TrackInfo /
TrackSummary /
EventCode
Optional
TrackResponse / The action code String
TrackInfo / max 1
TrackSummary /
ActionCode

TrackResponse / Optional The reason code String

TrackInfo /
TrackSummary /
ReasonCode
Enumeration=
TrackResponse / Optional Only eligible to display with Boolea
• True
TrackInfo / delivery (01) events. n
TrackSummary / • False
GeoCertified

TrackResults / TrackInfo Optional Used to provide additional String

/ TrackSummary / information regarding an
DeliveryAttributeCode event posted to a mail
piece.

TrackResults / TrackInfo Optional The status of a posted event String

/ TrackSummary / on a mail piece.
EventStatusCategory

TrackResults / TrackInfo Optional Greenwich Mean Time String

/ TrackSummary / GMT

TrackResults / TrackInfo Optional Greenwich Mean Time String

/ TrackSummary / Offset
GMTOffset
Optional
TrackResults / TrackInfo Collect on Delivery (COD) String
/ TrackSummary / amount
CODAmountDue
Optional
TrackResponse / Tracking Detail Information. (group)
TrackInfo / TrackDetail max 99 This group is repeatable.

TrackResponse / Optional The time of the event. String

TrackInfo / TrackDetail /
EventTime

TrackResponse / Optional The date of the event. String

TrackInfo / TrackDetail /
EventDate

16
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

TrackResponse / Optional The event type String

TrackInfo / TrackDetail /
Event

TrackResponse / Optional The city where the event String

TrackInfo / TrackDetail / occurred.
EventCity
Optional
TrackResponse / The state where the event String
TrackInfo / TrackDetail / occurred.
EventState

TrackResponse / Optional The ZIP Code of the event. String

TrackInfo / TrackDetail /
EventZIPCode

TrackResponse / Optional The country where the event String

TrackInfo / TrackDetail / occurred.
EventCountry

TrackResponse / Optional The company name if String

TrackInfo / TrackDetail / delivered to a company.
FirmName

TrackResponse / Optional The first initial and last String

TrackInfo / TrackDetail / name of the person signing
Name for delivery (if available).
Optional
TrackResults / TrackInfo True/False field indicating Boolea Enumerations
/ TrackDetail / the person signing as an n =
AuthorizedAgent Authorized Agent. • True
• False
Optional
TrackResponse / The event code String
TrackInfo / TrackDetail /
EventCode
Optional
TrackResponse / The action code String
TrackInfo / TrackDetail / max 1
ActionCode

TrackResponse / Optional The reason code String

TrackInfo / TrackDetail /
ReasonCode
Enumeration=
TrackResponse / Optional Only eligible to display with Boolea
• True
TrackInfo / TrackDetail / delivery (01) events. n
GeoCertified • False

TrackResults / TrackInfo Optional Used to provide additional String

/ TrackDetail / information regarding an
DeliveryAttributeCode

17
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

event posted to a mail

piece.

TrackResults / TrackInfo Optional The status of a posted event String

/ TrackDetail / on a mail piece.
EventStatusCategory

TrackResults / TrackInfo Optional Greenwich Mean Time String

/ TrackDetail / GMT

TrackResults / TrackInfo Optional Greenwich Mean Time String

/ TrackDetail / Offset
GMTOffset

TrackResults / TrackInfo Optional Collect on Delivery (COD) String

/ TrackDetail / amount
CODAmountDue

TrackResponse / Optional Error message grouping if (Group)

TrackInfo / Error applicable.

TrackResponse / Optional Unique number assigned for String

TrackInfo / Error / the type of error that has
Number occurred.
Error message description
TrackResponse / Optional String
TrackInfo / Error /
Description Example: <Description>A
status update is not yet
available on your Priority
Mail
Express<SUP>&reg;</SUP
> package. It will be
available when the shipper
provides an update or the
package is delivered to
USPS. Check back soon.
Sign up for Informed
Delivery<SUP>&reg;</SUP
> to receive notifications for
packages addressed to
you.</Description>

3.3.2 Sample Response

Response: Package Tracking “Fields”
<TrackResponse>
<TrackInfo ID=" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ">
<TrackSummary>
<EventTime>9:00 am</EventTime>
<EventDate>June 22, 2022</EventDate>
<Event>Delivered, To Agent</Event>
<EventCity>AMARILLO</EventCity>

18
USPS Web Tools User Guide

<EventState>TX</EventState>
<EventZIPCode>79109</EventZIPCode>
<EventCountry/>
<FirmName/>
<Name>RXXXXXX XXXXXXX</Name>
<AuthorizedAgent>false</AuthorizedAgent>
<DeliveryAttributeCode/>
<GMT>14:00:00</GMT>
<GMTOffset>-05:00</GMTOffset>
</TrackSummary>
<TrackDetail>
<EventTime/>
<EventDate>June 22, 2022</EventDate>
<Event>USPS expects item for mailing (SSK)</Event>
<EventCity>LAUREL</EventCity>
<EventState>MD</EventState>
<EventZIPCode>20707</EventZIPCode>
<EventCountry/>
<FirmName/>
<Name/>
<AuthorizedAgent>false</AuthorizedAgent>
<GMT/>
<GMTOffset/>
</TrackDetail>
</TrackInfo>
</TrackResponse>

Response (Revision = 1): Package Tracking “Fields”

<TrackResponse>
<TrackInfo ID=" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX ">
<Class>Priority Mail Express 2-Day&lt;SUP>&amp;reg;&lt;/SUP></Class>
<ClassOfMailCode>EX</ClassOfMailCode>
<DestinationCity>AMARILLO</DestinationCity>
<DestinationState>TX</DestinationState>
<DestinationZip>79109</DestinationZip>
<EmailEnabled>true</EmailEnabled>
<KahalaIndicator>false</KahalaIndicator>
<MailTypeCode>DM</MailTypeCode>
<MPDATE>2022-06-24 11:30:26.000000</MPDATE>
<MPSUFFIX>XXXXXXX</MPSUFFIX>
<OriginCity>LAUREL</OriginCity>
<OriginState>MD</OriginState>
<OriginZip>20707</OriginZip>
<PodEnabled>true</PodEnabled>
<TPodEnabled>false</TPodEnabled>
<RestoreEnabled>false</RestoreEnabled>
<RramEnabled>false</RramEnabled>
<RreEnabled>false</RreEnabled>
<Service>Signature Confirmation&lt;SUP>&amp;#153;&lt;/SUP></Service>
<Service>Up to $100 insurance included</Service>
<ServiceTypeCode>889</ServiceTypeCode>
<Status>Delivered, To Agent</Status>
<StatusCategory>Delivered</StatusCategory>

19
USPS Web Tools User Guide

<StatusSummary>Your item has been delivered to an agent at 9:00 am on June 22, 2022 in
AMARILLO, TX 79109. The item was signed for by R XXXXXXX.</StatusSummary>
<TABLECODE>T</TABLECODE>
<TrackSummary>
<EventTime>9:00 am</EventTime>
<EventDate>June 22, 2022</EventDate>
<Event>Delivered, To Agent</Event>
<EventCity>AMARILLO</EventCity>
<EventState>TX</EventState>
<EventZIPCode>79109</EventZIPCode>
<EventCountry/>
<FirmName/>
<Name>RXXXXXX XXXXXXX</Name>
<AuthorizedAgent>false</AuthorizedAgent>
<EventCode>01</EventCode>
<DeliveryAttributeCode/>
<GMT>14:00:00</GMT>
<GMTOffset>-05:00</GMTOffset>
</TrackSummary>
<TrackDetail>
<EventTime/>
<EventDate>June 22, 2022</EventDate>
<Event>USPS expects item for mailing (SSK)</Event>
<EventCity>LAUREL</EventCity>
<EventState>MD</EventState>
<EventZIPCode>20707</EventZIPCode>
<EventCountry/>
<FirmName/>
<Name/>
<AuthorizedAgent>false</AuthorizedAgent>
<EventCode>03</EventCode>
<GMT/>
<GMTOffset/>
</TrackDetail>
</TrackInfo>
</TrackResponse>

Error Response:
<TrackResponse>
<TrackInfo ID="XXXXXXXXXXXXXXXXXX">
<Error>
<Number>-2147219283</Number>
<Description>A status update is not yet available on your Priority Mail Express<SUP>&reg;</SUP>
package. It will be available when the shipper provides an update or the package is delivered to USPS.
Check back soon. Sign up for Informed Delivery<SUP>&reg;</SUP> to receive notifications for
packages addressed to you.</Description>
<HelpFile/>
<HelpContext/>
</Error>
</TrackInfo>

20
USPS Web Tools User Guide

4.0 Track and Confirm by Email API

4.1 Overview
The Track and Confirm by Email API allows the customer to submit their email address to be notified of
current or future tracking activity. When you request access for this API, please identify your anticipated
API volume, mailer ID and how you will be utilizing this API. 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

4.1.1 API Signature

Scheme Host Path API XML

https:// secure.shippingapis.com /ShippingAPI.dll? API=PTSEmail &XML=(see below)
https:// secure.shippingapis.com /ShippingAPI.dll? API=PTSEmailCertify &XML=(see below)

4.2 Request Descriptions

Tag Name Occurs Descriptions Type Validation

PTSEmailReques Required API=PTSEmail. (Alias)

t
This attribute specifies your Web Tools
PTSEmailReques Required NMTOKE
user ID. See the Developer’s Guide for
t / USERID N
information on obtaining your USERID.
For Example: USERID="XXXXXXX"
This attribute specifies your Web Tools
PTSEmailReques Optional NMTOKE
password. See the Developer’s Guide
t / PASSWORD N
for information on your Password.
For Example:
PASSWORD="XXXXXXX"

PTSEmailReques Required Must be alphanumeric characters. String minOccurs="1"

t / TrackId
For example:
<TrackId>EJ123456780US</TrackId>

PTSEmailReques Optional User IP address. String minOccurs="0"

t / ClientIp
For example:
<ClientIp>127.0.0.1</ClientIp>

PTSEmailReques Optional Internal User Identification. String minOccurs="0"

t / SourceId
For example: <SourceId>XYZ
Corp</SourceId>

21
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

PTSEmailReques Required MPSUFFIX value located in Integer minOccurs="1"

t / MpSuffix Track/Confirm Fields API response
data. Unique to each TrackID.
For example:
<MpSuffix>9402</MpSuffix>

PTSEmailReques Required MPDATE value located in String minOccurs="1"

t / MpDate Track/Confirm Fields API response
data. Unique to each TrackId.
For example: <MpDate>2009-07-02
00:42:23.35744</MpDate>

PTSEmailReques Required Enter a notification request type from String minOccurs="1"

t / RequestType once,repeatin the choices available. maxOccurs
g up to 5 times =”5”
Request Descriptions
Type Enumerations
=
“AL” E-Mail Alert
• AL
“FD” E-Mail Future • FD
Delivery • ED
• TD
“ED” E-Mail
• UP
Delivery/Non
Delivery activity • FS
• OA
“TD” E-Mail Today
Delivery
“UP” E-Mail Available
for Pickup
“FS” Package
addressed to
me/myusps only
“OA” Other Activity
For example:
<RequestType>ED</RequestType>

PTSEmailReques Optional Recipient First Name. String minOccurs="0"

t / FirstName
For example:
<FirstName>John</FirstName>

PTSEmailReques Optional Recipient Last Name. String minOccurs="0"

t / LastName
For example:
<LastName>Doe</LastName>

PTSEmailReques Required Complete valid e-mail address is String minOccurs="1"

t / Email1 Required if tag is used.

22
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

For example:
<Email1>[email protected]</Email1
>

PTSEmailReques Optional Complete valid e-mail address is String minOccurs="0"

t / Email2 Required if tag is used.

PTSEmailReques Optional Complete valid e-mail address is String minOccurs="0"

t / Email3 Required if tag is used.

PTSEmailReques Required once API=PTSEmail (Alias)

t

4.2.1 Sample Request

Request: PTSEmail
<PTSEmailRequest USERID="XXXXXXXXX" PASSWORD="">
<TrackId>XXXXXXXXXXX</TrackId >
<ClientIp>127.0.0.1</ClientIp>
<SourceId>XYZ Corp</SourceId>
<MpSuffix >9402</MpSuffix>
<MpDate >2009-07-02 00:42:23.35744</MpDate>
<RequestType>EN</RequestType>
<FirstName>John</FirstName>
<LastName >Doe</LastName>
<Email1>[email protected]</Email1>
<Email2></Email2>
<Email3></Email3>
</PTSEmailRequest>

4.3 Response Descriptions

Tag Name Occurs Descriptions Type Validation

PTSEmailResponse Required (Alias)

PTSEmailResponse Required Status message. String

/ ResultText

PTSEmailRequest / Required Return code. Integer

ReturnCode

PTSEmailResponse Required (Alias)

23
USPS Web Tools User Guide

4.3.1 Sample Response

Response: PTSEmail
<PTSEMAILRESULT>
<ResultText>Your request for all activity to-date will be processed within four hours. Any future activity
will be processed whenever there is new delivery related event activity.</ResultText>
<ReturnCode>0</ReturnCode>
</PTSEMAILRESULT>

5.0 Proof of Delivery API

5.1 Overview
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. When you request
access for this API, please identify your anticipated API volume, mailer ID and how you will be utilizing
this API. 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

5.1.1 API Signature

Scheme Host Path API XML

https:// secure.shippingapis.com /ShippingAPI.dll? API=PTSPod &XML=(see below)
https:// secure.shippingapis.com /ShippingAPI.dll? API=PTSPodCertify &XML=(see below)

5.2 Request Descriptions

Tag Name Occurs Descriptions Type Validation

PTSPodRequest Required (Alias)

once
This attribute specifies your Web Tools user
PTSPodRequest Required NMTOKEN
ID. See the Developer’s Guide for information
/ USERID
on obtaining your USERID.
For Example: USERID="XXXXXXX"
This attribute specifies your Web Tools
PTSPodRequest Optional NMTOKEN
password. See the Developer’s Guide for
/ PASSWORD
information on your Password.
For Example: PASSWORD="XXXXXXX"

PTSPodRequest Required Must be alphanumeric characters. String minOccurs="1"

/ TrackId
For example:
<TrackId>EJ123456780US</TrackId>

24
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

PTSPodRequest Optional User IP address. String minOccurs="0"

/ ClientIp
For example: <ClientIp>127.0.0.1</ClientIp>

PTSPodRequest Optional Internal User Identification. String minOccurs="0"

/ SourceId
For example: <SourceId>XYZ
Corp</SourceId>

PTSPodRequest Required MPSUFFIX value located in Track/Confirm integer minOccurs="1"

/ MpSuffix Fields API response data. Unique to each
TrackId.
For example: <MpSuffix>9402</MpSuffix>

PTSPodRequest Required MPDATE value located in Track/Confirm String minOccurs="1"

/ MpDate Fields API response data. Unique to each
TrackID.
For example: <MpDate>2009-07-02
00:42:23.35744</MpDate>

PTSPodRequest Required Enter a notification request type from the String minOccurs="1"
/ RequestType choices available.
For example:
<RequestType>Email</RequestType>

PTSPodRequest Required Recipient First Name. String minOccurs="1"

/ FirstName
For example: <FirstName>John</FirstName>

PTSPodRequest Required Recipient Last Name. String minOccurs="1"

/ LastName
For example: <LastName>Doe</LastName>

PTSPodRequest Optional Required when String minOccurs="0"

/ Email1 PTSPodRequest[RequestType=’Email’].
Complete valid e-mail address is Required if
tag is used.
For example:
<Email1>[email protected]</Email1>

PTSPodRequest Optional Complete valid e-mail address is Required if String minOccurs="0"

/ Email2 tag is used.

PTSPodRequest Optional Complete valid e-mail address is Required if String minOccurs="0"

/ Email3 tag is used.

PTSPodRequest Optional Fax Number. String minOccurs="0"

/ FaxNumber

PTSPodRequest Optional Address Line 1. String minOccurs="0"

/ AddressLine1

25
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

PTSPodRequest Optional Address Line 2. String minOccurs="0"

/ AddressLine2

PTSPodRequest Optional City String minOccurs="0"

/ City

PTSPodRequest Optional State String minOccurs="0"

/ State

PTSPodRequest Optional Zip String minOccurs="0"

/ Zip

PTSPodRequest Optional Indicates whether or not address should be Boolean minOccurs="0"

/ VerifyAddress validated.

PTSPodRequest Optional Unique 10-byte numeric value that’s String minOccurs="0"

/ CustRegID associated to each user.

PTSPodRequest Required TableCode value located in Track/Confirm String minOccurs="1"

/ TableCode Fields API response data. Unique to each
TrackID.
For example: <TableCode>T</TableCode>

PTSPodRequest Required (Alias)

once

5.2.1 Sample Request

Request: PTSPod
<PTSPodRequest USERID="XXXXXXXXX" PASSWORD="">
<TrackId>XXXXXXXXXXX</TrackId >
<ClientIp>127.0.0.1</ClientIp>
<SourceId>XXXXXX</SourceId>
<MpSuffix>9402</MpSuffix>
<MpDate>2009-07-02 00:42:23.35744</MpDate>
<RequestType>Email</RequestType>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<Email1>[email protected] </Email1>
<Email2></Email2>
<Email3></Email3>
<CustRegID>1234567890</CustRegID>
<TableCode>T</TableCode>

26
USPS Web Tools User Guide

</PTSPodRequest>

5.3 Response Descriptions

Tag Name Occurs Descriptions Type Validation

PTSPODResult Required (Alias)

PTSPODResponse Required Status message. String

/ ResultText

PTSPODRequest / Required Return code. Integer

ReturnCode

PTSPODResult Required (Alias)

5.3.1 Sample Response

Response: PTSPOD
<PTSPODRESULT>
<ResultText>Your Proof of Delivery record is complete and will be processed shortly.</ResultText>
<ReturnCode>0</ReturnCode>
</PTSPODRESULT>

6.0 Return Receipt Electronic API

6.1 Overview
The Return Receipt Electronic API allows the customer to request a copy of the proof of delivery record
via email. When you request access for this API, please identify your anticipated API volume, mailer ID
and how you will be utilizing this API. 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

6.1.1 API Signature

Scheme Host Path API XML

https:// secure.shippingapis.com /ShippingAPI.dll? API=PTSRre &XML=(see
below)
https:// secure.shippingapis.com /ShippingAPI.dll? API=PTSRreCertify &XML=(see
below)

27
USPS Web Tools User Guide

6.2 Request Descriptions

Tag Name Occurs Descriptions Type Validation

PTSRreRequest Required API=PTSRre (Alias)

This attribute specifies your Web Tools user
PTSRreRequest / Required NMTOKEN
ID. See the Developer’s Guide for
USERID
information on obtaining your USERID.
For Example: USERID="XXXXXXX"
This attribute specifies your Web Tools
PTSRreRequest / Optional NMTOKEN
password. See the Developer’s Guide for
PASSWORD
information on your Password.
For Example: PASSWORD="XXXXXXX"

PTSRreRequest / Required Must be alphanumeric characters. String minOccurs="1"

TrackId
For example:
<TrackId>EJ123456780US</TrackId>

PTSRreRequest / Optional User IP address. String minOccurs="0"

ClientIp
For example: <ClientIp>127.0.0.1</ClientIp>

PTSRreRequest / Optional Internal User Identification. String minOccurs="0"

SourceId
For example: <SourceId>XYZ
Corp</SourceId>

PTSRreRequest / Required MPSUFFIX value located in Track/Confirm integer minOccurs="1"

MpSuffix Fields API response data. Unique to each
TrackId.
For example: <MpSuffix>9402</MpSuffix>

PTSRreRequest / Required MPDATE value located in Track/Confirm String minOccurs="1"

MpDate Fields API response data. Unique to each
TrackID.
For example: <MpDate>2009-07-02
00:42:23.35744</MpDate>

PTSRreRequest / Required Recipient First Name. String minOccurs="1"

FirstName
For example:
<FirstName>John</FirstName>

PTSRreRequest / Required Recipient Last Name. String minOccurs="1"

LastName
For example: <LastName>Doe</LastName>

PTSRreRequest / Required Complete valid e-mail address is Required if String minOccurs="1"

Email1 tag is used.
For example:
<Email1>[email protected]</Email1>

28
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

PTSRreRequest / Optional Complete valid e-mail address is Required if String minOccurs="0"

Email2 tag is used.

PTSRreRequest / Optional Complete valid e-mail address is Required if String minOccurs="0"

Email3 tag is used.

PTSRreRequest / Optional Unique 10-byte numeric value that is String minOccurs="0"

CustRegID associated to each user.

PTSRreRequest / Required TableCode value located in Track/Confirm String minOccurs="1"

TableCode Fields API response data. Unique to each
TrackID.
For example: <TableCode>T</TableCode>

PTSRreRequest Required (Alias)

6.2.1 Sample Request

Request: PTSRre
<PTSRreRequest USERID="XXXXXXXXX" PASSWORD="">
<TrackId>XXXXXXXXXXX</TrackId >
<ClientIp>127.0.0.1</ClientIp>
<SourceId>XYZ Corp</SourceId>
<MpSuffix>9402</MpSuffix>
<MpDate>2009-07-02 00:42:23.35744</MpDate>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<Email1>[email protected]</Email1>
<Email2></Email2>
<Email3></Email3>
<CustRegID>1234567890</CustRegID>
<TableCode>T</TableCode>
</PTSRreRequest>

6.3 Response Descriptions

Tag Name Occurs Descriptions Type Validation

PTSRreResult Required (Alias)

PTSRreResponse /
Required Status message. String
ResultText

PTSRreRequest /
Required Return code. Integer
ReturnCode

PTSRreResult Required (Alias)

29
USPS Web Tools User Guide

6.3.1 Sample Response

Response: PTSRre
<PTSRRERESULT>
<ResultText>Your Proof of Delivery record is complete and will be processed
shortly</ResultText>
<ReturnCode>0</ReturnCode>
</PTSRRERESULT>

7.0 Track Proof of Delivery API

7.1 Overview
Track Proof of Delivery is a letter that includes the recipient's name and a copy of their signature. The
Track Proof of Delivery API allows the customer to request proof of delivery notification via email. When
you request access for this API, please identify your anticipated API volume, mailer ID and how you will
be utilizing this API. 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

7.1.1 API Signature

Scheme Host Path API XML

https:// secure.shippingapis.com /ShippingAPI.dll? API=PTSTPod &XML=(see
below)
https:// secure.shippingapis.com /ShippingAPI.dll? API=PTSTPodCertify &XML=(see
below)

7.2 Request Descriptions

Tag Name Occurs Descriptions Type Validation

PTSTpodRequest Required (Alias)

This attribute specifies your Web Tools
PTSTpodRequest Required NMTOKEN
user ID. See the Developer’s Guide for
/ USERID
information on obtaining your USERID.
For Example: USERID="XXXXXXX"
This attribute specifies your Web Tools
PTSTpodRequest Optional NMTOKEN
password. See the Developer’s Guide for
/ PASSWORD
information on your Password.
For Example: PASSWORD="XXXXXXX"

PTSTpodRequest Required Must be alphanumeric characters. String minOccurs="1"

/ TrackId
For example:
<TrackId>EJ123456780US</TrackId>

30
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

PTSTpodRequest Required MPSUFFIX value located in Track/Confirm integer minOccurs="1"

/ MpSuffix Fields API response data. Unique to each
TrackId.
For example: <MpSuffix>9402</MpSuffix>

PTSTpodRequest Required MPDATE value located in Track/Confirm String minOccurs="1"

/ MpDate Fields API response data. Unique to each
TrackID.
For example: <MpDate>2009-07-02
00:42:23.35744</MpDate>

PTSTpodRequest Required Enter a notification request type from the String minOccurs="1"
/ RequestType choices available.
For example:
<RequestType>Email</RequestType>

PTSTpodRequest Required Recipient First Name. String minOccurs="1"

/ FirstName
For example:
<FirstName>John</FirstName>

PTSTpodRequest Required Recipient Last Name. String minOccurs="1"

/ LastName
For example:
<LastName>Doe</LastName>

PTSTpodRequest Optional Required when String minOccurs="0"

/ Email1 PTSTpodRequest[RequestType=’Email’].
Complete valid e-mail address is Required
if tag is used.
For example:
<Email1>[email protected]</Email1>

PTSTpodRequest Optional Complete valid e-mail address is Required String minOccurs="0"

/ Email2 if tag is used.

PTSTpodRequest Optional Complete valid e-mail address is Required String minOccurs="0"

/ Email3 if tag is used.

PTSTpodRequest Required Unique 10-byte numeric value that’s String minOccurs="0"

/ CustRegID associated to each user.

PTSTpodRequest Required TableCode value located in Track/Confirm String minOccurs="1"

/ TableCode Fields API response data. Unique to each
TrackID.
For example:
<TableCode>T</TableCode>

31
USPS Web Tools User Guide

Tag Name Occurs Descriptions Type Validation

PTSTpodRequest Optional User IP address. String minOccurs="0"

/ ClientIp
For example:
<ClientIp>127.0.0.1</ClientIp>

PTSTpodRequest Optional Internal User Identification. Required when String minOccurs="0"

/ SourceId TrackFieldRequest[Revision=’1’].
For example: <SourceID>XYZ
Corp</SourceID>

PTSTpodRequest Required (alias)

7.2.1 Sample Request

Request: PTSTPod
<PTSTpodRequest USERID="XXXXXXXXX" PASSWORD="">
<TrackId>XXXXXXXXXXX</TrackId >
<MpSuffix>9402</MpSuffix>
<MpDate>2009-07-02 00:42:23.35744</MpDate>
<RequestType>Email</RequestType>
<FirstName>John</FirstName>
<LastName>Doe</LastName>
<Email1>[email protected] </Email1>
<Email2></Email2>
<Email3></Email3>
<CustRegID>1234567890</CustRegID>
<TableCode>T</TableCode>
<ClientIp>127.0.0.1</ClientIp>
<SourceId>XXXXX</SourceId>
</PTSTpodRequest>

7.3 Response Descriptions

Tag Name Occurs Descriptions Type Validation

PTSTPODResult Required (Alias)

PTSTPODResponse
Required Status message. String
/ ResultText

PTSTpodRequest /
Required Return code. Integer
ReturnCode

PTSTPODResult Required (Alias)

7.3.1 Sample Response

Response: PTSTPod
<PTSTPODRESULT>

32
USPS Web Tools User Guide

<ResultText>Your Proof of Delivery record is complete and will be processed shortly.</ResultText>

<ReturnCode>0</ReturnCode>
</PTSTPODRESULT>

33