eVS Label
USPS Web Tools™
Application Programming Interface
User Guide
Version 4.21 (07/10/2025)
USPS Web Tools User Guide
Table of Contents
1.0 Introduction ..................................................................................................................................................3
1.1 Before you get started: ...........................................................................................................................3
2.0 eVS Label API...............................................................................................................................................4
2.1 Overview ...................................................................................................................................................4
2.1.1 API Signature ........................................................................................................................................ 4
2.2 Request Descriptions .............................................................................................................................4
2.2.1 Sample Request.................................................................................................................................. 37
2.3 Response Descriptions ....................................................................................................................... 47
2.3.1 Sample Response ............................................................................................................................... 51
3.0 eVS Cancel API ......................................................................................................................................... 54
3.1 Overview ................................................................................................................................................ 54
3.1.1 API Signature ...................................................................................................................................... 55
3.2 Request Descriptions .......................................................................................................................... 55
3.2.1 Sample Request.................................................................................................................................. 55
3.3 Response Descriptions ....................................................................................................................... 55
3.3.1 Sample Response ............................................................................................................................... 56
4.0 Appendices ............................................................................................................................................... 56
4.1 Appendix A ............................................................................................................................................ 56
4.1.1 Priority Mail Express Label ................................................................................................................. 57
4.1.2 Priority Mail Label................................................................................................................................ 58
4.1.3 Ground Advantage Label .................................................................................................................... 59
4.1.4 Library Mail Label ................................................................................................................................ 60
4.1.5 Media Mail Label ................................................................................................................................. 61
4.1.6 BPM Label........................................................................................................................................... 62
4.1.7 Priority Mail Cubic Label ..................................................................................................................... 63
4.1.8 Priority Mail Domestic Integrated Customs Form (P.S. Form 2976-A) ............................................... 64
4.1.9 Priority Express Mail Domestic Integrated Customs Form (P.S. Form 2976-B) ................................. 65
4.1.10 Ground Advantage Domestic Integrated Customs Form (P.S. Form 2976-A) ................................... 66
4.1.11 Marketing Mail Parcel (MMP) Domestic Integrated Customs Form (P.S. Form 2976) ....................... 67
4.1.12 Parcel Select Destination Entry .......................................................................................................... 68
4.1.13 Parcel Locker Label ............................................................................................................................ 70
4.2 Appendix B - Special Situations ......................................................................................................... 72
4.2.1 GDE Customers .................................................................................................................................. 72
4.2.2 Shipping to a Parcel Locker ................................................................................................................ 72
4.3 Appendix C - Parcel Select Service Combinations ........................................................................... 73
4.4 Appendix D - Categories for International Shipping Regulatory Mandates ................................... 74
2
USPS Web Tools User Guide
1.0 Introduction
This document contains a Reference Guide to the eVS Label API. See the Developers 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:
<ZipDestination>12345</ZipDestination>
In this instance, you will replace “12345” with the destination ZIP Code for the domestic-bound package.
For label specifications such as package dimensions, delivery information, etc., please refer to the Domestic Mail
Manual (DMM) at http://pe.usps.com/.
For information specific to domestic mail pieces sent to an Army Post Office (APO), Fleet Post Office (FPOs),
Diplomatic Post Offices (DPO), and/or U.S. Possessions, Territories, and Freely Associated States (PTFAS) see
the DMM at http://pe.usps.com/text/dmm300/703.htm and http://pe.usps.com/text/dmm300/608.htm.
1.1 Before you get started:
Whether you are a new or existing mailer, USPS strongly suggests a conversation with you to discuss your
business requirements so your account will be properly configured. To initiate this conversation please contact the
National Customer Support Center (NCSC) at 877-264-9693 Option 4 and request a referral to an Operations
Integration Specialist (OIS) and Technical Integration Specialist (TIS). USPS will align the appropriate team to
assist with swift onboarding.
Depending on your needs, your account may be configured in many flexible ways; however, each account will be
configured with credentials in a master/child relationship. Minimally, credentials will be established as follows:
• A master Mailer ID is created
o Child Mailer IDs are created for each origin site and may be created as needed by the
requirements of your business units and brands.
• A permit number is created
o Additional permit numbers may be created as needed by the requirements of your business units
and brands
• A CAPS Debit account is created for payment processing
o Additional CAPS Debit accounts may be created as needed
Your Operations Integration Specialist and Technical Integration Specialist will be involved at the local and
national levels to ensure successful launch and introduction to appropriate production support teams.
Note: All Label APIs handle a pipe special character (“|”) as a space. Integrators are recommended to not include
a pipe special character (“|”) in the API request. If a pipe is provided in the API request, Web Tools will treat as a
space where applicable in the API XML response, label image, Shipping Partner Event File, and Shipping
Services File.
Note: All Label APIs can accept a trademark symbol (“™”) in the XML request but any response from the API will
strip the symbol from the text (e.g., Firm Name) and will not display the symbol on the printed labels.
3
USPS Web Tools User Guide
2.0 eVS Label API
2.1 Overview
The only option for creating outbound shipping labels through our APIs requires eVS setup/enrollment. 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
• Requires enrollment and new Mailer IDs (MIDs) and permits
• Supports domestic/international/APO/FPO/DPO/PTFAS locations
• Supports Priority Mail Cubic and Ground Advantage Cubic (Contact your Technical Integration Specialist
for further details)
• Supports Parcel Select Destination Entry (PSDE) label creation
• Supports Global Direct Entry (GDE)
eVS, or Electronic Verification System, allows high-volume package mailers and package consolidators to
document and pay postage, including special service fees, using electronic manifest files. The files are
transmitted over the Internet to a Postal Service™ database.
If you want to explore using eVS, please first contact the [email protected].
For registration please visit: https://www.usps.com/postalone/evs.htm. If that will not work for you, then you can
follow up with [email protected] (or your local Postmaster or USPS Sales Manager) for additional solutions outside
of the Web Tools API suite.
2.1.1 API Signature
Scheme Host Path API XML
https:// secure.shippingapis.com /ShippingAPI.dll? API=eVS &XML=(see below)
https:// secure.shippingapis.com /ShippingAPI.dll? API=eVSCertify &XML=(see below)
The “eVSCertify” API signature is for testing purposes and will not generate usable labels and barcodes.
Note: 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.
2.2 Request Descriptions
Tag Name Occurs Description Type Validation
eVSRequest Required API=eVS (Group)
eVSRequest / Required This attribute specifies your Web Tools user NMTOK
USERID ID. See the Developer's Guide for information EN
on obtaining your USERID.
For Example: USERID="XXXXXXX"
4
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest / Required This attribute specifies your Web Tools NMTOK
PASSWORD password. See the Developer's Guide for EN
information on your Password.
For Example: PASSWORD="XXXXXXX"
eVSRequest / Optional For future use. Empty
Option
eVSRequest/ Optional Used to indicate API version. Use a value of String
Revision “2” or above to return a shortened IMpb
barcode in the <TrackingNumber> tag.
Use a value of “3” to return a new
ServiceType attribute in the <Postage>
response tag that echoes the <ServiceType>
used to price and generate the label.
For example: <Revision>3</Revision>
eVSRequest/ Optional (group)
ImageParameters
5
USPS Web Tools User Guide
eVSRequest/ Optional Returns alternate label image. String Default=4X6LABEL
ImageParameters/ • BARCODE ONLY- label option returns a
ImageParameter barcode and Package ID Code (PIC) Enumerations=
number without the return and delivery • BARCODE ONLY
name and address. No label image is • CROP
returned. • 4X6LABEL
• CROP - reduces the image size to half- • 4X6LABELL
sheet (approximately), instructions sheet • 6X4LABEL
will be returned, and label image will • 4X6LABELP
return as a landscape orientation • 4X6LABELP PAGE
• 4X6LABELL- Label image will return as a • 4X6ZPL203DPI
Landscape – True size 4 inches vertical • 4X6ZPL300DPI
by 6 inches horizontal (image rotated 90 • SEPARATECONTI
degrees from “4X6LABELP” orientation, NUEPAGE
not returned on an 8.5 x 11 background
page)
• 6X4Label – Label image will be returned
as traditional landscape orientation with
the horizontal dimension longer than the
vertical dimension (6 inches horizontal by
4 inches vertical)
• 4X6LABEL – Label image will be
returned as a Portrait orientation with the
vertical dimension longer than the
horizontal dimension (4 inches horizontal
by 6 inches vertical)
• 4X6LABELP – Label image with be
returned as a Portrait – True size 4
inches horizontal orientation by 6 inches
vertical (not returned on an 8.5 x 11
background page)
• 4X6ZPL203DPI - (ZPL - Zebra
Programming Language) format. When
using this enumeration, <ImageType> is
required - this tag cannot be left blank.
Integrators should use either “TIF” or
“PDF” for ZPL – neither value will impact
the label image itself, but it must be
included in the request to return a
successful response.
• 4X6ZPL300DPI – Prints a label formatted
for ZPL printers in 300 dpi. When using
this enumeration, <ImageType> is
required - this tag cannot be left blank.
Integrators should use either “TIF” or
“PDF” for ZPL – neither value will impact
the label image itself, but it must be
included in the request to return a
successful response.
• SEPARATECONTINUEPAGE – will force
the continuation page (if the item count
causes the need for a continuation page)
onto a separate page. This allows for two
6
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
images to return, one label image and
one continuation page
For example:
<ImageParameter>4X6LABEL</ImageParam
eter>
eVSRequest/ Optional Value of the horizontal coordinate where the Integer minValue=0
ImageParameters/ upper left corner of the label is placed. maxValue=900
XCoordinate Combination of X and Y Coordinates will be default=500
validated to fit on the page. (centered)
For example:
<XCoordinate>200</XCoordinate>
eVSRequest/ Optional Value of the vertical coordinate where the Integer minValue=0
ImageParameters/ upper left corner of the label is placed. maxValue=1000
YCoordinate Combination of X and Y Coordinates will be default=450
validated to fit on the page. (centered)
For example:
<YCoordinate>250</YCoordinate>
eVSRequest / Optional To be used in the case of multiple packages. String minOccurs="0"
ImageParameters/ Not Required only one package. maxOccurs="1"
LabelSequence
eVSRequest / Required Required if <LabelSequence> is selected Integer minInclusive value =
ImageParameters/ "1"
LabelSequence / maxInclusive value =
PackageNumber "999"
eVSRequest / Required Required if <LabelSequence> is selected Integer minInclusive value =
ImageParameters / "1"
LabelSequence/ maxInclusive value =
TotalPackages "999"
eVSRequest/ Condition Values for either First and Last Name of String minLength=0
FromName ally Sender or Firm must be sent. maxLength=100
Required For example: <FromName>AA
BB</FromName>
Note: If a domestic customs form is required
based on Destination, Customs Content Type,
and Weight, then FromName must be used
with at least 2 names with a minimum of 2
alpha characters A-Z each.
7
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Condition Values for either First and Last Name of String minLength=0
FromFirm ally Sender or Firm must be sent. maxLength=50
Required For example: <FromFirm>USPS</FromFirm>
Note: If a domestic customs form is required
based on Destination, Customs Content Type,
and Weight, FromFirm must be used with at
least 2 characters, or else an error will return.
Note: Maximum length printed on the label is
32 characters for all <ServiceType>
enumerations. Values exceeding 32
characters will be truncated due to space
limitations on the label. API request eligible to
accept up to 50 characters.
eVSRequest/ Optional From address line 1. Use this field for String minLength=0
FromAddress1 secondary address information such as an maxLength=50
apartment or suite number if applicable.
For example: <ToAddress1> Suite 4D
</ToAddress1>
Note: When populating the address fields, do
not include additional information such as
building name or company.
eVSRequest/ Required From address line 2. Use this field for a String minLength=1
FromAddress2 primary street address. maxLength=50
For example: <ToAddress2>1234 MAIN ST</
ToAddress2>
Note: When populating the address fields, do
not include additional information such as
building name or company.
eVSRequest/ Required From city. String minLength=1
FromCity maxLength=28
For example: <FromCity>BETHESDA</
FromCity>
eVSRequest/ Required From state. Value should be passed as two- String minLength=2
FromState letter state abbreviation. maxLength=2
For example: <FromState>MD</FromState>
eVSRequest/ Required From ZIP code. String pattern=\d{5}
FromZip5
For example: <FromZip5>20212</FromZip5>
eVSRequest/ Optional From ZIP+4 extension. String minLength=0
FromZip4 pattern=\d{4}
For example: <FromZip4>2402</FromZip4>
8
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional From Phone #. 10 digits required (including String pattern=\d{30}
FromPhone area code), with no punctuation.
For example: <FromPhone>2125551234</
FromPhone>
Note: This field is used to return on the
receipt and label only when <ServiceType>=
“PRIORITY EXPRESS”.
eVSRequest/ Optional ZIP Code of Post Office or collection box String minLength=0
POZipCode where item is mailed. May be different than maxLength=5
FromZip5. This tag will take precedence over
FromZip5 when provided. Will be used to
populate the SSFv2.0 H1 pos. 7 Entry Facility
ZIP Code field.
For example: <POZipCode>20770</
POZipCode>
Note: Required when <ServiceType>=
“PARCEL SELECT DE”
eVSRequest/ Optional Allows Non-Validated Origin Street Address. Boolean Default=False
AllowNonCleansedO Enter “true” to bypass street address Enumerations=
riginAddr validation failures/errors or “false” if only • True
validated addresses should be allowed. • False
Address validation will always occur if a
matched valid address exists.
For example:
<AllowNonCleansedOriginAddr>True
</ AllowNonCleansedOriginAddr>
Note: Integrators are recommended to always
use “false” to ensure no delivery issues. In the
event USPS cannot validate the street
address, this tag will “bypass” address
validation error when “true” is indicated to
allow label creation which could impact
delivery. The <AllowNonCleansedOriginAddr>
excludes City, State, and ZIP Code which
must be valid for a successful response.
Reference
https://pe.usps.com/text/pub28/28c2_001.htm
.
9
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Required Values for either First and Last Name of String minLength=0
ToName Recipient or Firm must be sent. maxLength=100
For example: <ToName>Smith</ ToName>
Note: If a domestic customs form is required
based on Destination, Customs Content Type,
and Weight, then ToName must be used with
at least 2 names with a minimum of 2 alpha
characters A-Z each.
eVSRequest/ Required Values for either First and Last Name of String minLength=0
ToFirm Recipient or Firm must be sent. maxLength=50
For example: <ToFirm>ABC
CORPORATION</ ToFirm>
Note: Maximum length printed on the label is
28 characters for all <ServiceType>
enumerations. Values exceeding 28
characters will be truncated due to space
limitations on the label. API request eligible to
accept up to 50 characters.
eVSRequest/ Optional Recipient address line 1. Use this field for String minLength=0
ToAddress1 secondary address information such as an maxLength=50
apartment or suite number if applicable.
For example: <ToAddress1> Suite 4D
</ToAddress1>
Note: When populating the address fields, do
not include additional information such as
building name or company.
Note: Destination address ignored when
<ParcelLocker>=“true”. When shipping to a
Parcel Locker the <FacilityID> tag is required
and used to determine destination address.
eVSRequest/ Required Recipient address line 2. Use this field for a String minLength=1
ToAddress2 primary street address. maxLength=50
For example: <ToAddress2>1234 MAIN ST</
ToAddress2>
Note: When populating the address fields, do
not include additional information such as
building name or company.
Note: Destination address ignored when
<ParcelLocker>=“true”. When shipping to a
Parcel Locker the <FacilityID> tag is required
and used to determine destination address.
10
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ ToCity Required Recipient city. String minLength=0
maxLength=28
For example: <ToCity>ANYTOWN</ ToCity>
Note: Destination address ignored when
<ParcelLocker>=“true”. When shipping to a
Parcel Locker the <FacilityID> tag is required
and used to determine destination address.
eVSRequest/ Required Recipient state. String minLength=0
ToState pattern=\w{2}
For example: <ToState>MN</ ToState>
Note: Destination address ignored when
<ParcelLocker>=“true”. When shipping to a
Parcel Locker the <FacilityID> tag is required
and used to determine destination address.
eVSRequest/ Required Recipient ZIP code. String minLength=0
ToZip5 pattern=\d{5}
For example: <ToZip5>12345</ ToZip5>
Note: Destination address ignored when
<ParcelLocker>=“true”. When shipping to a
Parcel Locker the <FacilityID> tag is required
and used to determine destination address.
eVSRequest/ Optional Recipient ZIP+4 extension. String minLength=0
ToZip4 pattern=\d{4}
For example: <ToZip4>1844</ToZip4>
Note: Destination address ignored when
<ParcelLocker>=“true”. When shipping to a
Parcel Locker the <FacilityID> tag is required
and used to determine destination address.
eVSRequest/ Optional Recipient Phone #. If value is entered, 10 String pattern=\d{30}
ToPhone digits are required (including area code), with
no punctuation.
For example: <ToPhone>2125551234</
ToPhone>
Note: This field is used to return on the
receipt only when <ServiceType>=“PRIORITY
EXPRESS”.
eVSRequest/ Optional Indicates if destination address is a PO Box. Boolean Default=False
POBox Does not take precedent over Validated Enumerations=
Destination Street Address, see • True
<AllowNonCleansedDestAddr>. • False
For example: <POBox>True</ POBox>
11
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional This indicates how the recipient will be String whitespace=collapse
ToContactPreferenc notified that the package is available for Enumerations=
e pickup. Specify WAIVED if notification is not • EMAIL
desired. • EMAILSMS
For example: • SMS
<ToContactPreference>EMAIL</ • WAIVED
ToContactPreference>
Note: Required when <ParcelLocker>=“true”;
only “EMAIL” or “EMAILSMS” values
permitted.
eVSRequest/ Optional This contains a text messaging address or is String maxLength=64
ToContactMessagin blank depending on the ToContactPreference whitespace=collapse
g tag. If the EMAILSMS or SMS enumeration is pattern=\w{0}
used in ToContactPreference, this value must pattern=([\w_\-
be a syntactically valid email address. If \.]+)@(([\w-]+\.)+)[a-
EMAIL or WAIVED is used, this value must be zA-Z]{2,4}
blank.
For example:
<ToContactMessaging>
[email protected]</
ToContactMessaging>
eVSRequest/ Optional This contains an email address or is blank String minLength=0
ToContactEMail depending on the ToContactPreference tag. If pattern=([\w\-
the EMAILSMS or EMAIL enumeration is \.]+)@(([\w-]+\.)+)[a-
used in ToContactPreference, this value must zA-Z]{2,4}
be a syntactically valid email address. If SMS
or WAIVED is used, this value must be blank.
For example:
<ToContactEMail>
[email protected] </ ToContactEMail>
Note: Required when <ParcelLocker>=“true”
12
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Allows Non-Validated Destination Street Boolean Default=False
AllowNonCleansedD Address. Enter “true” to bypass street address Enumerations=
estAddr validation failures/errors or “false” if only • True
validated addresses should be allowed. • False
Address validation will always occur if a
matched valid address exists.
For example:
<AllowNonCleansedDestAddr>true</AllowNo
nCleansedDestAddr>
Note: Integrators are recommended to always
use “false” to ensure no delivery issues. In the
event USPS cannot validate the street
address, this tag will “bypass” address
validation error when “true” is indicated to
allow label creation which could impact
delivery. The <AllowNonCleansedDestAddr>
excludes City, State, and ZIP Code which
must be valid for a successful response.
Reference
https://pe.usps.com/text/pub28/28c2_001.htm
.
Note: Not applicable when shipping to a
Parcel Locker.
eVSRequest/ Required Package weight. Items must weigh 70 pounds String pattern=\d{0,4}
WeightInOunces (1120 ounces) or less.
For example: <WeightInOunces>80</
WeightInOunces>
13
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Required Mail service type desired. For example: String Enumerations=
ServiceType <ServiceType>PRIORITY</ServiceType> • PRIORITY
EXPRESS
Note: For Priority Mail Cubic and Ground
Advantage Cubic, the following is required: • PRIORITY
• <ServiceType> must equal “PRIORITY • PRIORITY MAIL
MAIL CUBIC” or “GROUND CUBIC
ADVANTAGE CUBIC” • GROUND
• <Container> must equal “CUBIC ADVANTAGE
PARCELS” or “CUBIC SOFT PACK” • GROUND
• <PriceOptions> can equal “Commercial ADVANTAGE
Plus” or “Commerical Base” CUBIC
It is recommended to pass the largest Cubic • LIBRARY
dimension as “Length” in <Length> request • MEDIA
tag and the second largest dimension as • BPM
“Width” in <Width> request tag. • PARCEL SELECT
DE
Note: When <ServiceType>=“PARCEL
SELECT DE”:
• Additional permissions are required
during setup otherwise an error will return.
Contact your TIS representative for
details.
• <POZipCode> request tag will be required
to collect Destination Entry Facility ZIP
Code and populate SSFv2.0 H1 pos. 7
Entry Facility ZIP Code field.
14
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Use to specify USPS containers/packaging or String whitespace=collapse
Container container attributes that may affect postage. If Default=VARIABLE
null value is supplied, then default container Enumerations=
will be “VARIABLE”. • VARIABLE
• FLAT RATE
For example: <Container>FLAT RATE ENVELOPE
ENVELOPE</Container> • LEGAL FLAT RATE
ENVELOPE
• PADDED FLAT
RATE ENVELOPE
• GIFT CARD FLAT
RATE ENVELOPE
• SM FLAT RATE
ENVELOPE
• WINDOW FLAT
RATE ENVELOPE
• SM FLAT RATE
BOX
• MD FLAT RATE
BOX
• LG FLAT RATE
BOX
• PACKAGE
SERVICE
• CUBIC PARCELS
• CUBIC SOFT PACK
eVSRequest/ Width Optional Value must be numeric. Units are inches. If Decimal minExclusive=0.0
partial dimensions are provided, an error totalDigits=10
response will return. Length, Width, Height
are required for accurate pricing of a
rectangular package when any dimension of
the item exceeds 12 inches. In addition, Girth
is required only for a non-rectangular package
in addition to Length, Width, Height when any
dimension of the package exceeds 12 inches.
For rectangular packages, the Girth
dimension must be left blank as this
dimension is to only be used for non-
rectangular packages.
For more details on dimensional weight
pricing or dimension validation reference
DMM
https://pe.usps.com/text/dmm300/index.htm
15
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Length Optional Value must be numeric. Units are inches. If Decimal minExclusive=0.0
partial dimensions are provided, an error totalDigits=10
response will return. Length, Width, Height
are required for accurate pricing of a
rectangular package when any dimension of
the item exceeds 12 inches. In addition, Girth
is required only for a non-rectangular package
in addition to Length, Width, Height when any
dimension of the package exceeds 12 inches.
For rectangular packages, the Girth
dimension must be left blank as this
dimension is to only be used for non-
rectangular packages.
For more details on dimensional weight
pricing or dimension validation reference
DMM
https://pe.usps.com/text/dmm300/index.htm
eVSRequest/ Height Optional Value must be numeric. Units are inches. If Decimal minExclusive=0.0
partial dimensions are provided, an error totalDigits=10
response will return. Length, Width, Height
are required for accurate pricing of a
rectangular package when any dimension of
the item exceeds 12 inches. In addition, Girth
is required only for a non-rectangular package
in addition to Length, Width, Height when any
dimension of the package exceeds 12 inches.
For rectangular packages, the Girth
dimension must be left blank as this
dimension is to only be used for non-
rectangular packages.
For more details on dimensional weight
pricing or dimension validation reference
DMM
https://pe.usps.com/text/dmm300/index.htm
16
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest / Girth Optional Value must be numeric. Units are inches. If Decimal minExclusive=0.0
partial dimensions are provided, an error totalDigits=10
response will return. Length, Width, Height
are required for accurate pricing of a
rectangular package when any dimension of
the item exceeds 12 inches. In addition, Girth
is required only for a non-rectangular package
in addition to Length, Width, Height when any
dimension of the package exceeds 12 inches.
For rectangular packages, the Girth
dimension must be left blank as this
dimension is to only be used for non-
rectangular packages.
For more details on dimensional weight
pricing or dimension validation reference
DMM
https://pe.usps.com/text/dmm300/index.htm
eVSRequest/ Optional Machinable parcels are defined as parcels String Default=True
Machinable less than or equal to 15”x18”x22” inches and Enumerations=
less than or equal 25 pounds. Any parcel that • True
exceeds either threshold (dimensions or • False
weight) will be considered nonmachinable.
Note: The API will validate provided
dimensions and/or weight to determine
machinability. In this case the <Machinable>
tag will be ignored. If these are not provided,
then the <Machinable> tag will be used to
designate if shipment is Machinable (True) or
Nonmachinable (False).
eVSRequest/ Optional Indicates pricing that should be returned. String Default=Commercial
PriceOptions For example: <PriceOptions>Commercial Base
Base</PriceOptions> Enumerations=
• Commercial Plus
Note: When <ServiceType>=“PRIORITY • Commercial Base
MAIL CUBIC”, <PriceOptions> must equal
“Commercial Plus”.
Note: A value of “Commercial Base” will
return “Commercial” prices if applicable.
Reference USPS Notice 123 Price List.
eVSRequest/ Optional Use this tag for entering an insurance Decimal Default=0
InsuredAmount amount, if applicable. minInclusive=0
For example: maxInclusive=9999.9
<InsuredAmount>100.00</InsuredAmount> 9
totalDigits=8
whitespace=collapse
17
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional You can request the USPS to alert you when Boolean Default=False
AddressServiceReq a customer changes their address. This Enumerations=
uested feature is especially useful to ensure correct • True
billing. The words “Address Service • False
Requested” will appear on the shipping label
immediately below the return address. By
using this tag, you will receive the following
service with Priority Mail: For 12 months after
an address change, the mail piece is
forwarded at no charge. However, a separate
notice of the new address is returned to you
and an address correction fee is charged. For
months 13-18 after an address change, the
mail piece is returned with the new address
attached at no charge. After 18 months, or if
undeliverable, the mail piece is returned with
the reason for nondelivery attached at no
charge. For fees for this service with Package
Services, refer to the Domestic Mail Manual.
For example:
<AddressServiceRequested>True</AddressS
erviceRequested>
eVSRequest/ Optional Groups Express Mail Delivery and Signature (group)
ExpressMailOptions options. Valid when
<ServiceType>=“PRIORITY EXPRESS”
18
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Indicates desired delivery option: String whitespace=collapse
ExpressMailOptions/ Default=1
DeliveryOption Service Option ServiceID Enumerations=
Normal Delivery •1
(Default) 1 •2
No Weekend Delivery 2 •3
No Holiday Delivery 3 •4
No Weekend or •5
Holiday Delivery 4 •6
No Saturday Delivery 5 •7
No Sunday Delivery 6 •8
Sunday Delivery 7 •9
Holiday Delivery 8 •E
No Sunday or •F
Holiday Delivery 9 •G
Scheduled End of
Day E
Scheduled End of
Day No Sun/ Hol
Delivery F
Scheduled End of
Day No Weekend/
Hol Delivery G
For example: <DeliveryOption>4</
DeliveryOption>
eVSRequest/ Optional No Signature Required for Delivery. Enter Boolean Default=True
ExpressMailOptions/ “True” if you do not want a signature for Enumerations=
WaiverOfSignature receipt of the package or “False” if you do. • True
For example: • False
<WaiverOfSignature>False</WaiverOfSignatu
re>
eVSRequest/ Optional Electronic Signature On File Allowed. This Boolean Default=True
ExpressMailOptions/ value is used to allow retailers to request that Enumerations=
eSOFAllowed Electronic Signature On File (eSOF) be • True
overridden such that a physical or “wet” • False
signature is required. This field should be
populated with “False” to request that the use
of eSOF be disallowed for the shipment.
Note: Integrators are allowed to populate
<ExpressMailOptions> / <eSOFAllowed> for
mail classes other than Priority Mail Express
when eSOL is available.
For example:
<eSOFAllowed>False</eSOFAllowed>
19
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Date Package Will Be Mailed. Ship date may String Default=Current Date
ShipDate be today plus 0 to 7 days in advance. Enter minLength=0
the date in either format: dd-mmm-yyyy (i.e., pattern=\d{1,2}/
14-Feb-2011) or mm/dd/yyyy (i.e., 02/14/ \d{1,2}/ \d\d(\d\d)?
2011). If <ShipDate> value is not provided,
the current date will be used for delivery date
calculations.
For example:
<ShipDate>02/14/2011</ShipDate>
eVSRequest/ Optional User-assigned Number for Internal Use. Up to String minLength=0
CustomerRefNo 30 characters accepted but only 18 will be maxLength=30
displayed on the shipping label image.
For example: <CustomerRefNo>XYZ 123</
CustomerRefNo>
The <CustomerRefNo> value will be used to
populate the SSFv2.0 D1 pos. 21 Customer
Reference Number field.
Note: The <PrintCustomerRefNo> must be
set to “true” to be printed on the label.
eVSRequest/ Optional User-assigned Number for Internal Use. Up to String minLength=0
CustomerRefNo2 30 characters accepted but only 18 will be maxLength=30
displayed on the shipping label image. Will be
positioned below the <CustomerRefNo> value
on the label image. The <CustomerRefNo2>
value will be used to populate the SSFv2.0 D1
pos. 76 Customer Reference Number 2 field.
Note: Required when
<ePostageMailerReporting>=“1” For example:
<CustomerRefNo2>XYZ 123</
CustomerRefNo2>
Note: The <PrintCustomerRefNo2> must be
set to “true” to be printed on the label.
eVSRequest/ Optional Groups extra services elements (Group)
ExtraServices
20
USPS Web Tools User Guide
eVSRequest/ Optional, Use to specify extra services. String whiteSpace=collapse
ExtraServices/ repeating Enumerations=
Service Name Service ID
ExtraService up to • 100
unbounde Insurance 100
• 101
d times Insurance (PME) 101
• 102
Return Receipt 102
• 105
Certified Mail 105
• 110
Return Receipt Electronic 110
• 118
Return Receipt Express Mail 118
• 119
Adult Signature 119
• 120
Adult Signature Restricted
• 125
Delivery 120
• 155
Insurance (PM) 125
• 156
USPS Tracking Electronic 155
• 170
Signature Confirmation
• 171
Electronic 156
• 172
Certified Mail Restricted
Delivery 170 • 174
Certified Mail Adult • 177
Signature Required 171 • 178
Certified Mail Adult • 179
Signature Restricted • 181
Delivery 172 • 182
Signature Confirmation HAZMAT Services:
Electronic Restricted • 810
Delivery 174 • 811
Insurance Restricted • 812
Delivery 177 • 813
Insurance Restricted • 814
Delivery (PME) 178 • 815
Insurance Restricted • 816
Delivery (PM) 179 • 817
Scan Retention 181 • 818
Scan + Signature Retention 182 • 819
HAZMAT Services Service ID • 820
Air Eligible Ethanol Package 810 • 821
Class 1 – Toy 811 • 822
Propellant/Safety Fuse • 823
Package • 824
Class 3 – Flammable Liquid 812 • 825
Package • 826
Class 7 – Radioactive 813 • 827
Materials Package • 828
Class 8 – Corrosive 814 • 829
Materials Package • 830
Class 8 – Nonspillable Wet 815 • 831
Battery Package • 832
Class 9 – Lithium Battery 816
Marked – Ground Only
Package
Class 9 – Lithium Battery – 817
Returns Package
21
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
Class 9 – Lithium batteries, 818
marked package
Class 9 – Dry Ice Package 819
Class 9 – Lithium batteries, 820
unmarked package
Class 9 – Magnetized 821
Materials Package
Division 4.1 – Flammable 822
Solids or Safety Matches
Package
Division 5.1 – Oxidizers 823
Package
Division 5.2 – Organic 824
Peroxides Package
Division 6.1 – Toxic 825
Materials Package
Division 6.2 – Infectious 826
Substances Package
Excepted Quantity Provision 827
Package
Ground Only Hazardous 828
Materials
ID8000 Consumer 829
Commodity Package
Lighters Package 830
LTD QTY Ground Package 831
Small Quantity Provision 832
Package
Note: When <ExtraService>=“125” is
indicated and insured amount is less than or
equal to $100, the insurance price returned
will be zero (“$0.00”) to reflect baked-in
insurance. If insured amount is greater than
$100, the insurance price returned will reflect
an extra cost since baked-in insurance was
exceeded.
Note: APO/FPO/DPO+PTFAS locations
(excluding Puerto Rico) support a limited list
of HAZMAT options and will NOT display
HAZMAT identifiers on the label.
eVSRequest/ Optional For future use. (Group)
HoldForPickup
eVSRequest/ Optional For future use. (Group)
OpenDistribute
eVSRequest/ Optional For future use. String
PermitNumber
eVSRequest/ Optional For future use. String
PermitZIPCode
22
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional For future use. String
PermitHolderName
eVSRequest/ CRID Optional Customer Registration ID, Represents Mail String minLength=0
Owner CRID. maxLength=15
Will be used to populate the SSFv2.0 D1 pos.
20 CRID field.
For example: <CRID>544762</CRID>
eVSRequest/ MID Optional Mailer ID (MID), Represents Mail Owner MID. String Length=6 or 9
Will be used to populate the SSFv2.0 D1 pos. positions if populated
13 Mail Owner MID field.
For example: <MID>847654321</MID>
eVSRequest/ Optional The MID of the company that manages the String Length=6 or 9
LogisticsManagerMI mailing. For example: positions if populated
D <LogisticsManagerMID>489001</
LogisticsManagerMID>
Will be used to populate the SSFv2.0 D1 pos
12 Logistics Manager MID field.
Note: If <LogisticsManagerMID> is populated,
either CRID or MID must also be populated.
eVSRequest/ Optional Code from vendor software to identify the String minLength=0
VendorCode developer of the shipping system. maxLength=4
Will be used to populate the SSFv2.0 H1 pos. default=8300
15 Software Vendor Code field.
For example:
<VendorCode>1234<VendorCode>
eVSRequest/ Optional Shipping software’s product version number. String minLength=0
VendorProductVersi Will be used to populate the SSFv2.0 H1 pos. maxLength=8
onNumber 16 Software Vendor Product Version Number
field.
For example:
<VendorProductVersionNumber>5.02.1B</Ve
ndorProductVersionNumber>
eVSRequest/ Optional The name of the person or company sending String minLength=0
SenderName the USPS tracking email notification. maxLength=50
Note: No email is returned when generating a
Sample (i.e., API=eVSCertify) request.
23
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Email address of sender used for USPS String minLength=0
SenderEMail tracking email notification. Valid email pattern=([\w\-
addresses must be used. \.]+)@(([\w-]+\.)+)[a-
zA-Z]{2,4}
Note: <RecipientEMail> must be populated to
generate USPS tracking email notification. If
<SenderEMail> provided without
<RecipientEMail>, USPS tracking email
notification will not be generated.
Note: No email is returned when generating a
Sample (i.e., API=eVSCertify) request.
eVSRequest/ Optional The name of the person or company receiving String minLength=0
RecipientName the USPS tracking email notification. If maxLength=50
recipient name not provided, email will be
addressed to <RecipientEMail> value
provided.
eVSRequest/ Optional Email address of recipient receiving the USPS String minLength=0
RecipientEMail tracking email notification. This field is pattern=([\w\-
required to generate tracking email. Valid \.]+)@(([\w-]+\.)+)[a-
email addresses must be used. zA-Z]{2,4}
Note: No email is returned when generating a
Sample (i.e., API=eVSCertify) request.
eVSRequest/ Optional Label & Receipt print layout options. Enter String Default=SAME PAGE
ReceiptOption "SEPARATE PAGE" if you want the shipping Enumerations=
label and online customer record printed on • SEPARATE PAGE
two separate pages, "SAME PAGE" if you • SAME PAGE
want them printed on the same single page, • NONE
or “NONE” if no receipt is requested.
For example: <ReceiptOption>SAME
PAGE</ReceiptOption>
Note: When <ImageParameter> is of a “4X6“
Portrait variation “4X6LABEL”, “4X6LABELP”,
“4X6LABELP PAGE”, “4X6ZPL203DPI”, or
“4X6ZPL300DPI”; a receipt will return in
<ReceiptImage> when SAME PAGE is
selected.
Note: When <ImageParameter> =
“4X6ZPL203DPI” or “4X6ZPL300DPI” a
receipt is eligible to return in <ReceiptImage>
but it will not be ZPL encoded.
24
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Required Label Image Type. String Enumerations=
ImageType For example: <ImageType>PDF</ • PDF
ImageType> • TIF
• NONE
Note: All <ImageType> values are ignored
when <ImageParameter>= “4X6ZPL203DPI”
or “4X6ZPL300DPI”.
eVSRequest/ Optional Restricted use. Holds manifest record for String Default=N
HoldForManifest possible inclusion in SCAN request. Enumerations=
•Y
•N
eVSRequest/ Optional Indicates if nine-digit routing ZIP code is Boolean Default=False
NineDigitRoutingZip included in the barcode. Enumerations=
For example: <NineDigitRoutingZip>False</ • True
NineDigitRoutingZip> • False
Note: This request tag must equal “true” for a
9-digit ZIP to be included in the barcode
otherwise, even if <ToZip4> is provided in the
request it will not be present in the barcode.
eVSRequest/ Optional (Deprecated) Indicates if revenue protection Boolean Default=False
ShipInfo information is printed on the label. Enumerations=
For example: <ShipInfo>False</ShipInfo> • True
• False
eVSRequest/ Optional Indicates if the ‘CARRIER – LEAVE IF NO Boolean Default=False
CarrierRelease RESPONSE’ is to be printed on the label. Enumerations=
This endorsement cannot be applied to • True
Express Mail or items requiring a signature at • False
delivery (e.g., Signature Confirmation,
Insurance > $500).
For example:
<CarrierRelease>False</CarrierRelease>
eVSRequest/ Optional Indicates the time the package will be Boolean
DropOffTime dropped off.
Time is specified in military time.
For example:
<DropOffTime>13:00</DropOffTime>
eVSRequest/ Optional Indicates that the CommitmentName and Boolean Default=False
ReturnCommitments Scheduled DeliveryDate will be returned in Enumerations=
the response. • True
For example: <ReturnCommitments>False</ • False
ReturnCommitments>
eVSRequest/ Optional Print <CustomerRefNo> in the additional Boolean Default=False
PrintCustomerRefNo information section. Enumerations=
• True
Note: For the <CustomerRefNo> value to • False
print on the label you must also indicate
“True” for the <PrintCustomerRefNo> tag.
25
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Print <CustomerRefNo2> in the additional Boolean Default=False
PrintCustomerRefNo information section. Enumerations=
2 • True
Note: For the <CustomerRefNo2> value to • False
print on the label you must also indicate
“True” for the <PrintCustomerRefNo2> tag.
eVSRequest/ Optional Groups Content (Group)
Content
eVSRequest/ Condition Use to specify ContentType. Currently String Enumerations=
Content/ ally available types are: • CrematedRemains
ContentType Required ContentType • Lives
(Required CrematedRemains • Perishable
when • Pharmaceuticals
Lives
Content • MedicalSupplies
grouping Perishable
is Pharmaceuticals
included) MedicalSupplies
For example:
<ContentType>Lives</ContentType >
Note: A <ContentType> is not allowed if
ParcelLocker is true.
eVSRequest/ Condition Use to specify Content Description. Required String Enumerations=
Content/ ally when <ContentType>Lives</ ContentType> is • Bees
ContentDescription Required supplied. Valid Values • DayOldPoultry
ContentDescription • AdultBirds
Bees • Other
DayOldPoultry
AdultBirds
Other
For
example:<ContentDescription>DayOldPoultry
</ContentDescription>
eVSRequest/Action Optional Used to specify the SPE action code. Value is String Default=M0
Code included in the Shipping Partner Event (SPE) Enumerations=
file for customers who have chosen to have a • M0
Shipping Partner Event file submitted to • S0
USPS on their behalf.
M0 – Mailer Owner
S0 – Service Provider
For example: <ActionCode>M0</ActionCode>
eVSRequest/ Optional Used to specify if a Shipping Partner Event Boolean Default=true
OptOutOfSPE (SPE) file will be created. Use “false” to create Enumerations=
an SPE file. • true
For example: • false
<OptOutOfSPE>false</OptOutOfSPE>
Note: This request tag is case sensitive.
26
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Presort grouping of mail. String Enumerations=
SortationLevel • 3D
Sortation Level Value
• None
3-Digit 3D
• NDC
Origin Entry None
• Mix
3-Digit implied Mix
• SCF
3-Digit implied SCF
5-Digit 5D • 5D
eVSRequest/ Condition Note: Required when <ServiceType>= String Enumerations=
DestinationEntryFaci ally “PARCEL SELECT DE”. • DDU
lityType Required • DHUB
Destination Type Value
Destination Delivery Unit DDU • DSCF
Destination Hub DHUB • NONE
Destination Sectional DSCF
Center Facility
eVSRequest/ Condition Barcode on container 1. String maxLength=34,
ContainerID1 ally For example: minLength=0
Required <ContainerID1>222010127123456789912345 Alphanumeric (34)
</ContainerID1>
Note: Required when
<DestinationEntryFacilityType>=“DSCF”
eVSRequest/ Optional Barcode on container 2. String maxLength=34,
ContainerID2 For example: minLength=0
<ContainerID2>222010127123456789912345 Alphanumeric (34)
</ContainerID2>
eVSRequest/ Optional Barcode on container 3. String maxLength=34,
ContainerID3 For example: minLength=0
<ContainerID3>222010127123456789912345 Alphanumeric (34)
</ContainerID3>
eVSRequest/ Condition Describes type of container for ContainerID1. String maxLength=2,
SortContainerType1 ally minLength=0
Note: Required if <ContainerID1> is
Required Enumerations=
populated
• PT
Sort Container Value • SK
Pallet PT
Sack SACK
eVSRequest/ Condition Describes type of container for ContainerID2. String maxLength=2,
SortContainerType2 ally minLength=0
Note: Required if <ContainerID2> is
Required Enumerations=
populated
• PT
• SK
eVSRequest/ Condition Describes type of container for ContainerID3. String maxLength=2,
SortContainerType3 ally minLength=0
Note: Required if <ContainerID3> is
Required Enumerations=
populated
• PT
• SK
27
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional This tag is used to pass applicable discount String maxLength=2,
DiscountType codes. Refer to Pub199, Appendix J, Table 6 minLength=0
for the complete list of Discount Type codes 2-digit alphanumeric
https://postalpro.usps.com/pub199. Will be
used to populate the SSFv2.0 D1 pos. 59
Discount Type field.
For Example:
<DiscountType>D1</DiscountType>
eVSRequest/ Optional This tag is used to pass the discount fee. Will Decimal maxLength=8,
DiscountAmount be used to populate the SSFv2.0 D1 pos. 60 minLength=0
Discount Amount field.
For Example:
<DiscountAmount>20.00</DiscountAmount>
eVSRequest/ Condition This tag is used to pass applicable surcharge String maxLength=2,
SurchargeType ally codes. Refer to Pub199, Appendix J, Table 13 minLength=0
Required for the complete list of Surcharge Type codes 2-digit alphanumeric
https://postalpro.usps.com/pub199. Will be
used to populate the SSFv2.0 D1 pos. 57
Surcharge Type field.
For Example:
<SurchargeType>E2</<SurchargeType>
Note: Required when <NextDay>=“Y”.
eVSRequest/ Condition This tag is used to pass the surcharge fee. Decimal maxLength=7,
SurchargeAmount ally Will be used to populate the SSFv2.0 D1 pos. minLength=0
Required 58 Surcharge Amount field.
For Example:
<SurchargeAmount>20.00</SurchargeAmoun
t>
Note: Required when <NextDay>=“Y”.
eVSRequest/ Optional This tag is used to pass a Pickup on Demand String maxLength=3,
ShipmentFeeCode fee code. Will be used to populate the minLength=0
SSFv2.0 H1 pos. 10 Shipment Fee Code Alphanumeric (3)
field.
For Example:
<ShipmentFeeCode>PKF</ShipmentFeeCod
e>
eVSRequest/ Optional This tag is used to pass a Pickup on Demand Decimal maxLength=7,
ExtraFeeForShipme fee. Will be used to populate the SSFv2.0 H1 minLength=0
nt pos. 11 Extra Fee for Shipment field.
pattern=
For Example:
^\d{1,4}([.]\d{1,2})?$
<ExtraFeeForShipment>20.00</ExtraFeeFor
Shipment>
28
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Same Day/Next Day Program Indicator Boolean Default=N
NextDay Enumerations=
Note: When “Y”, <SurchargeType> of “E2” •Y
(Same Day/Next Day) and •N
<SurchargeAmount> required otherwise an
error will be returned.
Note: When “Y”, "SAME DAY DELIVERY"
endorsement and carrier release “CARRIER –
LEAVE IF NO RESPONSE" markings will be
displayed on the label.
Note: <NextDay> indicator will take
precedence over <CarrierRelease> tag when
determining markings printed on the label.
eVSRequest / Condition Required only if a domestic integrated (Group)
ShippingContents ally customs form is required based on
Required Destination, Customs Content Type, and
for Weight, usually when shipping to/from
Customs APO/FPO/DPO+PTFAS locations.
Forms
eVSRequest / Required Required once repeating up to 30 times if (Group)
ShippingContents / Once generating an Integrated Customs Form,
ItemDetail repeating otherwise not required
up to 30
times
eVSRequest / Required Description of the item. Per international String minLength=2
ShippingContents / shipping regulatory mandates, shipments to maxLength=30
ItemDetail / European Union (EU) countries are required
Description to contain a valid Harmonization Code and
Content/Item description. To learn more about
providing acceptable item descriptions, view
the chart in Appendix D or read the EU’s
guidance on acceptable terms at Guidance on
Acceptable and Unacceptable Terms for the
Description of Goods.
Note: If an origin/destination combination
requires an Integrated Customs Form, vague
item descriptions will return an error: none,
not applicable, n/a, null, gift, merchandise
For example: <Description>Policy guidelines
document</Description>
eVSRequest / Required Quantity of the item. Integer value required. Integer whitespace=collapse
ShippingContents / Required only if a domestic customs form is maxInclusive
ItemDetail /Quantity required. value=9999
For example: <Quantity>1</Quantity>
29
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest / Required The data entered with this tag provides the Decimal minExclusive value=0
ShippingContents / value of the set of items. If the item is 2 boxes totalDigits value=8
ItemDetail / Value of 50 pens and the value of each box is maxInclusive
$10.00, "20.00" (2 boxes x $10.00) should be value=99999.99
entered. If the value of each pen is .25 then
"25.00" (100 pens x .25) should be entered.
Required only if a domestic customs form is
required.
For example: <Value>55.00</Value>
eVSRequest / Condition Provide the pounds OR ounces component of Integer totalDigits value=2
ShippingContents / ally the weight of the individual item listed in minInclusive
ItemDetail / Required <ItemDetail>/<Description> when a domestic value=0
NetPounds customs form is required. Net weight of all maxInclusive
<ShippingContents> must be less than value=70
<WeightInOunces> if a customs form is
required.
For example: <NetPounds>1</NetPounds>
eVSRequest / Condition Provide the ounces OR pounds component of Decimal totalDigits value=5
ShippingContents / ally the weight of the individual item listed in minInclusive value=0
ItemDetail / Required <ItemDetail>/<Description> when a domestic maxInclusive
NetOunces customs form is required. Net weight of all value=1120
<ShippingContents> must be less than
<WeightInOunces> if a customs form is
required.
For example: <NetOunces>5</NetOunces>
eVSRequest / Optional For commercial items only. HS Tariff String minLength=0
ShippingContents / Numbers must be based on the Harmonized maxLength=17
ItemDetail / Commodity Description and Coding System
HSTariffNumber developed by the World Customs
Organization.
Per international shipping regulatory
mandates, shipments to European Union (EU)
countries are required to contain a valid
Harmonization Code and Content/Item
description.
For example:
<HSTariffNumber>4901.10.0000</HSTariffNu
mber>
eVSRequest / Optional The country where the goods originated, e.g., String minLength=0
ShippingContents / were produced, manufactured, or assembled. maxLength=100
ItemDetail / The <CountryOfOrigin> value entered must
CountryOfOrigin match an entry from the USPS-approved
International Index of Countries (see
http://pe.usps.com/text/imm/immctry.htm) and
Localities or be "United States".
For example: <CountryOfOrigin>United
States</CountryOfOrigin>
30
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest / Optional Item Category. Per international shipping String
ShippingContents / regulatory mandates, shipments to European
ItemDetail / Union (EU) countries are required to contain a
ItemCategory valid Harmonization Code and Content/Item
description. To learn more about providing
acceptable item descriptions, view the chart in
Appendix D or read the EU’s guidance on
acceptable terms at Guidance on Acceptable
and Unacceptable Terms for the Description
of Goods.
eVSRequest / Optional Item Subcategory. Per international shipping String
ShippingContents / regulatory mandates, shipments to European
ItemDetail / Union (EU) countries are required to contain a
ItemSubCategory valid Harmonization Code and Content/Item
description. To learn more about providing
acceptable item descriptions, view the chart in
Appendix D or read the EU’s guidance on
acceptable terms at Guidance on Acceptable
and Unacceptable Terms for the Description
of Goods.
eVSRequest / Condition Specifies the content of the package or String minOccurs=0
CustomsContentTyp ally envelope. Field required if a domestic Enumerations=
e Required integrated customs form is required based on • MERCHANDISE
Destination, Customs Content Type, and • GIFT
Weight. • DOCUMENTS
For example: • SAMPLE
<CustomsContentType>DOCUMENTS</Cust • RETURN
omsContentType> • OTHER
• HUMANITARIAN
Note: If the <CustomsContentType> value is
“DOCUMENTS” and <WeightInOunces> is
less than 16 oz. then a domestic customs
form is not required. Integrators should
include optional fields used for customs forms
to pass data electronically to the SSF.
Reference DMM for more information:
http://pe.usps.com/text/dmm300/608.htm#125
5642.
eVSRequest / Optional Required tag if String minOccurs=0
ContentComments <CustomsContentType>=Other maxLength=25
Enter any comments. For example:
<ContentComments>Parts</ContentCommen
ts>
31
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest / Optional Restriction Types String minOccurs=0
RestrictionType Enumerations=
• Quarantine
• Sanitary Inspection
• Phytosanitary
Inspection
• Other
eVSRequest / Optional Restriction Comments. Required when String minOccurs=0
RestrictionComment <RestrictionType>="Other”
s
eVSRequest / Optional AES/ITN Exemption is a code that indicates String minOccurs=0
AESITN the reason why you did not need to file
electronic export information
eVSRequest / Optional Importers Reference. The Importer’s String minOccurs=0
ImportersReference Reference might be a tax code, importer maxLength=40
code, or VAT number used for sales tax.
P.S. Form 2976-A and P.S. Form 2976-B will
print <ImportersReference> in the Importers
Reference field. P.S. Form 2976 will optionally
print <ImportersReference> in TO address
block when <PrintImportersReference> is
indicated true.
Note: Requires <ImportersReferenceType> to
be specified if used.
eVSRequest / Optional Importers Contact. Enter, if known, the String minOccurs=0
ImportersContact Importer’s telephone number, fax number, or
email address, as such information might
facilitate customs clearance or delivery.
eVSRequest / Optional Exporters Reference. The Exporter’s String minOccurs=0
ExportersReference Reference might be a tax code, importer maxLength=14
code, or VAT number used for sales tax.
eVSRequest / Optional Exporters Contact. Enter, if known, the String minOccurs=0
ExportersContact Exporter’s telephone number, fax number, or
email address, as such information might
facilitate customs clearance or delivery.
eVSRequest / Optional Invoice Number String minOccurs=0
InvoiceNumber maxOccurs=15
eVSRequest / Optional License Number String minOccurs=0
LicenseNumber maxOccurs=16
eVSRequest / Optional Certificate Number String minOccurs=0
CertificateNumber maxOccurs=12
32
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest / Optional In case package is undeliverable, enter one of String Enumerations=
NonDeliveryOption the following: "RETURN" for package to be • RETURN
returned to <FromAddress> above. • REDIRECT
"REDIRECT" to return package to address • ABANDON
specified in the below tags. "ABANDON" to
dispose of undeliverable package.
For example:
<NonDeliveryOption>RETURN</NonDelivery
Option>
eVSRequest / Optional Required when String minOccurs=0
AltReturnAddress1 <NonDeliveryOption>=“REDIRECT”.
Suggested use of this tag is for the Recipient
Name.
For example: <AltReturnAddress1>Recipient
Name</AltReturnAddress1>
eVSRequest / Optional Required when String minOccurs=0
AltReturnAddress2 <NonDeliveryOption>=“REDIRECT”.
Suggested use of this tag is the Recipient
Address. Must be a valid address and include
primary and secondary address information.
For example: <AltReturnAddress2>123 Main
Ave Ste 1</ AltReturnAddress2>
eVSRequest / Optional Required when String minOccurs=0
AltReturnAddress3 <NonDeliveryOption>=“REDIRECT”.
Suggested use of this tag is the Recipient
City.
eVSRequest / Optional Required when String minOccurs=0
AltReturnAddress4 <NonDeliveryOption>=“REDIRECT”.
Suggested use of this tag is the Recipient
State. Use 2-letter USPS abbreviation.
eVSRequest / Optional Required when String minOccurs=0
AltReturnAddress5 <NonDeliveryOption>=“REDIRECT”.
Suggested use of this tag is the Recipient ZIP
Code.
eVSRequest / Optional Required when String minOccurs=0
AltReturnAddress6 <NonDeliveryOption>=“REDIRECT”.
Suggested use of this tag is the Recipient
ZIP+4 extension
eVSRequest / Optional Required when String minOccurs=0
AltReturnCountry <NonDeliveryOption>=“REDIRECT”.
Country. Tag must equal United States for
this API.
eVSRequest/ Optional (Deprecated) String
LabelImportType
33
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Used to identify ePostage sender/mailer and String Enumerations=
ePostageMailerRep include Sender information in SSF. •1
orting • 1 (ePostage sender info in SSF) •2
• 2 (ePostage sender info through DES) •3
• 3 (ePostage sender info using child MID)
Verifies Sender informationsender fields are
provided and must match From information
when <ePostageMailerReporting>=1
ePostageMailerReporting value used in SSF
for “PostageType”
eVSRequest/ Optional First Name of Sender. String minLength=0,
SenderFirstName For example: <SenderFirstName>Adam </ maxLength=49
SenderFirstName>
Required when
<ePostageMailerReporting>=1
eVSRequest/ Optional Last Name of Sender. String minLength=0,
SenderLastName For example: <SenderLastName>Smith </ maxLength=75
SenderLastName>
Required when
<ePostageMailerReporting>=1
eVSRequest/ Optional Values for Sender Business Name must be String minLength=0,
SenderBusinessNa sent. maxLength=100
me For example:
<SenderBusinessName>USPS</
SenderBusinessName>
eVSRequest/ Optional Sender address. Use this tag for complete String minLength=0,
SenderAddress1 sender address maxLength=148
For example: <SenderAddress1>123 Main St
STE 150</ SenderAddress1>
Required when
<ePostageMailerReporting>=1
eVSRequest/ Optional Sender city. String minLength=0,
SenderCity For example: <SenderCity>BETHESDA</ maxLength=50
SenderCity> Required when
<ePostageMailerReporting>=1
eVSRequest/ Optional Sender state. String minLength=0,
SenderState For example: <SenderState>MD</ maxLength=2
SenderState> Required when
<ePostageMailerReporting>=1
eVSRequest/ Optional Sender ZIP code. String minLength=0,
SenderZip5 For example: pattern=d[5]
<SenderZip5>20212</SenderZip5>
Required when
<ePostageMailerReporting>=1
34
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest/ Optional Sender Phone #. 10 digits required (including String minLength=0,
SenderPhone area code), with no punctuation. pattern=d[30]
For example: <SenderPhone>2125551234</
SenderPhone>
Required when
<ePostageMailerReporting>=1
eVSRequest / Optional Used in Shipping Services File v2.0 for G- String 123456
ChargebackCode 10/OMAS labels. Contact your Technical (alphanumeric)
Integration Specialist for details.
eVSRequest / Optional Used to determine period of Retention for String minOccurs=0
TrackingRetentionP tracking data. Required when maxOccurs=1
eriod <ExtraService>= “181” or “182”. Enumerations=
<TrackingRetention • 0.5
ServiceID
Period> •1
181 “0.5” (6 Months) •3
181 “1” (1 Year) •5
181 “3” (3 Years) •7
181 “5” (5 Years)
181 “7” (7 Years)
182 “3” (3 Years)
182 “5” (5 Years)
182 “7” (7 Years)
eVSRequest/Return Optional Used to show additional pricing and package Boolean Default=false
Fees details. Include <Fees>=“true” in request to
Enumerations=
return <Fees> response tag with breakdown
of fees applied to postage and <Attributes> • true
response tag with package details. • false
eVSRequest / Optional Collects the original tracking number (i.e., String
OriginalTrackingNu IMpb) over labeled on the package. Value
mber must be numeric and correspond to defined
IMpb barcode lengths per USPS Pub 199.
OriginalTrackingNumberConstruct must be
provided when OriginalTrackingNumber is
populated.
eVSRequest / Optional This indicates how the sender will be notified String Enumerations=
FromContactPrefere that the package is available for pickup. • EMAIL
nce Specify WAIVED if notification is not desired. • SMS
• EMAILSMS
Note: Required when <ParcelLocker>=“true” • WAIVED
For example:
<FromContactPreference>EMAIL</
FromContactPreference>
35
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest / Optional This field collects phone number for SMS String
FromContactMessa notifications.
ge Note: Required when
<FromContactPreference>=“SMS” or
“EMAILSMS”
When <FromContactPreference>=WAIVED,
this value must be blank.
eVSRequest / Optional This field collects email address for EMAIL String
FromContactEMail notifications.
Note: Required when
<FromContactPreference>=“EMAIL” or
“EMAILSMS”
When <FromContactPreference>=“WAIVED”,
this value must be blank.
eVSRequest / Optional Used to indicate package will be shipped to a Boolean Default=false
ParcelLocker Parcel Locker. Enumerations=
• true
For example: <ParcelLocker>=“true” • false
eVSRequest / Optional Used to specify Parcel Locker destination String
FacilityID when shipping to a Parcel Locker.
Required when <ParcelLocker>=“true”.
FacilityID obtained from
USPSParcelLockerLookup API. Used for
destination address instead of ToAddress
fields.
eVSRequest / Optional Tax code / VAT no. / Importer Code String minOccurs=0
ImportersReference Enumerations=
Type Note: Required when <ImportersReference> • TAXCODE
is used. • VAT
• IMPORTERCOD
E
eVSRequest / Optional Barcode construct code for String
OriginalTrackingNu <OriginalTracking>. Value must be valid 3-
mberConstruct character IMpb barcode construct defined in
USPS Pub 199 Appendix J Table 1.
For Example:
<OriginalTrackingNumberConstruct>C01</Ori
ginalTrackingNumberConstruct>
eVSRequest / Optional A value of “true” will print the Boolean Default=false
PrintImportersRefer <ImportersReference> value on the P.S. enumeration=
ence Form 2976 in the upper left corner of the TO • true
block section whenever a P.S. Form 2976 is • false
returned by the response.
36
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSRequest / Optional Supports Nonstandard Package Boolean Default=false
NonstandardPkgCh Characteristic Fees. Indicates if package has Enumerations=
ar nonstandard characteristics (i.e., cylindrical • true
tubes and rolls, wood or metal boxes etc.) • false
If both the Nonstandard Length Fee and
Nonstandard Package Characteristic Fee
apply, only the greater of the two fees will be
charged.
If the Nonstandard Package Characteristics
Fee is charged it will display in the API
response <Fees> group as <FeeType>Non-
Standard Characteristics</FeeType> when
<ReturnFees> is true.
eVSRequest Required (alias)
Request
2.2.1 Sample Request
Request: eVS - Domestic
<eVSRequest USERID="XXXXXXXXX" PASSWORD="XXXXXXXXX">
<Option></Option>
<Revision>3</Revision>
<ImageParameters>
<LabelSequence>
<PackageNumber>1</PackageNumber>
<TotalPackages>1</TotalPackages>
</LabelSequence>
</ImageParameters>
<FromName>Lina Smith</FromName>
<FromFirm>Horizon</FromFirm>
<FromAddress1>Apt 303</FromAddress1>
<FromAddress2>1309 S Agnew Avenue</FromAddress2>
<FromCity>Oklahoma City</FromCity>
<FromState>OK</FromState>
<FromZip5>73108</FromZip5>
<FromZip4>2427</FromZip4>
<FromPhone>1234567890</FromPhone>
<POZipCode/>
<AllowNonCleansedOriginAddr>false</AllowNonCleansedOriginAddr>
<ToName>Tall Tom</ToName>
<ToFirm>ABC Corp.</ToFirm>
<ToAddress1/>
<ToAddress2>1098 N Fraser Street</ToAddress2>
<ToCity>Georgetown</ToCity>
<ToState>SC</ToState>
<ToZip5>29440</ToZip5>
<ToZip4>2849</ToZip4>
<ToPhone>8005554526</ToPhone>
<POBox/>
<ToContactPreference>email</ToContactPreference>
37
USPS Web Tools User Guide
<ToContactMessaging/>
<ToContactEMail>[email protected]</ToContactEMail>
<AllowNonCleansedDestAddr>false</AllowNonCleansedDestAddr>
<WeightInOunces>32</WeightInOunces>
<ServiceType>PRIORITY</ServiceType>
<Container>VARIABLE</Container>
<Width>5.5</Width>
<Length>11</Length>
<Height>11</Height>
<Machinable></Machinable>
<PriceOptions/>
<InsuredAmount>100.00</InsuredAmount>
<AddressServiceRequested>true</AddressServiceRequested>
<ExpressMailOptions>
<DeliveryOption/>
<WaiverOfSignature/>
</ExpressMailOptions>
<ShipDate></ShipDate>
<CustomerRefNo>EF789UJK</CustomerRefNo>
<CustomerRefNo2>EE66GG87</CustomerRefNo2>
<ExtraServices>
<ExtraService>120</ExtraService>
</ExtraServices>
<HoldForPickup/>
<OpenDistribute/>
<PermitNumber/>
<PermitZIPCode/>
<PermitHolderName/>
<CRID>4569873</CRID>
<MID>456789354</MID>
<VendorCode>1234</VendorCode>
<VendorProductVersionNumber>5.02.1B</VendorProductVersionNumber>
<SenderName>Adam Johnson</SenderName>
<SenderEMail>[email protected]</SenderEMail>
<RecipientName>Robert Jones</RecipientName>
<RecipientEMail>[email protected]</RecipientEMail>
<ReceiptOption>SAME PAGE</ReceiptOption>
<ImageType>PDF</ImageType>
<HoldForManifest>N</HoldForManifest>
<NineDigitRoutingZip>false</NineDigitRoutingZip>
<CarrierRelease>False</CarrierRelease>
<DropOffTime/>
<ReturnCommitments>True</ReturnCommitments>
<PrintCustomerRefNo>False</PrintCustomerRefNo>
<PrintCustomerRefNo2>True</PrintCustomerRefNo2>
<Content>
<ContentType>Lives</ContentType>
<ContentDescription>Bees</ContentDescription>
</Content>
<ActionCode>M0</ActionCode>
<OptOutOfSPE>false</OptOutOfSPE>
<SortationLevel/>
<DestinationEntryFacilityType/>
<ReturnFees>true</ReturnFees>
38
USPS Web Tools User Guide
</eVSRequest>
Request: eVS – returns integrated Customs Form required for APO/FPO/DPO+PTFAS destinations:
<eVSRequest USERID="XXXXXXXXX" PASSWORD="XXXXXXXXX">
<Option></Option>
<Revision>3</Revision>
<ImageParameters>
<LabelSequence>
<PackageNumber>2</PackageNumber>
<TotalPackages>3</TotalPackages>
</LabelSequence>
</ImageParameters>
<FromName>Joe Smith</FromName>
<FromFirm>ABC Corp.</FromFirm>
<FromAddress1>Apt 303</FromAddress1>
<FromAddress2>1309 S Agnew Avenue</FromAddress2>
<FromCity>Oklahoma City</FromCity>
<FromState>OK</FromState>
<FromZip5>73108</FromZip5>
<FromZip4>2427</FromZip4>
<FromPhone>5708208072</FromPhone>
<POZipCode></POZipCode>
<AllowNonCleansedOriginAddr>false</AllowNonCleansedOriginAddr>
<ToName>Tom Collins</ToName>
<ToFirm>XYZ Corp.</ToFirm>
<ToAddress1></ToAddress1>
<ToAddress2>PSC 0000</ToAddress2>
<ToCity>DPO</ToCity>
<ToState>AE</ToState>
<ToZip5>09880</ToZip5>
<ToZip4></ToZip4>
<ToPhone>8005554526</ToPhone>
<POBox>False</POBox>
<AllowNonCleansedDestAddr>false</AllowNonCleansedDestAddr>
<WeightInOunces>36</WeightInOunces>
<ServiceType>PRIORITY</ServiceType>
<Container>VARIABLE</Container>
<Width>5</Width>
<Length>5</Length>
<Height>4</Height>
<Machinable>True</Machinable>
<PriceOptions></PriceOptions>
<InsuredAmount>1000</InsuredAmount>
<AddressServiceRequested>True</AddressServiceRequested>
<ExpressMailOptions>
<DeliveryOption></DeliveryOption>
<WaiverOfSignature></WaiverOfSignature>
</ExpressMailOptions>
<ShipDate></ShipDate>
<CustomerRefNo>EF789UJK</CustomerRefNo>
<ExtraServices>
<ExtraService></ExtraService>
</ExtraServices>
<HoldForPickup></HoldForPickup>
39
USPS Web Tools User Guide
<OpenDistribute></OpenDistribute>
<PermitNumber></PermitNumber>
<PermitZIPCode></PermitZIPCode>
<PermitHolderName></PermitHolderName>
<CRID></CRID>
<SenderName>Joe Smith</SenderName>
<SenderEMail>[email protected]</SenderEMail>
<RecipientName>Tom XofY</RecipientName>
<RecipientEMail>[email protected]</RecipientEMail>
<ReceiptOption>Same Page</ReceiptOption>
<ImageType>PDF</ImageType>
<HoldForManifest>N</HoldForManifest>
<NineDigitRoutingZip>False</NineDigitRoutingZip>
<CarrierRelease>False</CarrierRelease>
<ReturnCommitments>True</ReturnCommitments>
<PrintCustomerRefNo>True</PrintCustomerRefNo>
<Content>
<ContentType>PERISHABLE</ContentType>
</Content>
<ShippingContents>
<ItemDetail>
<Description>Cleaning Wipes</Description>
<Quantity>1</Quantity>
<Value>15</Value>
<NetPounds>2</NetPounds>
<NetOunces>0</NetOunces>
<HSTariffNumber>490110</HSTariffNumber>
<CountryOfOrigin>UNITED STATES</CountryOfOrigin>
</ItemDetail>
</ShippingContents>
<CustomsContentType>MERCHANDISE</CustomsContentType>
<ContentComments>Wipes</ContentComments>
<RestrictionType>Sanitary Inspection</RestrictionType>
<RestrictionComments>Sanitary Wipes</RestrictionComments>
<AESITN>12345678901234567890123456789012345</AESITN>
<ImportersReference>123456789012345678901234567890</ImportersReference>
<ImportersContact>Importers Contact: This field can be 50 chars long</ImportersContact>
<ExportersReference>12345678901234</ExportersReference>
<ExportersContact>Exporters Contact: This field can be 50 chars long</ExportersContact>
<InvoiceNumber>Invoice89012345</InvoiceNumber>
<LicenseNumber>License Number12</LicenseNumber>
<CertificateNumber>CertificateX</CertificateNumber>
<ReturnFees>false</ReturnFees>
<ImportersReferenceType>TAXCODE</ImportersReferenceType>
</eVSRequest>
Request: eVS – Parcel Select DE
<eVSRequest USERID="XXXXXXXXX" PASSWORD="XXXXXXXXX">
<Option></Option>
<Revision>3</Revision>
<FromName>Joe Smith</FromName>
<FromFirm>ABC Corp.</FromFirm>
<FromAddress1>Suite 101</FromAddress1>
40
USPS Web Tools User Guide
<FromAddress2>901 D Street SW</FromAddress2>
<FromCity>Washington</FromCity>
<FromState>DC</FromState>
<FromZip5>20024</FromZip5>
<FromZip4>2198</FromZip4>
<FromPhone>5708208072</FromPhone>
<POZipCode>73108</POZipCode>
<AllowNonCleansedOriginAddr>FALSE</AllowNonCleansedOriginAddr>
<ToName>Tom Collins</ToName>
<ToFirm>XYZ Corp.</ToFirm>
<ToAddress1/>
<ToAddress2>200 Short Blvd</ToAddress2>
<ToCity>Dallas</ToCity>
<ToState>TX</ToState>
<ToZip5>75232</ToZip5>
<ToZip4>1300</ToZip4>
<ToPhone>3018889999</ToPhone>
<POBox/>
<AllowNonCleansedDestAddr>FALSE</AllowNonCleansedDestAddr>
<WeightInOunces>5</WeightInOunces>
<ServiceType>Parcel Select DE</ServiceType>
<Container>VARIABLE</Container>
<Width>2</Width>
<Length>2</Length>
<Height>2</Height>
<Machinable></Machinable>
<InsuredAmount>600</InsuredAmount>
<AddressServiceRequested>false</AddressServiceRequested>
<ShipDate>10/03/2022</ShipDate>
<CustomerRefNo>ABCDEFGH</CustomerRefNo>
<CustomerRefNo2>ABCDEFGH</CustomerRefNo2>
<ExtraServices>
<ExtraService>100</ExtraService>
</ExtraServices>
<SenderName>Jose Abcdef</SenderName>
<SenderEMail>
[email protected]</SenderEMail>
<RecipientName>Robert Meier</RecipientName>
<RecipientEMail>
[email protected]</RecipientEMail>
<ReceiptOption>SAME PAGE</ReceiptOption>
<ImageType>PDF</ImageType>
<HoldForManifest>Y</HoldForManifest>
<CarrierRelease>false</CarrierRelease>
<ReturnCommitments>true</ReturnCommitments>
<PrintCustomerRefNo>true</PrintCustomerRefNo>
<PrintCustomerRefNo2>true</PrintCustomerRefNo2>
<SortationLevel>None</SortationLevel>
<DestinationEntryFacilityType>DSCF</DestinationEntryFacilityType>
<ContainerID1>1234567890</ContainerID1>
<ContainerID2>12345678901</ContainerID2>
<ContainerID3>123456789012</ContainerID3>
<SortContainerType1>PT</SortContainerType1>
<SortContainerType2>SK</SortContainerType2>
<SortContainerType3>PT</SortContainerType3>
<DiscountType>D6</DiscountType>
41
USPS Web Tools User Guide
<DiscountAmount>12</DiscountAmount>
<SurchargeType>E2</SurchargeType>
<SurchargeAmount>100</SurchargeAmount>
<ShipmentFeeCode>A14</ShipmentFeeCode>
<ExtraFeeForShipment>123</ExtraFeeForShipment>
<NextDay>Y</NextDay>
</eVSRequest>
Request: eVS – With Non Standard Fees
<eVSRequest USERID="XXXXXXXXX" PASSWORD="XXXXXXXXX">
<Option></Option>
<Revision>3</Revision>
<ImageParameters>
<ImageParameter>4X6LABELL</ImageParameter>
</ImageParameters>
<FromName>Joe Smith</FromName>
<FromFirm>ABC Corp.</FromFirm>
<FromAddress1></FromAddress1>
<FromAddress2>430 blackman st.</FromAddress2>
<FromCity>wilkes barre</FromCity>
<FromState>PA</FromState>
<FromZip5>18702</FromZip5>
<FromZip4></FromZip4>
<FromPhone>5708208072</FromPhone>
<POZipCode>18702</POZipCode>
<AllowNonCleansedOriginAddr></AllowNonCleansedOriginAddr>
<ToName>Tom Collins</ToName>
<ToFirm>XYZ Corp.</ToFirm>
<ToAddress1>Suite 4D</ToAddress1>
<ToAddress2>393 West Portal Avenue</ToAddress2>
<ToCity>San Francisco</ToCity>
<ToState>CA</ToState>
<ToZip5>94127</ToZip5>
<ToZip4></ToZip4>
<ToPhone></ToPhone>
<POBox></POBox>
<AllowNonCleansedDestAddr></AllowNonCleansedDestAddr>
<WeightInOunces>2</WeightInOunces>
<ServiceType>Parcel Select DE</ServiceType>
<Container>VARIABLE</Container>
<Width>15</Width>
<Length>17</Length>
<Height>15</Height>
<Machinable></Machinable>
<PriceOptions></PriceOptions>
<InsuredAmount></InsuredAmount>
<AddressServiceRequested>true</AddressServiceRequested>
<ShipDate>4/4/2022</ShipDate>
<CustomerRefNo></CustomerRefNo>
<ExtraServices>
<ExtraService></ExtraService>
</ExtraServices>
<HoldForPickup></HoldForPickup>
<OpenDistribute></OpenDistribute>
42
USPS Web Tools User Guide
<PermitNumber></PermitNumber>
<PermitZIPCode></PermitZIPCode>
<PermitHolderName></PermitHolderName>
<CRID></CRID>
<SenderName></SenderName>
<SenderEMail></SenderEMail>
<RecipientName>Robert Meier</RecipientName>
<RecipientEMail></RecipientEMail>
<ReceiptOption>SEPARATE PAGE</ReceiptOption>
<ImageType>TIF</ImageType>
<HoldForManifest></HoldForManifest>
<NineDigitRoutingZip></NineDigitRoutingZip>
<CarrierRelease></CarrierRelease>
<ReturnCommitments>true</ReturnCommitments>
<PrintCustomerRefNo></PrintCustomerRefNo>
<Content>
<ContentType></ContentType>
<ContentDescription></ContentDescription>
</Content>
<SortationLevel>SCF</SortationLevel>
<DestinationEntryFacilityType>DDU</DestinationEntryFacilityType>
<ContainerID1>1234567890123456789012345678901234</ContainerID1>
<ContainerID2>1234567890123456789012345678901234</ContainerID2>
<ContainerID3>1234567890123456789012345678901234</ContainerID3>
<SortContainerType1>PT</SortContainerType1>
<SortContainerType2>PT</SortContainerType2>
<SortContainerType3>PT</SortContainerType3>
<HoldForContainer>Y</HoldForContainer>
<DiscountType></DiscountType>
<DiscountAmount>1234.123</DiscountAmount>
<SurchargeType>E2</SurchargeType>
<SurchargeAmount>100.00</SurchargeAmount>
<ShipmentFeeCode></ShipmentFeeCode>
<ExtraFeeForShipment>123.12</ExtraFeeForShipment>
<NextDay>Y</NextDay>
<ReturnFees>true</ReturnFees>
</eVSRequest>
Request: eVS – Parcel Locker
<eVSCertifyRequest USERID="XXXXXXXXX" PASSWORD="XXXXXXXXX">
<Option>1</Option>
<Revision>3</Revision>
<ImageParameters>
<ImageParameter>6X4LABEL</ImageParameter>
<LabelSequence>
<PackageNumber>1</PackageNumber>
<TotalPackages>1</TotalPackages>
</LabelSequence>
</ImageParameters>
<FromName>FROM NAME</FromName>
<FromFirm>FROM FIRM</FromFirm>
<FromAddress1>9700 Capital Ct</FromAddress1>
<FromAddress2>Suite 201</FromAddress2>
<FromCity>Manassas</FromCity>
43
USPS Web Tools User Guide
<FromState>VA</FromState>
<FromZip5>20110</FromZip5>
<FromZip4>2047</FromZip4>
<FromPhone>7703092074</FromPhone>
<POZipCode></POZipCode>
<AllowNonCleansedOriginAddr>false</AllowNonCleansedOriginAddr>
<ToName>TO NAME</ToName>
<ToFirm>TO FIRM</ToFirm>
<ToAddress1/>
<ToAddress2></ToAddress2>
<ToCity></ToCity>
<ToState></ToState>
<ToZip5></ToZip5>
<ToZip4></ToZip4>
<ToPhone>2022107444</ToPhone>
<POBox/>
<ToContactPreference>EMAIL</ToContactPreference>
<ToContactMessaging/>
<ToContactEMail>[email protected]</ToContactEMail>
<AllowNonCleansedDestAddr>false</AllowNonCleansedDestAddr>
<WeightInOunces>5</WeightInOunces>
<ServiceType>PRIORITY</ServiceType>
<Container>VARIABLE</Container>
<Width>6</Width>
<Length>6</Length>
<Height>6</Height>
<Machinable></Machinable>
<PriceOptions/>
<InsuredAmount></InsuredAmount>
<AddressServiceRequested></AddressServiceRequested>
<ShipDate>06/23/2023</ShipDate>
<CustomerRefNo>CustRef1</CustomerRefNo>
<CustomerRefNo2>CustRef2</CustomerRefNo2>
<ExtraServices>
<ExtraService></ExtraService>
</ExtraServices>
<VendorCode>1234</VendorCode>
<VendorProductVersionNumber>5.02.1B</VendorProductVersionNumber>
<SenderName>Sender Name</SenderName>
<SenderEMail>[email protected]</SenderEMail>
<RecipientName>Recipient Name</RecipientName>
<RecipientEMail>[email protected]</RecipientEMail>
<ReceiptOption>SAME PAGE</ReceiptOption>
<ImageType>PDF</ImageType>
<HoldForManifest>N</HoldForManifest>
<NineDigitRoutingZip>false</NineDigitRoutingZip>
<CarrierRelease>false</CarrierRelease>
<ReturnCommitments>true</ReturnCommitments>
<PrintCustomerRefNo>true</PrintCustomerRefNo>
<PrintCustomerRefNo2>True</PrintCustomerRefNo2>
<OptOutOfSPE>true</OptOutOfSPE>
<DestinationEntryFacilityType></DestinationEntryFacilityType>
<ChargebackCode></ChargebackCode>
<ReturnFees>true</ReturnFees>
44
USPS Web Tools User Guide
<FromContactPreference>EMAIL</FromContactPreference>
<FromContactMessaging/>
<FromContactEMail>[email protected]</FromContactEMail>
<ParcelLocker>true</ParcelLocker>
<FacilityID>1437366</FacilityID>
</eVSCertifyRequest>
eVS Request with HSTarrifNumber and new Tags
<eVSCertifyRequest USERID="XXXXXXXXX" PASSWORD="XXXXXXXXX">
<Option>1</Option>
<Revision>3</Revision>
<ImageParameters></ImageParameters>
<FromName>Joe Smith</FromName>
<FromFirm>ABC Corp.</FromFirm>
<FromAddress1></FromAddress1>
<FromAddress2>430 blackman st.</FromAddress2>
<FromCity>wilkes-barre</FromCity>
<FromState>PA</FromState>
<FromZip5>18702</FromZip5>
<FromZip4>1234</FromZip4>
<FromPhone>5708208072</FromPhone>
<POZipCode></POZipCode>
<AllowNonCleansedOriginAddr></AllowNonCleansedOriginAddr>
<ToName>Tom Collins</ToName>
<ToFirm>XYZ Corp.</ToFirm>
<ToAddress1></ToAddress1>
<ToAddress2>PSC 0000</ToAddress2>
<ToCity>DPO</ToCity>
<ToState>AE</ToState>
<ToZip5>09468</ToZip5>
<ToZip4></ToZip4>
<ToPhone></ToPhone>
<POBox></POBox>
<AllowNonCleansedDestAddr></AllowNonCleansedDestAddr>
<WeightInOunces>17</WeightInOunces>
<ServiceType>GROUND ADVANTAGE</ServiceType>
<Container>VARIABLE</Container>
<Width>30</Width>
<Length>36</Length>
<Height>12</Height>
<Machinable></Machinable>
<PriceOptions></PriceOptions>
<InsuredAmount></InsuredAmount>
<AddressServiceRequested>true</AddressServiceRequested>
<ExpressMailOptions>
<DeliveryOption></DeliveryOption>
<WaiverOfSignature></WaiverOfSignature>
</ExpressMailOptions>
<ShipDate></ShipDate>
<CustomerRefNo></CustomerRefNo>
<ExtraServices>
<ExtraService></ExtraService>
</ExtraServices>
<HoldForPickup></HoldForPickup>
45
USPS Web Tools User Guide
<OpenDistribute></OpenDistribute>
<PermitNumber></PermitNumber>
<PermitZIPCode></PermitZIPCode>
<PermitHolderName></PermitHolderName>
<CRID></CRID>
<SenderName></SenderName>
<SenderEMail></SenderEMail>
<RecipientName>Robert Meier</RecipientName>
<RecipientEMail></RecipientEMail>
<ReceiptOption></ReceiptOption>
<ImageType>TIF</ImageType>
<HoldForManifest></HoldForManifest>
<NineDigitRoutingZip></NineDigitRoutingZip>
<CarrierRelease></CarrierRelease>
<ReturnCommitments>true</ReturnCommitments>
<PrintCustomerRefNo></PrintCustomerRefNo>
<Content>
<ContentType></ContentType>
<ContentDescription></ContentDescription>
</Content>
<ShippingContents>
<ItemDetail>
<Description>Description 1</Description>
<Quantity>9999</Quantity>
<Value>1.11</Value>
<NetPounds></NetPounds>
<NetOunces>32</NetOunces>
<HSTariffNumber>123456789012</HSTariffNumber>
<CountryOfOrigin>Australia</CountryOfOrigin>
<ItemCategory>shoes</ItemCategory>
<ItemSubCategory>sneakers</ItemSubCategory>
</ItemDetail>
</ShippingContents>
<CustomsContentType>DOCUMENTS</CustomsContentType>
<ContentComments>1234567890123456789012345</ContentComments>
<RestrictionType>Phytosanitary Inspection</RestrictionType>
<RestrictionComments>1234567890123456789012345</RestrictionComments>
<AESITN>12345678901234567890123456789012345</AESITN>
<ImportersReference>123456789012345678901234567890</ImportersReference>
<ImportersContact>Importers Contact: This field can be 50 chars long</ImportersContact>
<ExportersReference>12345678901234</ExportersReference>
<ExportersContact>Exporters Contact: This field can be 50 chars long</ExportersContact>
<InvoiceNumber>Invoice89012345</InvoiceNumber>
<LicenseNumber>License Number12</LicenseNumber>
<CertificateNumber>CertificateX</CertificateNumber>
</eVSCertifyRequest>
46
USPS Web Tools User Guide
2.3 Response Descriptions
Tag Name Occurs Description Type Validation
eVSResponse Required (group)
eVSResponse / Required Tracking / Confirmation number for the String
BarcodeNumber package. This tag returns a long form
IMpb that includes routing information:
4202203592624xxxxxxxxxxxxxxxxx
eVSResponse / Required Tracking / Confirmation number for the String
TrackingNumber package. This tag returns a shortened
(Revision =
Impb that begins with the Channel
2)
Application ID:
92624xxxxxxxxxxxxxxxxx
TrackingNumber is available when
<Revision> is greater than or equal to
“2”
eVSResponse / Optional Label image, if requested (where base64Binary
LabelImage <ImageType> tag not “None”)
eVSResponse / Optional Separate Receipt image, if requested base64Binary
ReceiptImage using <ReceiptOptions> tag
eVSResponse / ToName Required Name of Recipient String
eVSResponse / ToFirm Required Company Name String
eVSResponse / Required To Address Line 1 String
ToAddress1
eVSResponse / Required To Address Line 2 String
ToAddress2
eVSResponse / Optional USPS abbreviated address line 2 String
ToAddress2Abbreviation available when <Revision> is greater
than or equal to “1”
eVSResponse / ToCity Required To City String
eVSResponse / Optional USPS abbreviated city available when String
ToCityAbbreviation <Revision> is greater than or equal to
“1”
eVSResponse / ToState Required To State String
eVSResponse / ToZip5 Required To ZIP Code String
eVSResponse / ToZip4 Required To ZIP Code+4 String
47
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSResponse / Postnet Required String
eVSResponse / RDC Required String
eVSResponse / Postage Required Amount of Postage Required, does not Decimal
include insurance or other extra service
fees.
eVSResponse / Postage Required This attribute specifies the Service String
ServiceType (Revision = Type that was used to price and
3) generate the label. Available when
<Revision> is greater than or equal to
“3”
For Example: <Postage
ServiceType="GROUND
ADVANTAGE">5.33</Postage>
eVSResponse / Optional (group)
ExtraServices
eVSResponse / Optional, Groups extra service information (group)
ExtraServices / repeating
ExtraService up to
unbounded
times
eVSResponse / Required Extra Service ID echoed from request String
ExtraServices /
ExtraService / ServiceID
eVSResponse / Required Extra Service name String
ExtraServices /
ExtraService /
ServiceName
eVSResponse / Required Extra Service fee Decimal
ExtraServices /
ExtraService / Price
eVSResponse / Optional For future use.
HoldForPickup
eVSResponse / optional Returns true or false. If true, additional
ParcelLocker fields for facility and contact
information is returned.
eVSResponse / Required Required when <ParcelLocker> String
ParcelLocker / FacilityID indicator is true. Returns the facility ID
for location of available Parcel Locker.
48
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSResponse / Required Returns the street address of the String
ParcelLocker / facility for the available Parcel Locker.
FacilityAddress
eVSResponse / Required Returns the city of the facility for the String
ParcelLocker / available Parcel Locker.
FacilityCity
eVSResponse / Required Returns the state of the facility for the String
ParcelLocker / available Parcel Locker.
FacilityState
eVSResponse / Required Returns the 5 digit ZIP code of the String
ParcelLocker / facility for the available Parcel Locker.
FacilityZip5
eVSResponse / Required Returns the additional 4 digit ZIP code String
ParcelLocker / of the facility for the available Parcel
FacilityZip4 Locker.
eVSResponse / Required Returns the preference indicated by String
ParcelLocker / the integrator in the request:
FromContactPreference EMAIL, SMS, EMAILSMS, WAIVED
eVSResponse / Required If EMAIL is selected as Contact String
ParcelLocker / Preference, the field will return the
FromContactEmail From Contact Email
eVSResponse / Required Returns the preference indicated by String
ParcelLocker / the integrator in the request for the
ToContactPreference recipient:
EMAIL OR EMAILSMS
eVSResponse / Required Returns the phone number for SMS String
ParcelLocker / Messaging notifications
ToContactMessaging
eVSResponse / Required If EMAIL is selected as Contact String
ParcelLocker / Preference, the field will return the
ToContactEmail ToContactEmail
eVSResponse / Zone Required Postal Zone. Indicates the number of String
postal rate zones between the origin
and destination ZIP codes.
eVSResponse / Optional Dimensional Weight of package, if String
DimensionalWeight greater than specified in
<WeightInOunces>.
eVSResponse / Required Carrier Route String
CarrierRoute
49
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSResponse / Required Permit Holder Name String
PermitHolderName
eVSResponse/ Required Permit Holder Induction Type String
InductionType
eVSResponse / Required A text message for integrators of this String
LogMessage API. It may contain additional
information about this particular
request/response, or general
information about the API or Web
Tools. In typical implementations,
whenever this tag is encountered, the
message is written to the console log
file for later analysis.
eVSResponse / Optional Returned when <ReturnCommitments>
Commitment = “true” in the request.
eVSResponse / Required Commitment name. String
Commitment /
CommitmentName
Example “1-Day”.
eVSResponse / Required Date of delivery. Format “YYYY-MM- String
Commitment / DD”.
ScheduledDeliveryDate
Example “2015-06-03”.
eVSResponse / Fees Optional Returned when “Fees” is True
Dimensional weight pricing will include
length and volume fees to account for
cost of processing oversized parcels
eVSResponse / Fee Required String
eVSResponse / Fee / Required Indicates what type of Fee is being String
FeeType requested:
- Non Standard Length Fee(s)
- Non Standard Volume Fee(s)
- Live Animal Transportation
Fee(s)
eVSResponse / Fee / Required Fee price. See Notice 123 for fee String
FeeType / FeePrice applicability and pricing.
eVSResponse / Fees / Required Fee Information indicates the fee is String
Fee / FeeType / FeePrice <Rate>
/ FeeInformation
50
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSResponse / Fees / Required Fee Information indicates the fee is String
Fee / FeeType / FeePrice <Rate>
/ FeeInformation /
FeeInfo
FeeInfoType=”PriceType”
eVSResponse / Required When <ReturnFees> = True, the new String
Attributes Attributes tag will return to show
Oversize fees and/or Dimensional
Weight fees.
Any future package attributes that
impact a price returned will be included
in the attributes tag.
eVSResponse / Required Attribute Key: String
Attributes / AttributeKey • DimensionalWeightR =
RetailRate
• DimensionalWeightCB =
Commercial Rate
• DimensionalWeightCP =
Commerical Plus Rate
• Oversized
eVSResponse Required (alias)
2.3.1 Sample Response
Response — Domestic
<eVSResponse>
<BarcodeNumber>4202944092682XXXXXXXXXXXXXXXXX</BarcodeNumber>
<TrackingNumber>92682XXXXXXXXXXXXXXXXX</TrackingNumber>
<LabelImage> <!—-- over 115000 suppressed --> LabelImage>
<ToName>TALL TOM</ToName>
<ToFirm>ABC CORP.</ToFirm>
<ToAddress1/>
<ToAddress2>1098 N FRASER ST</ToAddress2>
<ToCity>GEORGETOWN</ToCity>
<ToState>SC</ToState>
<ToZip5>29440</ToZip5>
<ToZip4>2849</ToZip4>
<Postnet>294402849981</Postnet>
<RDC>0001</RDC>
<Postage ServiceType="PRIORITY">27.06</Postage>
<ExtraServices>
<ExtraService>
<ServiceID>120</ServiceID>
<ServiceName>Adult Signature Restricted Delivery</ServiceName>
<Price>8.65</Price>
</ExtraService>
</ExtraServices>
<Zone>06</Zone>
51
USPS Web Tools User Guide
<CarrierRoute>C002</CarrierRoute>
<PermitHolderName>Not Valid Test Label</PermitHolderName>
<InductionType>eVS</InductionType>
<LogMessage/>
<Commitment>
<CommitmentName>2-Day</CommitmentName>
<ScheduledDeliveryDate>2025-XX-XX</ScheduledDeliveryDate>
</Commitment>
<Fees>
<Fee>
<FeeType>Live Animal Handling Fee</FeeType>
<FeePrice>15.00</FeePrice>
</Fee>
</Fees>
</eVSResponse>
Response – and creating a Military / PTFAS Integrated Customs Form:
<eVSResponse>
<BarcodeNumber>4200637192061XXXXXXXXXXXXXXXXX</BarcodeNumber>
<TrackingNumber>92061XXXXXXXXXXXXXXXXX</TrackingNumber>
<LabelImage>SUkqAAgAAAASAP4ABAAB<!-- over 115000 suppressed --></LabelImage>
<ToName>TOM COLLINS</ToName>
<ToFirm>XYZ CORP.</ToFirm>
<ToAddress1/>
<ToAddress2>PSC 0000</ToAddress2>
<ToCity>DPO</ToCity>
<ToState>AE</ToState>
<ToZip5>09880</ToZip5>
<ToZip4/>
<Postnet/>
<RDC>0001</RDC>
<Postage ServiceType="PRIORITY">26.87</Postage>
<ExtraServices>
<ExtraService>
<ServiceID>155</ServiceID>
<ServiceName>USPS Tracking Electronic</ServiceName>
<Price>0.00</Price>
</ExtraService>
</ExtraServices>
<Zone>05</Zone>
<CarrierRoute/>
<PermitHolderName>Not Valid Test Label</PermitHolderName>
<InductionType>eVS</InductionType>
<LogMessage/>
<Commitment>
<CommitmentName>DPO</CommitmentName>
<ScheduledDeliveryDate/>
</Commitment>
<Warning>Sender data will be ignored.</Warning>
</eVSResponse>
Response: eVS – Non Standard Fee
<eVSResponse>
<BarcodeNumber>4209412792612XXXXXXXXXXXXXXXXX</BarcodeNumber>
52
USPS Web Tools User Guide
<TrackingNumber>92612XXXXXXXXXXXXXXXXX</TrackingNumber>
<LabelImage> <!—-- over 115000 suppressed --> </LabelImage>
<ToName>TOM COLLINS</ToName>
<ToFirm>XYZ CORP.</ToFirm>
<ToAddress1>STE 4D</ToAddress1>
<ToAddress2>393 WEST PORTAL AVE</ToAddress2>
<ToCity>SAN FRANCISCO</ToCity>
<ToState>CA</ToState>
<ToZip5>94127</ToZip5>
<ToZip4>1411</ToZip4>
<Postnet>941271411938</Postnet>
<RDC>0001</RDC>
<Postage ServiceType="PARCEL SELECT DE">21.93</Postage>
<ExtraServices>
<ExtraService>
<ServiceID>155</ServiceID>
<ServiceName>USPS Tracking Electronic</ServiceName>
<Price>0.00</Price>
</ExtraService>
</ExtraServices>
<Zone>08</Zone>
<DimensionalWeight>24.0</DimensionalWeight>
<CarrierRoute>C011</CarrierRoute>
<PermitHolderName>Not Valid Test Label</PermitHolderName>
<InductionType>eVS</InductionType>
<LogMessage/>
<Commitment>
<CommitmentName>7 Days</CommitmentName>
<ScheduledDeliveryDate>2023-XX-XX</ScheduledDeliveryDate>
</Commitment>
<Fees>
<Fee>
<FeeType>Nonstandard Volume fee > 2 cu. ft.</FeeType>
<FeePrice>15.00</FeePrice>
<FeeInformation>
<FeeInfo FeeInfoType="MailEntry">DDU</FeeInfo>
</FeeInformation>
</Fee>
<Fee>
<FeeType>Nonstandard Volume fee > 2 cu. ft.</FeeType>
<FeePrice>15.00</FeePrice>
<FeeInformation>
<FeeInfo FeeInfoType="MailEntry">DDU</FeeInfo>
</FeeInformation>
</Fee>
</Fees>
<Attributes>
<Attribute Key="DimensionalWeight">24.0</Attribute>
</Attributes>
</eVSResponse>
Response: eVS – Parcel Locker
<eVSCertifyResponse>
<BarcodeNumber>420220829999921129010XXXXXXXXX</BarcodeNumber>
53
USPS Web Tools User Guide
<TrackingNumber>921129010XXXXXXXXX</TrackingNumber>
<LabelImage> <!—-- over 115000 suppressed --> </LabelImage>
<ToName>TO NAME</ToName>
<ToFirm>TO FIRM</ToFirm>
<ToAddress1/>
<ToAddress2/>
<ToCity/>
<ToState/>
<ToZip5/>
<ToZip4/>
<Postnet>99</Postnet>
<RDC>0000</RDC>
<Postage ServiceType="PRIOR”TY">7.64</Postage>
<ExtraServices>
<ExtraService>
<ServiceID>155</ServiceID>
<ServiceName>USPS Tracking Electronic</ServiceName>
<Price>0.00</Price>
</ExtraService>
</ExtraServices>
<Zone>01</Zone>
<PermitHolderName>Not Valid Test Label</PermitHolderName>
<InductionType>eVS</InductionType>
<LogMessage/>
<Commitment>
<CommitmentName>1-Day</CommitmentName>
<ScheduledDeliveryDate>2023-XX-XX</ScheduledDeliveryDate>
</Commitment>
<ParcelLocker>
<FacilityID>1437366</FacilityID>
<FacilityAddress>PO Box Locker</FacilityAddress>
<FacilityCity>Reston</FacilityCity>
<FacilityState>VA</FacilityState>
<FacilityZip5>20190</FacilityZip5>
<FacilityZip4>2000</FacilityZip4>
<FromContactPreference>EMAIL</FromContactPreference>
<FromContactEmail>[email protected]</FromContactEmail>
<ToContactPreference>EMAIL</ToContactPreference>
<ToContactEmail>[email protected]</ToContactEmail>
</ParcelLocker>
</eVSCertifyResponse>
3.0 eVS Cancel API
3.1 Overview
The eVS Cancel request allows an eVS label to be removed from processing. This functionality is available only if
the eVS label has been held for manifest (i.e. <HoldForManifest>=”Y” is included in eVS label XML request) and
the Shipping Services File v2.0 has not yet been created. Depending on customer profile setup, this transmission
could occur for created labels every 15 minutes, at the end of the shipping day, or when a SCAN Form is
manually triggered by the customer.
54
USPS Web Tools User Guide
3.1.1 API Signature
Scheme Host Path API XML
https:// secure.shippingapis.com /ShippingAPI.dll? API=eVSCancel &XML=(see
below)
Note: 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.
3.2 Request Descriptions
Tag Name Occurs Description Type Validation
eVSCancelRequest Required (Alias)
eVSCancelRequest / Required This attribute specifies your Web Tools NMTOKEN
USERID user ID. See the Developer's Guide for
information on obtaining your USERID.
For Example: USERID="XXXXXXX"
eVSCancelRequest / Required This attribute specifies your Web Tools NMTOKEN
PASSWORD password. See the Developer's Guide for
information on your Password.
For Example: PASSWORD="XXXXXXX"
eVSCancelRequest / Required Barcode Number of original label. Length of
BarcodeNumber 22, 30 or 34
Note: The eVSCancel API can contain numbers.
only one package barcode in a single
request.
eVSCancelRequest Required (Alias)
3.2.1 Sample Request
<eVSCancelRequest USERID="XXXXXXXXX" PASSWORD="XXXXXXXXX">
<BarcodeNumber>4202944092682XXXXXXXXXXXXXXXXX</BarcodeNumber>
</eVSCancelRequest>
3.3 Response Descriptions
Tag Name Occurs Description Type Validation
eVSCancelResponse Required (Alias)
eVSCancelResponse / Required Returned in the eVS Label Length of 22,
BarcodeNumber Request 30 or 34
numbers.
eVSCancelResponse / Required Success or Failure Indicator String
Status Cancelled
Not Cancelled
eVSCancelResponse / Required Order Cancelled Successfully String
Reason Order Already Cancelled
Order Not Found
55
USPS Web Tools User Guide
Tag Name Occurs Description Type Validation
eVSCancelResponse Required (Alias)
3.3.1 Sample Response
Response: Order Cancelled Successfully
<eVSCancelResponse>
<BarcodeNumber>4202944092682XXXXXXXXXXXXXXXXX</BarcodeNumber>
<Status>Cancelled</Status>
<Reason>Order Cancelled Successfully</Reason>
</eVSCancelResponse>
Response: Order Already Cancelled
<eVSCancelResponse>
<BarcodeNumber>4202944092682XXXXXXXXXXXXXXXXX</BarcodeNumber>
<Status>Not Cancelled</Status>
<Reason>Order Already Cancelled</Reason>
</eVSCancelResponse>
Response: Order Not Found
<eVSCancelResponse>
<BarcodeNumber>4202944092682XXXXXXXXXXXXXXXXX</BarcodeNumber>
<Status>Not Cancelled</Status>
<Reason>Order Not Found</Reason>
</eVSCancelResponse>
4.0 Appendices
4.1 Appendix A
56
USPS Web Tools User Guide
4.1.1 Priority Mail Express Label
Figure 1: eVS PME Label Sample
57
USPS Web Tools User Guide
4.1.2 Priority Mail Label
Figure 2: eVS PM Label Sample
58
USPS Web Tools User Guide
4.1.3 Ground Advantage Label
Figure 3: eVS Ground Advantage Label Sample
59
USPS Web Tools User Guide
4.1.4 Library Mail Label
Figure 4: eVS Library Mail Label Sample
60
USPS Web Tools User Guide
4.1.5 Media Mail Label
Figure 5: eVS Media Mail Label Sample
61
USPS Web Tools User Guide
4.1.6 BPM Label
Figure 6: eVS BPM Label Sample
62
USPS Web Tools User Guide
4.1.7 Priority Mail Cubic Label
Figure 7: eVS PM Cubic Label Sample
63
USPS Web Tools User Guide
4.1.8 Priority Mail Domestic Integrated Customs Form (P.S. Form 2976-A)
Figure 8: eVS Domestic Integrated Customs Form Label Sample (PS Form 2976A)
64
USPS Web Tools User Guide
4.1.9 Priority Express Mail Domestic Integrated Customs Form (P.S. Form 2976-B)
Figure 9: eVS Domestic Integrated Customs Form Label Sample (PS Form 2976B)
65
USPS Web Tools User Guide
4.1.10 Ground Advantage Domestic Integrated Customs Form (P.S. Form 2976-A)
Figure 10: eVS Domestic Integrated Customs Form Label Sample (PS Form 2976A)
66
USPS Web Tools User Guide
4.1.11 Marketing Mail Parcel (MMP) Domestic Integrated Customs Form (P.S. Form 2976)
Figure 11: eVS Domestic Integrated Customs Form Label Sample (PS Form 2976)
67
USPS Web Tools User Guide
4.1.12 Parcel Select Destination Entry
Figure 12: eVS PSDE Label Sample
68
USPS Web Tools User Guide
69
USPS Web Tools User Guide
4.1.13 Parcel Locker Label
Figure 13: eVS Parcel Locker Label Sample
70
USPS Web Tools User Guide
71
USPS Web Tools User Guide
4.2 Appendix B - Special Situations
4.2.1 GDE Customers
Web Tools allows the eVS Domestic Label API to identify Global Direct Entry (GDE) customers and verify that
mail classes and extra services provided in the request are supported by GDE when generating eVS labels. GDE-
specific Service Type Codes (STCs) are supported within the eVS Domestic Label API (API=eVS) for use in the
barcode and Shipping Services File. Onboarding and setup configuration is required prior to initial use of the eVS
Label API. Customers participating the GDE program should first contact their TIS representative for initial
onboarding before using the eVS API.
4.2.2 Shipping to a Parcel Locker
Web Tools allows eVS Domestic Label API to generate labels destined to a Parcel Locker.
Overview of Web Tools APIs supporting USPS Parcel Lockers:
• Parcel Locker Lookup API (API=USPSParcelLockerLookup) – allows integrators to find a Parcel Locker
location that fits the package being shipped. This API collects address/ZIP Code search criteria +
package dimensions to return Parcel Locker locations (identified by unique <FacilityID>) and geolocations
that 1) are located within the search criteria and 2) have a locker that fits the dimensions of the package
to support delivery to that parcel locker location.
• Domestic Price Calculator API (API=RateV4) – allows integrators to determine if their package
characteristics (e.g., mail class, extra service) are eligible to ship to a parcel locker. Integrators should
use <Service> request tag attribute Delivery Option and specify “ParcelLocker” (i.e., <Service
DelOpt=“ParcelLocker”></Service>) to return eligibility for delivery to a Parcel Locker.
• eVS Domestic Label API (API=eVS) – allows integrators to generate a shipping label to a Parcel Locker
and results in the creation of a Shipping Services File. To generate an eVS Parcel Locker label,
integrators should include the following inputs in their request:
o Parcel Locker indicator (i.e., <ParcelLocker>=“true”) – used to indicate shipment destination is to
a Parcel Locker.
o Facility ID (i.e., <FacilityID>) – used to indicate the desired Parcel Locker location for delivery.
When shipping to a Parcel Locker this value is required and used as the destination address
printed on the label instead of the ToAddress fields. FacilityID values are obtained as the output
of the Parcel Locker Lookup API (API=USPSParcelLockerLookup).
o <ToContactPreference> – used for recipient notifications. Only values of “EMAIL” or “EMAILSMS”
allowed.
o <ToContactEMail> – collects email address used for recipient notifications.
o <FromContactPreference> – used for sender notifications.
o <FromContactEMail> – collects email address used for sender notifications.
72
USPS Web Tools User Guide
4.3 Appendix C - Parcel Select Service Combinations
Machinable parcels are defined as parcels less than or equal to 15" x 18" x 22" inches and less than or equal 25
pounds. Any parcel that exceeds either threshold (dimension or weight) will be considered nonmachinable.
<ServiceType> <DestinationEntryFacilityType>
PARCEL SELECT DE DDU
PARCEL SELECT DE DHUB
PARCEL SELECT DE DSCF
73
USPS Web Tools User Guide
4.4 Appendix D - Categories for International Shipping Regulatory
Mandates
Category (<ItemCategory>) SubCategory (<ItemSubCategory>)
Appliances, Parts & Accessories • Air Compressors
• Bathroom Appliances
• Clothing Iron
• Coffee Makers, Toasters & Other Heat-generating Kitchen
Appliances
• Cutting Blades
• Fans
• Food Grinders
• Heaters, Radiators & Air Conditioning Units
• Mechanical Kitchen Appliances
• Microwave Ovens
• Other Household Appliances
• Other Kitchen Appliances
• Oven, Cooktops & Ventilating Hoods
• Refrigerators & Freezers
• Sewing Machines
• Sinks, Toilets & Bathtubs
• Vacuum Cleaners
• Washing Machines & Dryers
• Weighing Scales
Arts & Collectibles • Antique Hand-Painted & Hand-Drawn Art
• Antiques Over 100 Years Old
• Archaeological, Zoological & Historical Collector's Pieces
• Art Paint & Brushes
• Art Prints
• Blank Art Canvas
• Coin
• Hand-Painted & Hand-Drawn Art
• Non-Original Wooden Art
• Original Prints & Engravings
• Original Sculptures & Carvings
• Sewing Materials
• Stamp Collections
• Statuettes and Ornaments
74
USPS Web Tools User Guide
Category (<ItemCategory>) SubCategory (<ItemSubCategory>)
Automotive & Vehicles • Aircraft & Parts
• Bicycles & Accessories
• Car, Truck & Tractor Parts
• Cranes
• Diesel-powered Cars & Trucks
• Electric Cars & Trucks
• Gas-powered Cars & Trucks
• Motorcycle & Bicycle Parts
• Motorcycles
• Railway & Tramway Vehicles & Parts
• Scooters & Chairs for the Disabled & Parts
• Ship & Boat Parts
• Ships & Boats
• Spacecraft & Parts
• Special Vehicles (e.g., Fire Trucks, Cement Mixers, etc.)
• Tractors & Work Trucks
• Trailers
Beauty & Health • Air Fresheners & Incense
• Bath & Hand Soap
• Bath salts
• Contact Lenses
• Contraceptives
• Dental Fittings & Hygiene
• Feminine Hygiene
• Hair Cutting Tools
• Hair Dryers, Straighteners & Curlers
• Make-up
• Manicure & Pedicure Sets
• Massage Tools
• Medicine, Ointments, First Aid & Bandages
• Other Hygiene
• Pedometer
• Perfume & Deodorant
• Personal Medical Equipment
• Shampoo & Hair Products
• Shaving & Waxing
• Vaccines, Blood, & Cell Cultures
Books, Movies & Music • Books & Brochures
• Catalogs
• Coloring Books
• DVDs, CDs, Tapes & Other Recorded Media
• Maps & Globes
• Music Boxes
• Musical Instruments & Parts
• Newspapers, Journals & Magazines
• Printed Decals
• Sheet Music
75
USPS Web Tools User Guide
Category (<ItemCategory>) SubCategory (<ItemSubCategory>)
Clothing & Accessories • Baby Clothes
• Belts & Buckles
• Fabric Material
• Glasses & Sunglasses
• Gloves and Mittens
• Hats & Headgear
• Hoodies, Sweaters & Cardigans
• Luggage, Backpacks, Bags & Wallets
• Men's & Boys' Jackets, Shirts & Suits
• Men's & Boys' Pants & Swimwear
• Men's & Boys' Underwear & Pajamas
• Other Clothing Accessories
• Shoes & Accessories
• Socks, Pantyhose & Tights
• Ties & Scarves
• Used Clothing
• Wigs & False Hair
• Women's & Girls' Jackets, Shirts & Dresses
• Women's & Girls' Pants, Skirts & Swimwear
• Women's & Girls' Underwear & Pajamas
Electronics, Computers & Cameras • Audio-playing Devices
• Batteries & Power Banks
• Cables & Connectors
• Cameras, Video Cameras & Parts
• Chargers
• Computer Parts & Accessories
• Device Cases & Bags
• DVD & Blu-ray Players
• Gift, Credit & Smart Cards
• GPS Devices & Radios
• Laptops & Desktops
• Electrical Parts
• Smoke Detectors & Alarms
• Speakers, Headphones & Microphones
• Streaming Service Devices
• Telephones & Smartphones
• Televisions & Projectors
• Traffic & Safety Signal Equipment
• Video Game Consoles & Games
76
USPS Web Tools User Guide
Category (<ItemCategory>) SubCategory (<ItemSubCategory>)
Food & Groceries • Alcoholic Beverages
• Baby Formula
• Chocolate & Cocoa Products
• Coffee, Tea & Mate
• Dairy & Eggs
• Extracts & Concentrates
• Fats & Oils
• Fruit
• Fruit & Nut Mix
• Grains & Flour
• Jams & Jellies
• Live Fish & Seafood
• Meat & Fish
• Nuts
• Other Food Items
• Sauces
• Soda & Other Drinks
• Soups & Broths
• Spices & Sugar
• Syrup & Molasses
• Tobacco Products & E-cigarettes
• Treats
• Vegetables & Other Plants
Home & Garden • Adhesives & Tape
• Animal Hides & Parts
• Artificial Plants & Flowers
• Bedding & Towels
• Candles
• Clocks & Parts
• Clothing Hangers
• Containers & Baskets
• Curtains
• Electric Kitchen Appliances
• Furniture
• Household Cleaners & Trash Bags
• Lamps & Lighting
• Live Plants & Fresh Flowers
• Mirrors
• Other Household Items
• Other Outdoor & Garden Items
• Rugs & Mats
• Sacks & Bags
• Safes & Strong-boxes
• Statuettes & Other Decor
• Tableware & Kitchenware
• Toilet Paper, Napkins & Tablecloths
77
USPS Web Tools User Guide
Category (<ItemCategory>) SubCategory (<ItemSubCategory>)
Industrial, Scientific & Machinery • Agricultural & Food Machinery
• Batteries & Accumulators
• Buttons & Mannequins
• Dies & Tanning Extracts
• Electric Parts, Electronic Waste & Scrap
• Energy-generating Equipment
• Explosives & Combustibles
• Industrial Animal Products
• Industrial Furnaces & Ovens
• Industrial Glass Items
• Industrial Metal Items
• Industrial Plastic Items
• Industrial Rubber Items
• Industrial Stone & Cement Items
• Industrial Textile Items
• Industrial Vacuum Cleaners
• Industrial Washers & Dryers
• Industrial Wood Items
• Laboratory Equipment
• Magnets
• Measuring Equipment
• Medical Equipment
• Metal-working Machinery
• Motors & Generators
• Moulds
• Navigation & Surveying Equipment
• Ores, Mineral Fuels & Oils
• Organic Compounds
• Other Chemical Products
• Other Electrical Machinery & Parts
• Other Industrial Machinery
• Other Industrial Machinery Parts
• Other Minerals & Stone
• Packing Materials & Containers
• Precious Metal Compounds & Inorganic Chemicals
• Printing & Paper Machinery
• Railway Materials
• Semiconductor-producing Machinery
• Textile Machinery
• Transformers
• Vegetative Materials
• Vending Machines
• Welding Equipment
Jewelry & Watches • Imitation Jewelry & Parts
• Jewelry Boxes & Cases
• Jewelry of Pearls or Precious Metal & Parts
• Pearls & Precious Stones
• Precious Metals
• Watches & Parts
78
USPS Web Tools User Guide
Category (<ItemCategory>) SubCategory (<ItemSubCategory>)
Office Products • Account Books, Receipt Books & Binders
• Adhesive & Tape
• Calculators
• Calendars
• Chalkboards & Dry Erase Boards
• Documents & Business Cards
• Erasers
• Filing Cabinets & Trays
• Letter Openers
• Other Mathematical Tools
• Other Plastic School Supplies
• Paper & Paperboard
• Pencil Sharpeners, Staplers & Other Office Machines
• Pens & Pencils
• Printers & Ink
• Safety Pins, Paper Clips & Staples
• Scissors
• Stamps
Pet Supplies • Cages & Accessories
• Fish Tanks, Terrariums & Accessories
• Food Bowls
• Leashes, Harnesses & Saddles
• Litter Box
• Pet Beds
• Pet Food
• Pet Toys
Sports & Outdoors • Air Mattresses & Sleeping Bags
• Air Pumps
• Binoculars & Telescopes
• Camping Backpacks & Sports Bags
• Compasses
• Firearms & Weapons
• Firewood & Charcoal
• Fireworks & Flares
• Fishing Gear
• Grills & Stoves
• Hammocks
• Lamps & Flashlights
• Matches & Lighters
• Pans & Dutch Ovens
• Sports Equipment & Balls
• Tents, Tarps & Rope
• Umbrellas
• Walking Sticks & Whips
• Water Sports
• Winter Sports
79
USPS Web Tools User Guide
Category (<ItemCategory>) SubCategory (<ItemSubCategory>)
Tools & Construction materials • Carpel, Flooring and Tile
• Doors & Windows
• Hand Tools
• Lawn Equipment
• Lumber & Furniture Wood
• Metal Mountings
• Moulding Patterns & Engineering Drawings
• Nails, Screws & Bolts
• Other Equipment
• Other Metal Equipment
• Paint, Varnish & Paint Thinner
• Pipes & Hoses
• Power Tools & Parts
• Pulleys, Winches & Generators
• Pumps, Compressors & Generators
• Roofing
• Safety Gear & Scaffolding
• Stone, Gravel & Brick
• Tape, Construction Adhesive & Putty
• Wire & Rods
Toys & Games • Amusement Park Equipment
• Arcade Games
• Games & Puzzles
• Other Toys
• Wheeled Toys
80