eVS International Label API
USPS Web Tools™
Application Programming Interface
User Guide
Version
3.6 (3/27/2024)
Table of Contents
2.0 eVS
Priority Mail Express International Label API
3.0 eVS
Priority Mail International Label API
4.0 eVS First
Class Mail International Label API
6.0 eVS
International Cancel API
7.1.1 eVS International Label Example –
Express Mail International
7.1.2 eVS International Label Example –
Priority Mail International
7.1.3 eVS International Label Example –
First Class Mail International
7.1.4 eVS International Label Example –
GXG Get Label
7.2 Appendix B - Country Codes
7.3 Appendix C - Categories for International Shipping
Regulatory Mandates
This document contains a
Reference Guide to the eVS international label APIs: Priority
Mail Express International, Priority Mail International, Global Express
Guaranteed (see section IV for limitations) and First Class
Mail International (First Class Package International Service). 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. The Web Tool will simply pass in the characters up to the maximum
amount allowed and disregard the rest.
This is important since the resulting value could prevent a correct
response.
When building the XML request, pay particular
attention to the order and case for tags. An error message will be returned if
an incorrect value is entered. Remember
that all data and attribute values in this document are for illustration
purposes and are to be replaced by your actual values. For instance, a line of
sample code may be:
<Pounds>2</Pounds>
In this
instance, you will replace “2” with the weight in pounds for the package.
The only option for creating 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 (no destination entry or presort)
·
Requires enrollment and new Mailer IDs (MIDs) and permits
·
Will do domestic/international/apo/fpo/dpo/US Territories
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. eVS is designed to make
it easy for high-volume package mailers to take advantage of destination entry
rates.
If you want to explore using eVS, please first contact the eVS@usps.gov.
For registration please visit: https://www.usps.com/postalone/evs.htm. If that will not work for you, then you can follow up with
sales@usps.gov (or your local Postmaster or USPS Sales Manager) for additional
solutions outside of the Web Tools API suite.
Note: The “Certify” API signatures are for
testing purposes and will not generate usable labels and barcodes.
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.
For information on registering and getting
started with Web Tools, please refer to the Step-By-Step guide found on the Web Tools Technical Documentation Page.
The eVS Priority Mail Express International Label API lets
customers generate eVS Priority Mail Express
International labels and integrated customs forms.
Note: Scan form is eligible for eVS if HoldForManifest is set to
‘Y’ (Yes).
Note: The “eVSExpressMailIntlCertify”
API signature is for testing purposes and will not generate usable labels and
barcodes.
Scheme |
Host |
Path |
API |
XML |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSExpressMailIntl |
&XML=(see Tag
Descriptions below) |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSExpressMailIntlCertify |
&XML=(see Tag
Descriptions below) |
Tag Name |
Occurs |
Description |
Type |
Validation |
eVSExpressMailIntlRequest |
Required |
|
(Alias) |
|
eVSExpressMailIntlRequest
/ USERID |
Required |
This attribute specifies your Web Tools user ID. See the Developer's Guide for information on obtaining your USERID. For Example: USERID="XXXXXXX" |
NMTOKEN |
|
eVSExpressMailIntlRequest
/ PASSWORD |
Required |
This attribute specifies your Web Tools password. See the Developer's Guide for information on your Password. For Example: PASSWORD="XXXXXXX" |
NMTOKEN |
|
eVSExpressMailIntlRequest / Option |
Optional |
For future use. |
Empty |
|
eVSExpressMailIntlRequest /
Revision |
Optional |
Use of value 2 Required
as of January 2011. For example: <Revision>2</Revision> |
String |
minLength=0 pattern=\d{1} |
eVSExpressMailIntlRequest / ImageParameters |
Optional |
Groups alternate image options. |
(Group) |
|
eVSExpressMailIntlRequest / ImageParameters / ImageParameter |
Optional, repeating up to 3 times |
Returns alternate label image. Only alternate 4’’x6’’ size label image may
be requested at this time. ·
4X6LABEL (4X6 on a full
page 8.5/11” background) ·
4X6LABELL (Landscape –
true size 4X6; image rotated, not on an 8.5 x 11 background page) ·
4X6LABELP (Portrait –
true size 4X6, not on an 8.5 x 11 background page) ·
4X6ZPL203DPI (ZPL -
Zebra Programming Language) format
·
For example: <ImageParameter>4X6LABEL</ImageParameter> |
String |
Enumerations= ·
4X6LABEL ·
4X6LABELL ·
4X6LABELP ·
4X6ZPL203DPI ·
4X6ZPL300DPI |
eVSExpressMailIntlRequest / FromFirstName |
Required |
Both FromFirstName
and FromLastName are Required if FromFirmName is left blank. Maximum Length: 32 characters
total for First, Middle, and Last Names with space after first and middle
name. For example: <FromFirstName>John</FromFirstName> |
String |
maxLength=30 |
eVSExpressMailIntlRequest / FromMiddleInitial |
Optional |
Middle Initial. Maximum Length: 32 characters total for
First, Middle, and Last Names with space after first and middle name. For example: <FromMiddleInitial>L</FromMiddleInitial> |
String |
maxLength=1 |
eVSExpressMailIntlRequest / FromLastName |
Required |
Both FromFirstName
and FromLastName are Required if FromFirmName is left blank. Maximum Length: 32 characters
total for First, Middle, and Last Names with space after first and middle
name. For example: <FromLastName>Doe</FromLastName> |
String |
maxLength=30 |
eVSExpressMailIntlRequest / FromFirm |
Required |
FromFirm is Required
if FromFirstName and FromLastName
are left blank. For example: <FromFirm></FromFirm> |
String |
maxLength=32 |
eVSExpressMailIntlRequest /
FromAddress1 |
Optional |
Use this tag for a suite or apartment
number only. Either Address1 or Address2 is Required. For example: <FromAddress1/> |
String |
maxLength=32 |
eVSExpressMailIntlRequest /
FromAddress2 |
Required |
Use this tag for the primary address line. For example: <FromAddress2>10 Elm
Street </FromAddress2> |
String |
maxLength=32 |
eVSExpressMailIntlRequest / FromUrbanization |
Optional |
Use this tag for Puerto Rico only. ZIP Code
prefixes 006 to 009, if area is so designated. For example: <FromUrbanization>URB
Caparra Ter</FromUrbanization> |
String |
maxLength=32 |
eVSExpressMailIntlRequest / FromCity |
Required |
For example: <FromCity>Anytown</FromCity> |
String |
maxLength=16 |
eVSExpressMailIntlRequest / FromState |
Required |
Use 2-letter USPS state abbreviation. For example: <FromState>ST</FromState> |
String |
length=2 |
eVSExpressMailIntlRequest /
FromZip5 |
Required |
Input tag exactly as presented, not all
caps. 5 digits Required. For example:
<FromZip5>01234</FromZip5> |
String |
whiteSpace=collapse length=5 pattern=\d{5} |
eVSExpressMailIntlRequest /
FromZip4 |
Optional |
Input tag exactly as presented, not all
caps. If value is entered, 4 digits Required. This is the ZIP+4 extension. For example:
<FromZip4>5678</FromZip4> |
String |
whiteSpace=collapse length=4 pattern=\d{4} |
eVSExpressMailIntlRequest / FromPhone |
Required |
10 digits Required (including area code),
with no punctuation. Use format: 2125551234 For example: <FromPhone>5555555555</FromPhone> |
String |
whiteSpace=collapse length=10 pattern=\d{10} |
eVSExpressMailIntlRequest / FromCustomsReference |
Optional |
Enter a value for the "Sender's
Customs Reference" that will appear on the label. The text entered is
any reference number that the sender wishes to use. For example: <FromCustomsReference></FromCustomsReference> |
String |
maxLength=30 |
eVSExpressMailIntlRequest / ToName |
Optional |
Deprecated.
See “ToFirstName” and “ToLastName”
tags. |
String |
maxLength=36 |
eVSExpressMailIntlRequest / ToFirstName |
Required |
Both ToFirstName
and ToLastName are Required if ToFirm
is left blank. For example: <ToFirstName>John</ToFirstName> |
String |
maxLength=30 |
eVSExpressMailIntlRequest / ToLastName |
Required |
Both ToFirstName
and ToLastName are Required if ToFirm
is left blank. For example: <ToLastName>Doe</ToLastName> |
String |
maxLength=30 |
eVSExpressMailIntlRequest / ToFirm |
Required |
ToFirm is Required
if ToFirstName and ToLastName
are left blank. For example: <ToFirm></ToFirm> |
String |
maxLength=36 |
eVSExpressMailIntlRequest /
ToAddress1 |
Optional |
Three address lines are provided, but only
1 is Required. Use as many as needed for complete address. For example: <ToAddress1> Apartado 3068</ToAddress1> |
String |
maxLength=36 |
eVSExpressMailIntlRequest /
ToAddress2 |
Required |
Three address lines are provided, but only
1 is Required. Use as many as needed for complete address. For example:
<ToAddress2></ToAddress2> |
String |
maxLength=36 |
eVSExpressMailIntlRequest /
ToAddress3 |
Optional |
Three address lines are provided, but only
1 is Required. Use as many as needed for complete address. For example:
<ToAddress3></ToAddress3> |
String |
maxLength=36 |
eVSExpressMailIntlRequest / ToCity |
Required |
Recipient's city. For example: <ToCity>PUERTO
VALLARTA</ToCity> |
String |
maxLength=18 |
eVSExpressMailIntlRequest / ToProvince |
Optional |
Enter the province for the recipient. For example: <ToProvince>JALISCO</ToProvince> |
String |
maxLength=9 |
eVSExpressMailIntlRequest / ToCountry |
Required |
The
country name entered must match an entry from the USPS-approved International
Index of Countries and Localities. See the Index of Countries and Localities. Using a country name not on the list will result in a request
failure. For
example: <ToCountry>MEXICO</ToCountry> |
String |
minLength=1 |
eVSExpressMailIntlRequest / ToPostalCode |
Required |
Enter the postal code for the recipient. For example: <ToPostalCode>46807</ToPostalCode> |
String |
maxLength=9 |
eVSExpressMailIntlRequest / ToPOBoxFlag |
Required |
Indicates whether or not
the To Address is a Post Office Box. For example: <ToPOBoxFlag>N</ToPOBoxFlag> |
String |
Enumeration= ·
Y ·
N |
eVSExpressMailIntlRequest / ToPhone |
Optional |
No format checking is done on international
phone numbers. Required when <ToPOBoxFlag>Y</ToPOBoxFlag> For example: <ToPhone>011
52 (322) 222-0069</ToPhone> |
String |
maxLength=30 |
eVSExpressMailIntlRequest / ToFax |
Optional |
No format checking is done on international
fax numbers. For example: <ToFax>011
52 (322) 222-0074</ToFax> |
String |
maxLength=30 |
eVSExpressMailIntlRequest / ToEmail |
Optional |
Complete valid e-mail address is Required
if tag is used. For example: <ToEmail>cpapple@email.com</ToEmail> |
String |
maxLength=30 whiteSpace=collapse pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4} |
eVSExpressMailIntlRequest / ImportersReferenceNumber |
Optional |
Enter a value for the "Importer's
Customs Reference" that will appear on the label. The text entered is
any reference number that the recipient wishes to use. Note: Requires <ImportersReferenceType>
to be specified if used. For example: <ToCustomsReference>Order
23432</ToCustomsReference> |
String |
maxLength=28 |
eVSExpressMailIntlRequest / NonDeliveryOption |
Optional |
In case package is undeliverable, enter one
of the following: "RETURN" for package to be returned to <FromAddress> above. "REDIRECT" to return
package to address specified below in <AltReturn>
tags. "ABANDON" to dispose of undeliverable package. For example: <NonDeliveryOption>RETURN</NonDeliveryOption> |
String |
enumeration= ·
RETURN ·
REDIRECT ·
ABANDON |
eVSExpressMailIntlRequest / RedirectName |
Optional |
Enter a value for the recipient's name. |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / RedirectEmail |
Optional |
Complete valid e-mail address is Required
if tag is used. |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / RedirectSMS |
Optional |
This value must be a syntactically-valid
SMS number. |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / RedirectAddress |
Optional |
Enter the redirect address. This is a free form field. |
String |
minOccurs=0 maxLength=48 |
eVSExpressMailIntlRequest / RedirectCity |
Optional |
Redirect city. For example: < RedirectCity
>ANYTOWN</ RedirectCity > |
String |
minLength=0 |
eVSExpressMailIntlRequest / RedirectState |
Optional |
Redirect state. For example: < RedirectState
>MN</ RedirectState > |
String |
minLength=0 |
eVSExpressMailIntlRequest / RedirectZipCode |
Optional |
Redirect ZIP code. For example: < RedirectZipCode
>12345</RedirectZipCode> |
String |
minLength=0 |
eVSExpressMailIntlRequest /
RedirectZip4 |
Optional |
Redirect ZIP+4 extension. For example: <RedirectZip4>01234</RedirectZip4> |
String |
minLength=0 |
eVSExpressMailIntlRequest /
Container |
Optional |
Container type. |
String |
default=VARIABLE Enumerations= ·
VARIABLE ·
FLATRATEENV ·
LEGALFLATRATEENV ·
PADDEDFLATRATEENV |
eVSExpressMailIntlRequest / ShippingContents |
Conditionally
Required |
Required
only if a customs form is required based on Customs Content Type and Weight. |
(Group) |
|
eVSExpressMailIntlRequest / ShippingContents / ItemDetail |
Required
repeating up to 30 times or optional |
Required
repeating up to 30 times if generating an Integrated Customs Form, otherwise
not required |
(Group) |
|
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
Description |
Required |
Description of the item. Per international
shipping regulatory mandates, shipments to European Union (EU) countries are
required to contain a valid Harmonization Code and Content/Item description.
To learn more about providing acceptable item descriptions, view the chart in
Appendix C or read the EU’s guidance on acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods For
certain countries/destinations (i.e., when the Web Tools Price Calculator APIs
return <HSCodeEnforced>=“true”)
the API enforces a blacklist of descriptions not permitted: none, not
applicable, n/a, null, gift, merchandise Other
non-descriptive wording always results in an error: gift, sample, other For
example: <Description>Policy guidelines document</Description> |
String |
maxLength=30 whiteSpace=collapse |
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
Quantity |
Required |
Quantity of the item. Integer value Required.
For example:
<Quantity>1</Quantity> |
integer |
minInclusive
value="1" |
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
Value |
Required |
The data entered with this tag provides the
value of the set of items. If the item is 2 boxes of 50 pens and the value of
each box is $10.00, "20.00" (2 boxes x $10.00) should be entered.
If the value of each pen is .25 then "25.00" (100 pens x .25)
should be entered. For example:
<Value>55.00</Value> |
decimal |
whiteSpace=collapse minExclusive=0 |
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
NetPounds |
Required |
Provide the pounds component of the weight
of the individual item listed with <Description>. For example: <NetPounds>1</NetPounds> |
integer |
whiteSpace=collapse default=0 |
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
NetOunces |
Required |
Provide the ounces component of the weight
of the individual item listed with <Description>. For example: <NetOunces>5</NetOunces> |
decimal |
default="0.0" |
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
HSTariffNumber |
Required |
For commercial items only. HS Tariff Numbers must be based on the Harmonized Commodity Description and Coding System 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
certain countries/destinations (i.e., when the Web Tools Price Calculator APIs
return <HSCodeEnforced>=“true”)
the API requires a valid <HSTariffNumber>. Web Tools will not validate <HSTariffNumber> if provided in the correct format, but
Web Tools will attempt to obtain a valid <HSTariffNumber>
using the required <Description> and optional <ItemCategory>
and <ItemSubCategory> values provided if <HSTariffNumber> is not provided or is in an incorrect format. For example: <HSTariffNumber>4901.10.0000</HSTariffNumber> |
String |
whiteSpace=collapse maxLength=17 pattern=\d{0,12} |
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
CountryOfOrigin |
Required |
For
commercial items only. Country of Origin means the country where the goods
originated, e.g. were produced, manufactured, or assembled. It is recommended
you supply this information and attach an invoice to the outside to
accelerate customs clearance in processing the items. The country name
entered must match an entry from the USPS-approved International Index of
Countries and Localities or be "United States". http://pe.usps.gov/text/Imm/immctry.htm – click on the link for “International
Country Listings”. Using a country name not on the list will result in a
request failure. For
example: <CountryOfOrigin>United States</CountryOfOrigin> |
String |
|
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
ItemCategory |
Optional |
Item
Category. Per international shipping regulatory mandates, shipments to
European Union (EU) countries are required to contain a valid Harmonization
Code and Content/Item description. To learn more about providing acceptable
item descriptions, view the chart in Appendix C or read the EU’s guidance on
acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods. |
String |
minLength=0 maxLength=100 |
eVSExpressMailIntlRequest / ShippingContents / ItemDetail /
ItemSubCategory |
Optional |
Item
Subcategory. Per international shipping regulatory mandates, shipments to
European Union (EU) countries are required to contain a valid Harmonization
Code and Content/Item description. To learn more about providing acceptable
item descriptions, view the chart in Appendix C or read the EU’s guidance on
acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods. |
String |
minLength=0 maxLength=100 |
eVSExpressMailIntlRequest / InsuredNumber |
Optional |
For backward-compatibility;
not validated. |
String |
|
eVSExpressMailIntlRequest / InsuredAmount |
Optional |
Use this tag for entering an insurance
amount, if known. For example: <InsuredAmount>100.00</InsuredAmount> |
String |
length=0 |
eVSExpressMailIntlRequest /
Postage |
Optional |
Use this tag for entering a postage amount,
if known. If the tag is present, but the value is blank, the postage will be
automatically calculated. For example: <Postage></Postage> or
<Postage>10.50</Postage> |
String |
length=0 |
eVSExpressMailIntlRequest / GrossPounds |
Required |
Gross pounds and ounces together represent
the total package weight, including packing material. For example, a package
weighing 3 lbs 8 ounces would have "3"
entered here and "8" entered with the <GrossOunces>
tag. The Web Tool will check for maximum shipping weight of 70 pounds.
Allowable weight may change based on the service used to send package and the
destination country. For example: <GrossPounds>4</GrossPounds> |
integer |
whiteSpace=collapse |
eVSExpressMailIntlRequest / GrossOunces |
Required |
Enter the ounces component of the total
package weight with this tag. For example: <GrossOunces>0</GrossOunces> |
integer |
maxLength=3 |
eVSExpressMailIntlRequest / ContentType |
Required |
Specifies the content of the package or
envelope. For example:
<ContentType>DOCUMENTS</ContentType> Note: Enumerations are case sensitive “NonnegotiableDocument”
and “Documents” both signify mailable non-negotiable documents and are
insured automatically for up to $100, though Insurance will not be returned
as an extra service. Additional Insurance cannot be purchased. Any non-document ContentType
values are insured automatically for up to $200. Additional Insurance can be
purchased for values $200 and greater. |
String |
Enumerations= ·
MERCHANDISE ·
SAMPLE ·
GIFT ·
DOCUMENTS ·
RETURN ·
HUMANITARIAN ·
DANGEROUSGOODS ·
CrematedRemains ·
NonnegotiableDocument ·
PHARMACEUTICALS ·
MEDICALSUPPLIES ·
OTHER |
eVSExpressMailIntlRequest / ContentTypeOther |
Optional |
Required when <ContentType>OTHER<ContentType>. |
String |
maxLength=15 whiteSpace=collapse |
eVSExpressMailIntlRequest /
Agreement |
Required |
Requires a value of Y to print <FromFirstName/> and <FromLastName/>
in Signature Box along with Current Date (Central Time USA). Any other value
returns an error. |
String |
Enumeration= ·
Y ·
N |
eVSExpressMailIntlRequest /
Comments |
Optional |
Enter any comments. For example:
<Comments></Comments> |
String |
maxLength=76 |
eVSExpressMailIntlRequest / LicenseNumber |
Optional |
Enter license number, if known or if
included in package. For example: <LicenseNumber>LIC-24356879</LicenseNumber> |
String |
maxLength=24 |
eVSExpressMailIntlRequest / CertificateNumber |
Optional |
Enter certificate number, if known or if
included in package. For example: <CertificateNumber>CERT-97865342</CertificateNumber> |
String |
maxLength=24 |
eVSExpressMailIntlRequest / InvoiceNumber |
Optional |
Enter invoice number, if known or if
included in package. For example: <InvoiceNumber>INV-040903</InvoiceNumber> |
String |
maxLength=24 |
eVSExpressMailIntlRequest / ImageType |
Required |
For example: <ImageType>PDF</ImageType> |
String |
enumeration= ·
PDF ·
TIF ·
NONE |
eVSExpressMailIntlRequest / ImageLayout |
Optional |
Controls how the multipage form is returned
in the response tags. "ONEPERFILE" returns one page per response
tag while “ALLINONEFILE” returns all pages in a single response tag. The “TRIM” options conserve page space if possible by combining two form parts on a single page. For example: <ImageLayout>ONEPERFILE<ImageLayout> |
String |
default=ONEPERFILE enumerations= ·
ONEPERFILE ·
ALLINONEFILE ·
TRIMONEPERFILE ·
TRIMALLINONEFILE |
eVSExpressMailIntlRequest / CustomerRefNo |
Optional |
Written to Postal Manifest Detail record. For example: <CustomerRefNo>Ref
369246</CustomerRefNo> |
String |
maxLength=30 |
eVSExpressMailIntlRequest /
CustomerRefNo2 |
Optional |
Written to Postal Manifest Detail record. For example: <CustomerRefNo2>ACT369246</CustomerRefNo2>
|
String |
maxLength=30 |
eVSExpressMailIntlRequest / POZipCode |
Optional |
ZIP of Post Office where
mailed if different from <FromZip5/>. Written to Postal Manifest Detail
record. Must be valid ZIP Code. For example: <POZipCode>00962</POZipCode> |
String |
whiteSpace=collapse length=5 pattern=\d{5} |
eVSExpressMailIntlRequest / LabelDate |
Optional |
Date the mail will enter the mail stream. No more than 3 days in the future. Default
is day of request. For example: <LabelDate>09/28/2010</LabelDate> |
String |
whiteSpace=collapse maxLength=10 pattern=\d{1,2}/\d{1,2}/\d\d(\d\d)? |
eVSExpressMailIntlRequest / EMCAAccount |
Optional |
For future use. USPS Corporate Account |
|
minOccurs=0 |
eVSExpressMailIntlRequest / HoldForManifest |
Optional |
Restricted use. Holds manifest record for
possible inclusion in SCAN request. |
String |
enumeration= ·
Y ·
N |
eVSExpressMailIntlRequest / EELPFC |
Optional repeating up to 1 times |
Exemption and Exclusion Legend
or PFC Code. Please refer to the
International Mail Manual for further information: http://pe.usps.gov/text/imm/immc5_007.htm. For
example: <EELPFC>30.37a</EELPFC> |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / PriceOptions |
Optional |
Indicates
if commercial-base price should be returned. For commercial-base price
eligibility, please reference the Domestic Mail Manual at http://pe.usps.com/. |
String |
default=COMMERCIAL BASE enumeration= ·
COMMERCIAL PLUS ·
COMMERCIAL BASE |
eVSExpressMailIntlRequest / Length |
Optional |
Value
must be numeric. Units are inches. If partial dimensions are provided, an
error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / Width |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error 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
for non-rectangular packages. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / Height |
Optional |
Value
must be numeric. Units are inches. If partial dimensions are provided, an
error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / Girth |
Optional |
Value
must be numeric. Units are inches. If partial dimensions are provided, an
error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / LabelTime |
Optional |
Available if <Revision>= 2. LabelTime is used
in conjunction with LabelDate to determine the
Guarantee |
String |
Format hh:mm |
eVSExpressMailIntlRequest / MeterPaymentFlag |
Optional |
Meter
payment indicator |
String |
Default=N Enumerations: ·
N ·
Y |
eVSExpressMailIntlRequest / ActionCode |
Optional |
Used to
specify the action code.Value
is passed to Shipping Partner Event file via the shipment manifest. M0 – Mailer
Owner S0 – Service
Provider For
example: <ActionCode>M0</ActionCode> |
String |
Default = M0 enumeration= ·
M0 ·
S0 ·
“space“ |
eVSExpressMailIntlRequest / OptOutOfSPE |
Optional |
Allows a customer to opt out of SPE file creation.
“false” WILL create a SPE file. |
Boolean |
Default = True enumeration= ·
true ·
false |
eVSExpressMailIntlRequest / PermitNumber |
Optional |
Number associated with a mailing
permit. The permit is permission to
use a certain postage payment method for bulk and commercial mailings |
String |
minOccurs=0 |
eVSExpressMailIntlRequest / ImportersReferenceType |
Conditionally
Required |
Tax code / VAT no. / Importer Code Note: Required when <ImportersReferenceNumber> is used. |
String |
minOccurs=0 enumeration= ·
TAXCODE ·
VAT ·
IMPORTERCODE |
eVSExpressMailIntlRequest / ImportersTelephoneNumber |
Optional |
For Importer: 10 digits (including area
code), with no punctuation. Use format: 2125551234. For example: <FromPhone>2125551234</FromPhone> |
String |
whiteSpace=collapse length=10 pattern=\d{10} |
eVSExpressMailIntlRequest / ImportersFaxNumber |
Optional |
For Importer: No format checking is done on
international fax numbers. For example: <ToFax>011
52 (322) 222-0074</ToFax> |
String |
maxLength=30 |
eVSExpressMailIntlRequest / ImportersEmail |
Optional |
For Importer: Complete valid e-mail address
is Required if tag is used. For example: <ToEmail>cpapple@email.com</ToEmail> |
String |
maxLength=30 whiteSpace=collapse pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4} |
eVSExpressMailIntlRequest / Machinable |
Optional |
Indicates whether or not
the item is machinable. For example:
<Machinable>false</Machinable> |
Boolean |
default=true whiteSpace=collapse
|
eVSExpressMailIntlRequest / DestinationRateIndicator |
Required |
Required for destination entry packagesenter
either “I” or “N”. I= International Service Center (ISC) N = None |
String |
enumerations= ·
I ·
N |
eVSExpressMailIntlRequest / MID |
Optional |
Mailer
ID (MID), Represents Mail Owner MID. Located
in position #13 in the Detail 1 record of the Shipping Services File v2.0. For
example: <MID>847654321</ MID> |
String |
Length=6
or 9 positions, if populated |
eVSExpressMailIntlRequest / LogisticsManagerMID |
Optional |
The MID
of the company that manages the mailing. Located
in position #12 in the Detail 1 record of the Shipping Services File v2.0. Note:
If LogisticsManagerMID is populated, either CRID or
MID must also be populated. For
example: <LogisticsManagerMID>489001< / LogisticsManagerMID> |
String |
Length=6
or 9 positions, if populated |
eVSExpressMailIntlRequest / CRID |
Optional |
Customer
Registration ID, Represents Mail Owner CRID. Located
in position #20 in the Detail 1 record of the Shipping Services File v2.0. For
example: <CRID>544762</ CRID> |
String |
minLength=0 |
eVSExpressMailIntlRequest / VendorCode |
Optional |
Code
from vendor software to identify the developer of the shipping system. Located
in position #15 in the Detail 1 record of the Shipping Services File v2.0. For
example: <VendorCode>1234<VendorCode> |
String |
minLength=0 default=8300 |
eVSExpressMailIntlRequest / VendorProductVersionNumber |
Optional |
Shipping
software’s product version number. Located
in position #16 in the Detail 1 record of the Shipping Services File v2.0. For
example: <VendorProductVersionNumber>5.02.1B</ VendorProductVersionNumber> |
String |
minLength=0 |
eVSExpressMailIntlRequest / ePostageMailerReporting |
Optional |
Verifies Sender Information, sender fields
must match From information when <ePostageMailerReporting>=1 1 - (ePostage
sender information in SSF ) 2 - (ePostage sender information through DES) 3 - (ePostage
sender information using child MID) |
String |
enumerations= ·
1 ·
2 ·
3 |
eVSExpressMailIntlRequest / SenderFirstName |
Optional |
First
Name of Sender. For
example: <SenderFirstName>Adam </SenderFirstName> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 |
eVSExpressMailIntlRequest / SenderLastName |
Optional |
Last Name
of Sender. For
example: <SenderLastName>Smith </SenderLastName> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 |
eVSExpressMailIntlRequest / SenderBusinessName |
Optional |
Values
for Sender Business Name must be sent. For example: <SenderBusinessName>USPS</SenderBusinessName> |
String |
minLength=0 |
eVSExpressMailIntlRequest / SenderAddress1 |
Optional |
Sender
address line. Use this tag for full address (Address1 and Address2) Must
match Address1 and Address2 or will produce an error. For
example: <SenderAddress1>STE 150 10 Elm Street </SenderAddress1> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 |
eVSExpressMailIntlRequest / SenderCity |
Optional |
Sender
city. For example: <SenderCity>BETHESDA</SenderCity>Required when <ePostageMailerReporting>=1 |
String |
minLength=0 |
eVSExpressMailIntlRequest / SenderState |
Optional |
Sender
state. For example: <SenderState>MD</SenderState> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 |
eVSExpressMailIntlRequest / SenderZip5 |
Optional |
Sender
ZIP code. For example:
<SenderZip5>20212</SenderZip5> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 pattern=d(5) |
eVSExpressMailIntlRequest / SenderPhone |
Optional |
Sender
Phone #. 10 digits Required (including area code), with no punctuation.
For example:
<SenderPhone>2125551234</SenderPhone> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 pattern=d(10) |
eVSExpressMailIntlRequest / SenderEmail |
Optional |
E-mail
Address of Sender. Valid e-mail addresses must be used. For
example: <SenderEMail>cpapple@email.com</SenderEMail> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4} |
eVSExpressMailIntRequest |
Required |
|
(Alias) |
|
Request:
eVSExpressMailIntl <eVSExpressMailIntlRequest USERID="XXXXXXXXX"
PASSWORD="XXXXXXXXX"> <Option></Option> <Revision>2</Revision> <ImageParameters></ImageParameters> <FromFirstName>John</FromFirstName> <FromMiddleInitial>L</FromMiddleInitial> <FromLastName>Doe</FromLastName> <FromFirm></FromFirm> <FromAddress1></FromAddress1> <FromAddress2>7
North Wilke-Barre Blvd</FromAddress2> <FromUrbanization></FromUrbanization> <FromCity>Wilkes-Barre</FromCity> <FromState>PA</FromState> <FromZip5>18702</FromZip5> <FromZip4></FromZip4> <FromPhone>5555555555</FromPhone> <FromCustomsReference></FromCustomsReference> <ToName></ToName> <ToFirstName>Ms. C. P.</ToFirstName> <ToLastName>Apple</ToLastName> <ToFirm></ToFirm> <ToAddress1>
Apartado 3068</ToAddress1> <ToAddress2></ToAddress2> <ToAddress3></ToAddress3> <ToCity>Golden Rock</ToCity> <ToProvince></ToProvince> <ToCountry>Australia</ToCountry> <ToPostalCode>2046</ToPostalCode> <ToPOBoxFlag>N</ToPOBoxFlag> <ToPhone>011 52 (322) 222-0069</ToPhone> <ToFax>011 52 (322) 222-0074</ToFax> <ToEmail>cpapple@email.com</ToEmail> <ImportersReferenceNumber></ImportersReferenceNumber> <NonDeliveryOption>RETURN</NonDeliveryOption> <RedirectName></RedirectName> <RedirectEmail></RedirectEmail> <RedirectSMS></RedirectSMS> <RedirectAddress></RedirectAddress> <RedirectCity></RedirectCity> <RedirectState></RedirectState> <RedirectZIPCode>MEXICO</RedirectZIPCode> <Container>VARIABLE</Container> <ShippingContents> <ItemDetail> <Description>Policy
guidelines document</Description> <Quantity>1</Quantity> <Value>55.00</Value> <NetPounds>1</NetPounds> <NetOunces>5</NetOunces> <HSTariffNumber>490110</HSTariffNumber> <CountryOfOrigin>United States</CountryOfOrigin> </ItemDetail> </ShippingContents> <InsuredNumber>V-12324589765</InsuredNumber> <InsuredAmount>100.00</InsuredAmount> <GrossPounds>4</GrossPounds> <GrossOunces>0</GrossOunces> <ContentType>DOCUMENTS</ContentType> <ContentTypeOther></ContentTypeOther> <Agreement>Y</Agreement> <Comments></Comments> <LicenseNumber>LIC-24356879</LicenseNumber> <CertificateNumber>CERT-97865342</CertificateNumber> <InvoiceNumber>INV-040903</InvoiceNumber> <ImageType>TIF</ImageType> <ImageLayout></ImageLayout> <CustomerRefNo>Ref 369246</CustomerRefNo> <CustomerRefNo2>ACT
369246</CustomerRefNo2> <POZipCode>00962</POZipCode> <LabelDate></LabelDate> <HoldForManifest>N</HoldForManifest> <PriceOptions></PriceOptions> <Length>20.5</Length> <Width>5.5</Width> <Height>5.5</Height> <Girth>6.25</Girth> <LabelTime>14:24:13</LabelTime> <MeterPaymentFlag>N</MeterPaymentFlag> <DestinationRateIndicator>N</DestinationRateIndicator> </eVSExpressMailIntlRequest> eVS
Express Mail International w/ HS Tarriff Number & Tags <eVSExpressMailIntlCertifyRequest USERID="XXXXXXXXX"
PASSWORD="XXXXXXXXX"> <Option></Option> <Revision>2</Revision> <ImageParameters> <ImageParameter>4BY6LABEL</ImageParameter> </ImageParameters> <FromFirstName>John</FromFirstName> <FromMiddleInitial>L</FromMiddleInitial> <FromLastName>Doe</FromLastName> <FromFirm></FromFirm> <FromAddress1></FromAddress1> <FromAddress2>430 blackman
st.</FromAddress2> <FromUrbanization></FromUrbanization> <FromCity>Wilkes-Barre</FromCity> <FromState>PA</FromState> <FromZip5>18702</FromZip5> <FromZip4></FromZip4> <FromPhone>5555555555</FromPhone> <FromCustomsReference></FromCustomsReference> <ToName></ToName> <ToFirstName>Ms.
C. P.</ToFirstName> <ToLastName>Apple</ToLastName> <ToFirm></ToFirm> <ToAddress1> Apartado
3068</ToAddress1> <ToAddress2></ToAddress2> <ToAddress3></ToAddress3> <ToCity>Golden
Rock</ToCity> <ToProvince></ToProvince> <ToCountry>Ireland</ToCountry> <ToPostalCode>2046</ToPostalCode> <ToPOBoxFlag>N</ToPOBoxFlag> <ToPhone>011
52 (322) 222-0069</ToPhone> <ToFax>011
52 (322) 222-0074</ToFax> <ToEmail>cpapple@email.com</ToEmail> <ImportersReferenceNumber></ImportersReferenceNumber> <NonDeliveryOption>RETURN</NonDeliveryOption> <RedirectName>BOB
Meier</RedirectName> <RedirectEmail>bob@mailinator.com</RedirectEmail> <RedirectSMS>5708251341</RedirectSMS> <RedirectAddress>7
wilkes Barre</RedirectAddress> <RedirectCity>Wilkes
Barre</RedirectCity> <RedirectState>PA</RedirectState> <RedirectZIPCode>18702</RedirectZIPCode>
<RedirectZIP4>5150</RedirectZIP4> <Container>VARIABLE</Container> <ShippingContents> <ItemDetail> <Description>Policy guidelines
document</Description> <Quantity>1</Quantity> <Value>55.00</Value> <NetPounds>1</NetPounds> <NetOunces>5</NetOunces> <HSTariffNumber>4901.10.0000</HSTariffNumber> <CountryOfOrigin>United
States</CountryOfOrigin> <ItemCategory>turbo</ItemCategory> <ItemSubCategory>charger</ItemSubCategory> </ItemDetail> </ShippingContents> <InsuredNumber>V-12324589765</InsuredNumber> <InsuredAmount>100.00</InsuredAmount> <GrossPounds>4</GrossPounds> <GrossOunces>0</GrossOunces> <ContentType>DOCUMENTS</ContentType> <ContentTypeOther></ContentTypeOther> <Agreement>Y</Agreement> <Comments></Comments> <LicenseNumber>LIC-24356879</LicenseNumber> <CertificateNumber>CERT-97865342</CertificateNumber> <InvoiceNumber>INV-040903</InvoiceNumber> <ImageType>TIF</ImageType> <ImageLayout></ImageLayout> <CustomerRefNo>Ref
#369246</CustomerRefNo> <POZipCode>00962</POZipCode> <LabelDate></LabelDate> <HoldForManifest>N</HoldForManifest> <PriceOptions></PriceOptions> <Size>LARGE</Size> <Length>20.5</Length> <Width>5.5</Width> <Height>5.5</Height> <Girth>6.25</Girth> <LabelTime>14:24:13</LabelTime> <MeterPaymentFlag>N</MeterPaymentFlag> <DestinationRateIndicator>N</DestinationRateIndicator> </eVSExpressMailIntlCertifyRequest> |
Tag Name |
Occurs |
Description |
Type |
Validation |
eVSExpressMailIntlResponse |
Required
|
|
(Alias)
|
|
eVSExpressMailIntlResponse/ Postage |
Required
|
Postage
amount |
Decimal |
|
eVSExpressMailIntlResponse/ TotalValue |
Required
|
Value
of all items being shipped |
Decimal |
|
eVSExpressMailIntlResponse/ SDRValue |
Required
|
Special
Drawing Right calculated on Insured Amount |
Decimal |
|
eVSExpressMailIntlResponse/ BarcodeNumber |
Required
|
Mail service related barcode. |
String |
|
eVSExpressMailIntlResponse/ LabelImage |
Required
|
Encoded
images of label (may be empty depending upon layout option selected) |
String |
|
eVSExpressMailIntlResponse/ Page2Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected) |
String |
|
eVSExpressMailIntlResponse/ Page3Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected) |
String |
|
eVSExpressMailIntlResponse/ Page4Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected) |
String |
|
eVSExpressMailIntlResponse/ Page5Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected) |
String |
|
eVSExpressMailIntlResponse/ Page6Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected) |
String |
|
eVSExpressMailIntlResponse/ Prohibitions |
Required
|
List of
items prohibited from mailing based on country of destination |
String |
|
eVSExpressMailIntlResponse/ Restrictions |
Required
|
Restrictions
on items being shipped based on country of destination |
String |
|
eVSExpressMailIntlResponse/ Observations |
Required
|
Additional
mailing information based on country of destination |
String |
|
eVSExpressMailIntlResponse/ Regulations |
Required
|
Additional
regulations for shipping to destination country |
String |
|
eVSExpressMailIntlResponse/ AdditionalRestrictions |
Required |
Additional
restrictions on items being shipped to destination country |
String |
|
eVSExpressMailIntlResponse/ InsuranceFee |
Optional |
Insurance Fee |
Decimal |
minExclusive=0.0 |
eVSExpressMailIntlResponse/ DestinationBarcodeNumber |
Optional |
Appears
if mail class is available. |
String |
minoccurs=0 |
eVSExpressMailIntlResponse/ GuaranteeAvailability |
Optional |
Appears
if ToPostalCode and LabelTime
are available. The value will be the GuaranteeDate or a message. |
String |
If an
estimated scheduled delivery date is available, the format will be MM/DD/YYYY e.g, 03/15/2015
If an
estimated scheduled delivery date is not available, the format will be a String,
e.g., 3 - 5 business days to many major markets |
eVSExpressMailIntlResponse/ RemainingBarcodes |
Required |
This
contains the number of remaining barcodes that can be generated for this particular request. |
String |
|
eVSExpressMailIntlResponse/ Warning |
Optional |
|
String |
|
eVSExpressMailIntlResponse |
Required
|
|
(Alias)
|
|
Response:eVSExpressMailIntl <eVSExpressMailIntlResponse> |
<Postage>66.21</Postage> |
<TotalValue>55.00</TotalValue> |
<SDRValue>65.80</SDRValue> |
<BarcodeNumber>EC502016320US</BarcodeNumber> |
<LabelImage>.....removed.....</LabelImage> |
<Page2Image>.....removed.....</Page2Image> |
<Page3Image>.....removed.....</Page3Image> |
<Page4Image>.....removed.....</Page4Image> |
<Page5Image>.....removed.....</Page5Image> |
<Page6Image></Page6Image> |
<Prohibitions> |
Coins;
bank notes; currency notes (paper money); securities of any kind payable to
bearer; traveler's checks; platinum, gold, and silver (except for jewelry
items meeting the requirement in "Restrictions" below); precious
stones (except when contained in jewelry items meeting the requirement in
"Restrictions" below); and other valuable articles are prohibited. |
Fruit
cartons (used or new). |
Goods
bearing the name "Anzac." |
Goods
produced wholly or partly in prisons or by convict labor. |
Most
food, plant, and animal products, including the use of products such as straw
and other plant material as packing materials. |
Perishable
infectious biological substances. |
Radioactive
materials. |
Registered
philatelic articles with fictitious addresses. |
Seditious
literature. |
Silencers
for firearms. |
Used
bedding. |
</Prohibitions> |
<Restrictions> |
Jewelry
is permitted only when sent as an insured parcel using Priority Mail
International service. In addition, Australian Customs regulations prohibit
importation of jewelry that is made with ivory or from endangered species,
such as snake, elephant, or crocodile, that does not have an accompanying
Import/Export Permit in relation to the Convention on International Trade in
Endangered Species of Wild Fauna and Flora (CITES). |
Meat
and other animal products; powdered or concentrated milk; and other dairy
products requires permission to import from the Australian quarantine
authorities. |
Permission
of the Australian Director-General of Health is Required to import medicines. |
</Restrictions> |
<Observations>Duty
may be levied on catalogs, price lists, circulars, and all advertising
introduced into Australia through the mail, regardless of the class of mail used.</Observations> |
<Regulations> |
Country
Code: |
AU |
Reciprocal
Service Name: |
Express
Post |
Required
Customs Form/Endorsement |
1.
Business and commercial papers. |
No form
Required. Endorse item clearly next to mailing label as BUSINESS PAPERS. |
2.
Merchandise samples without commercial value microfilm, microfiche, and
computer data. |
PS Form
2976-A, Customs Declaration and Dispatch Note CP 72, inside a PS Form 2976-E,
Customs Declaration Envelope CP 91. |
3.
Merchandise and all articles subject to customs duty. |
PS Form
2976-A, Customs Declaration and Dispatch Note CP 72, inside a PS Form 2976-E,
Customs Declaration Envelope CP 91. |
Note: |
1.
Coins; banknotes; currency notes, including paper money; securities of any
kind payable to bearer; traveler's checks; platinum, gold, and silver;
precious stones; jewelry; watches; and other valuable articles are prohibited
in Priority Mail Express International shipments to Australia. |
2.
Priority Mail Express International With Guarantee
service - which offers a date-certain, postage-refund guarantee - is
available to Australia. |
Areas
Served: |
All
except Lord Howe Island and the Australian Antarctic territories. |
</Regulations> |
<AdditionalRestrictions>No Additional Restrictions Data
found.</AdditionalRestrictions> |
<InsuranceFee>0</InsuranceFee> |
<GuaranteeAvailability>03/11/2015</GuaranteeAvailability> |
<RemainingBarcodes>29< RemainingBarcodes> |
</eVSExpressMailIntlResponse> |
The eVS Priority Mail Express International Label API lets
customers generate eVS Priority Mail Express
International labels given the weight and dimensions of the item.
Note: The “eVSPriorityMailIntlCertify”
API signature is for testing purposes and will not generate usable labels and
barcodes.
Scheme |
Host |
Path |
API |
XML |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSPriorityMailIntl |
&XML=(see
Tag Descriptions below) |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSPriorityMailIntlCertify |
&XML=(see
Tag Descriptions below) |
Tag Name |
Occurs |
Description |
Type |
Validation |
||||
eVSPriorityMailIntRequest |
Required
|
Produces
a Priority Mail International label with customs declaration |
(Alias)
|
|
||||
eVSPriorityMailIntlRequest / USERID |
Required |
This attribute specifies your Web Tools user ID. See the Developer's Guide for information on obtaining your USERID. For Example: USERID="XXXXXXX" |
NMTOKEN |
|
||||
eVSPriorityMailIntlRequest / PASSWORD |
Required |
This attribute specifies your Web Tools password. See the Developer's Guide for information on your Password. For Example: PASSWORD="XXXXXXX" |
NMTOKEN |
|
||||
eVSPriorityMailIntlRequest / Option |
Optional
|
For
future use. |
Empty |
|
||||
eVSPriorityMailIntlRequest / Revision |
Required |
Use of
value 2 Required as of January 2011. For
example: <Revision>2</Revision> |
String |
|
||||
eVSPriorityMailIntlRequest / ImageParameters |
Optional
|
Groups
alternate image options. |
(Group) |
minoccurs=0 |
||||
eVSPriorityMailIntlRequest / ImageParameters / ImageParameter |
Optional,
repeating up to 3 times |
Returns alternate label image. Only alternate 4’’x6’’ size label image may
be requested at this time. ·
4X6LABEL (4X6 on a full
page 8.5/11” background) ·
4X6LABELL (Landscape –
true size 4X6; image rotated, not on an 8.5 x 11 background page) ·
4X6LABELP (Portrait –
true size 4X6, not on an 8.5 x 11 background page) ·
4X6ZPL203DPI (ZPL - Zebra
Programming Language) format
For example: <ImageParameter>4X6LABEL</ImageParameter> |
String |
Enumerations= ·
4X6LABEL ·
4X6LABELL ·
4X6LABELP ·
4X6ZPL203DPI ·
4X6ZPL300DPI |
||||
eVSPriorityMailIntlRequest / FromFirstName |
Required |
Both FromFirstName and FromLastName
are Required if FromFirmName is left blank. Maximum
Length: 32 characters total for First, Middle, and Last Names with space
after first and middle name. For
example: <FromFirstName>John</FromFirstName> |
String |
maxLength=30 |
||||
eVSPriorityMailIntlRequest / FromMiddleInitial |
Optional
|
Middle
Initial. Maximum Length: 32 characters total for First, Middle, and Last
Names with space after first and middle name. For
example: <FromMiddleInitial>L</FromMiddleInitial> |
String |
maxLength=1 |
||||
eVSPriorityMailIntlRequest / FromLastName |
Required |
Both FromFirstName and FromLastName
are Required if FromFirmName is left blank. Maximum Length: 32 characters total for
First, Middle, and Last Names with space after first and middle name. For
example: <FromLastName>Doe</FromLastName> |
String |
maxLength=30 |
||||
eVSPriorityMailIntlRequest / FromFirm |
Required |
FromFirm is Required
if FromFirstName and FromLastName
are left blank. For
example: <FromFirm>XYZ</FromFirm> |
String |
maxLength=32 |
||||
eVSPriorityMailIntlRequest / FromAddress1 |
Optional
|
Use
this tag for a suite or apartment number only. Either Address1 or Address2 is
Required. For
example: <FromAddress1>Suite 100</FromAddress1> |
String |
maxLength=32 |
||||
eVSPriorityMailIntlRequest / FromAddress2 |
Required
|
Use
this tag for the primary address line. For
example: <FromAddress2>10 Elm Street </FromAddress2> |
String |
maxLength=32 whiteSpace=collapse |
||||
eVSPriorityMailIntlRequest / FromUrbanization |
Optional
|
Use
this tag for Puerto Rico only. ZIP Code prefixes 006 to 009, if area is so
designated. For
example: <FromUrbanization>URB Caparra
Ter</FromUrbanization> |
String |
maxLength=32
|
||||
eVSPriorityMailIntlRequest / FromCity |
Required
|
For example:
<FromCity>Anytown</FromCity>
|
String |
maxLength=16 |
||||
eVSPriorityMailIntlRequest / FromState |
Required
|
Use
2-letter USPS abbreviation. For
example: <FromState>ST</FromState> |
String |
length=2
|
||||
eVSPriorityMailIntlRequest / FromZip5 |
Required
|
Input
tag exactly as presented, not all caps. 5 digits Required. For
example: <FromZip5>01234</FromZip5> |
String |
whiteSpace=collapse length=5 pattern=\d{5} |
||||
eVSPriorityMailIntlRequest / FromZip4 |
Optional
|
Input
tag exactly as presented, not all caps. If value is entered, 4 digits Required.
This is the ZIP+4 extension. For
example: <FromZip4>5678</FromZip4> |
String |
whiteSpace=collapse length=4 pattern=\d{4} |
||||
eVSPriorityMailIntlRequest / FromPhone |
Required
|
10
digits Required (including area code), with no punctuation. Use format: 2125551234 For
example: <FromPhone>5555555555</FromPhone> |
String |
whiteSpace=collapse length=10 pattern=\d{10} |
||||
eVSPriorityMailIntlRequest / FromCustomsReference |
Optional
|
Enter a
value for the "Sender's Customs Reference" that will appear on the
label. The text entered is any reference number that the sender wishes to
use. For
example: <FromCustomsReference></FromCustomsReference> |
String |
maxLength=30
|
||||
eVSPriorityMailIntlRequest / ToName |
Optional |
Deprecated. See “ToFirstName”
and “ToLastName” tags. |
String |
maxLength=36 |
||||
eVSPriorityMailIntlRequest / ToFirstName |
Required |
Both ToFirstName and ToLastName are Required
if ToFirm is left blank. For
example: <ToFirstName>John</ToFirstName> |
String |
maxLength=30 |
||||
eVSPriorityMailIntlRequest / ToLastName |
Required |
Both ToFirstName and ToLastName are Required
if ToFirm is left blank. For
example: <ToLastName>Doe</ToLastName> |
String |
maxLength=30 |
||||
eVSPriorityMailIntlRequest / ToFirm |
Required |
ToFirm is Required
if ToFirstName and ToLastName
are left blank. For
example: <ToFirm>YYZ</ToFirm> |
String |
maxLength=36 |
||||
eVSPriorityMailIntlRequest / ToAddress1 |
Optional |
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. For
example: <ToAddress1> Apartado
3068</ToAddress1> |
String |
maxLength=36 |
||||
eVSPriorityMailIntlRequest / ToAddress2 |
Required |
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. For
example: <ToAddress2></ToAddress2> |
String |
maxLength=36 |
||||
eVSPriorityMailIntlRequest / ToAddress3 |
Optional
|
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. For
example: <ToAddress3></ToAddress3> |
String |
maxLength=36 |
||||
eVSPriorityMailIntlRequest / ToCity |
Required
|
Recipient's
city. For
example: <ToCity>PUERTO VALLARTA</ToCity> |
String |
maxLength=18 |
||||
eVSPriorityMailIntlRequest / ToProvince |
Optional
|
Enter
the province for the recipient. For
example: <ToProvince>JALISCO</ToProvince> |
String |
maxLength=9 |
||||
eVSPriorityMailIntlRequest / ToCountry |
Required
|
The
country name entered must match an entry from the USPS-approved International
Index of Countries and Localities. (http://pe.usps.gov/text/Imm/Immctry.htm - click on the link for
"International Country Listings.") Using a country name not on the
list will result in a request failure. For
example: <ToCountry>MEXICO</ToCountry> |
String |
minLength=1
|
||||
eVSPriorityMailIntlRequest / ToPostalCode |
Required
|
Enter
the postal code for the recipient. For
example: <ToPostalCode>46807</ToPostalCode> |
String |
maxLength=9 |
||||
eVSPriorityMailIntlRequest / ToPOBoxFlag |
Required
|
Indicates
whether or not the To Address is a Post Office Box. For
example: <ToPOBoxFlag>N</ToPOBoxFlag> |
String |
enumeration= ·
Y ·
N |
||||
eVSPriorityMailIntlRequest / ToPhone |
Optional
|
No
format checking is done on international phone numbers. Required when <ToPOBoxFlag>Y</ToPOBoxFlag> For
example: <ToPhone>011 52 (322) 222-0069</ToPhone> |
String |
maxLength=30 |
||||
eVSPriorityMailIntlRequest / ToFax |
Optional
|
No
format checking is done on international fax numbers. For
example: <ToFax>011 52 (322) 222-0074</ToFax> |
String |
maxLength=30 |
||||
eVSPriorityMailIntlRequest / ToEmail |
Optional
|
Complete
valid e-mail address is Required if tag is used. For
example: <ToEmail>cpapple@email.com</ToEmail> |
String |
maxLength=30 whiteSpace=collapse pattern=([\w\-\.]+)@(([\w-]+\.))+[a-zA-Z]{2,4} |
||||
eVSPriorityMailIntlRequest / ImportersReferenceNumber |
Optional
|
Enter a
value for the "Recipient's Reference" that will appear on the
label. The text entered is any reference number that the recipient wishes to
use. Note: Requires <ImportersReferenceType>
to be specified if used. For
example: <ImportersReferenceNumber>Order
23432</ImportersReferenceNumber> |
String |
maxLength=28 |
||||
eVSPriorityMailIntlRequest / NonDeliveryOption |
Optional
|
In case
package is undeliverable, enter one of the following: ·
"RETURN" for package to be returned to <FromAddress> above. ·
"REDIRECT" to return package to address
specified below in <AltReturn…> tags. ·
"ABANDON" to dispose of undeliverable package. For
example: <NonDeliveryOption>RETURN</NonDeliveryOption> |
String |
default=ABANDON enumeration= ·
RETURN ·
REDIRECT ·
ABANDON |
||||
eVSPriorityMailIntlRequest / RedirectName |
Optional |
|
String |
Minoccurs=0 |
||||
eVSPriorityMailIntlRequest / RedirectName |
Optional |
Enter a
value for the recipient's name. |
String |
minOccurs=0 |
||||
eVSPriorityMailIntlRequest / RedirectEmail |
Optional |
Complete
valid e-mail address is Required if tag is used. |
String |
minOccurs=0 |
||||
eVSPriorityMailIntlRequest / RedirectSMS |
Optional |
This
value must be a syntactically-valid SMS number. |
String |
minOccurs=0 |
||||
eVSPriorityMailIntlRequest / RedirectAddress |
Optional |
Enter
the redirect address. This is a free
form field. |
String |
minOccurs=0 |
||||
eVSPriorityMailIntlRequest / RedirectCity |
Optional |
Redirect
city. For
example: <T RedirectCity >ANYTOWN</ RedirectCity > |
String |
minLength=0 |
||||
eVSPriorityMailIntlRequest / RedirectState |
Optional |
Redirect
state. For
example: < RedirectState >MN</ RedirectState> |
String |
minLength=0 |
||||
eVSPriorityMailIntlRequest / RedirectZipCode |
Optional |
Redirect
ZIP code. For
example: < RedirectZipCode >12345</ RedirectZipCode> |
String |
minLength=0 pattern=\d{5} |
||||
eVSPriorityMailIntlRequest / RedirectZip4 |
Optional |
Redirect
ZIP+4 extension. For
example: <ToZip5>01234</ToZip5> |
String |
minLength=0 |
||||
eVSPriorityMailIntlRequest / Container |
Optional
|
For
example: <Container>MDFLATRATEBOX</Container> Otherwise,
use to specify special containers or container attributes that may affect
postage. |
String |
default=VARIABLE enumerations= ·
VARIABLE ·
LGFLATRATEBOX ·
SMFLATRATEBOX ·
MDFLATRATEBOX ·
FLATRATEENV ·
LEGALFLATRATEENV ·
PADDEDFLATRATEENV ·
SMFLATRATEENV ·
WINDOWFLATRATEENV ·
GIFTCARDFLATRATEENV ·
LGVIDEOBOX ·
RECTANGULAR ·
FLATRATEENV ·
NONRECTANGULAR |
||||
eVSPriorityMailIntlRequest / ShippingContents |
Required
|
|
(Group)
|
|
||||
eVSPriorityMailIntlRequest / ShippingContents / ItemDetail |
Required
repeating up to 30 times |
Groups
individual item details |
(Group) |
|
||||
eVSPriorityMailIntlRequest / ShippingContents / ItemDetail
/ Description |
Required
|
Description of the item. Per international
shipping regulatory mandates, shipments to European Union (EU) countries are
required to contain a valid Harmonization Code and Content/Item description.
To learn more about providing acceptable item descriptions, view the chart in
Appendix C or read the EU’s guidance on acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods For
certain countries/destinations (i.e., when the Web Tools Price Calculator
APIs return <HSCodeEnforced>=“true”) the API enforces a blacklist of descriptions not permitted:
none, not applicable, n/a, null, gift, merchandise Other
non-descriptive wording always results in an error: gift, sample, other For
example: <Description>Policy guidelines document</Description> |
String |
maxLength=30 whiteSpace=collapse
|
||||
eVSPriorityMailIntlRequest / ShippingContents / ItemDetail
/ Quantity |
Required
|
Quantity
of the item. Integer value Required. For
example: <Quantity>1</Quantity> |
Integer |
whiteSpace=collapse minExclusive=0
|
||||
eVSPriorityMailIntlRequest / ShippingContents / ItemDetail
/ Value |
Required
|
The
data entered with this tag provides the value of the set of items. For
example: If the item is 2 boxes of 50 pens and the value of each box is
$10.00, "20.00" (2 boxes x $10.00) should be entered. If the value
of each pen is .25 then "25.00" (100 pens x .25) should be entered.
For
example: <Value>55.00</Value> |
Decimal |
whiteSpace=collapse minExclusive=0
|
||||
eVSPriorityMailIntlRequest / ShippingContents / ItemDetail
/ NetPounds |
Required
|
Provide
the pounds component of the weight of the individual item listed with
<Description>. For
example: <NetPounds>1</NetPounds>
|
Integer |
default=0 whiteSpace=collapse
|
||||
eVSPriorityMailIntlRequest / ShippingContents / ItemDetail
/ NetOunces |
Required
|
Provide
the ounces component of the weight of the individual item listed with
<Description>. For
example: <NetOunces>5</NetOunces>
|
Decimal |
default=0.0 whiteSpace=collapse
|
||||
eVSPriorityMailIntlRequest / ShippingContents / ItemDetail
/ HSTariffNumber |
Required
|
For commercial items only. HS Tariff Numbers must be based on the Harmonized Commodity Description and Coding System 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
certain countries/destinations (i.e., when the Web Tools Price Calculator APIs
return <HSCodeEnforced>=“true”)
the API requires a valid <HSTariffNumber>. Web Tools will not validate <HSTariffNumber> if provided in the correct format, but
Web Tools will attempt to obtain a valid <HSTariffNumber>
using the required <Description> and optional <ItemCategory>
and <ItemSubCategory> values provided if <HSTariffNumber> is not provided or is in an incorrect format. For example: <HSTariffNumber>4901.10.0000</HSTariffNumber> |
String |
whiteSpace=collapse maxLength=17 pattern=\d{0,12} |
||||
eVSPriorityMailIntlRequest / ShippingContents / ItemDetail
/ CountryOfOrigin |
Required
|
For
commercial items only. Country of Origin means the country where the goods
originated, e.g. were produced, manufactured, or assembled. It is
recommended you supply this information and attach an invoice to the outside
to accelerate customs clearance in processing the items. The
country name entered must match an entry from the USPS-approved International
Index of Countries and Localities or be "United States". (http://pe.usps.gov/text/Imm/Immctry.htm - click on the link for
"International Country Listings.") Using a country name not on the
list will result in a request failure. For
example: <CountryOfOrigin>United States</CountryOfOrigin> |
String |
|
||||
eVSPriorityMailIntlRequest / ShippingContents
/ ItemDetail / ItemCategory |
Optional |
Item
Category. Per international shipping regulatory mandates, shipments to
European Union (EU) countries are required to contain a valid Harmonization
Code and Content/Item description. To learn more about providing acceptable
item descriptions, view the chart in Appendix C or read the EU’s guidance on
acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods. |
String |
|
||||
eVSPriorityMailIntlRequest / ShippingContents
/ ItemDetail / ItemSubCategory |
Optional |
Item
Subcategory. Per international shipping regulatory mandates, shipments to
European Union (EU) countries are required to contain a valid Harmonization
Code and Content/Item description. To learn more about providing acceptable
item descriptions, view the chart in Appendix C or read the EU’s guidance on
acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods. |
String |
|
||||
eVSPriorityMailIntlRequest / Insured |
Optional
|
Restricted
use: authorized users may indicate with a value of Y that the item is insured
for purposes of obtaining a barcode number from the insured range. All other
users must specify N or omit. |
String |
default=N enumeration= ·
Y ·
N |
||||
eVSPriorityMailIntlRequest / InsuredNumber |
Optional
|
For backward-compatibility; not validated. |
String |
|
||||
eVSPriorityMailIntlRequest / InsuredAmount |
Optional
|
Use
this tag for entering an insurance amount, if known. For
example: <InsuredAmount>100.00</InsuredAmount> |
Decimal |
length=0
|
||||
eVSPriorityMailIntlRequest / Postage |
Optional
|
Use
this tag for entering a postage amount, if known. If the tag is present, but
the value is blank, the postage will be automatically calculated. For
example: <Postage></Postage> |
Decimal |
length=0
|
||||
eVSPriorityMailIntlRequest / GrossPounds |
Required
|
Gross
pounds and ounces together represent the total package weight, including
packing material. For example, a package weighing 3 lbs
8 ounces would have "3" entered here and "8" entered with
the <GrossOunces> tag. WebTools
will check for maximum shipping weight of 70 pounds. Allowable weight may
change based on the service used to send package and the destination country.
For
example: <GrossPounds>4</GrossPounds> |
Integer |
whiteSpace=collapse
|
||||
eVSPriorityMailIntlRequest / GrossOunces |
Required
|
Enter
the ounces component of the total package weight with this tag. For
example: <GrossOunces>0</GrossOunces> |
Integer |
whiteSpace=collapse
|
||||
eVSPriorityMailIntlRequest / ContentType |
Required
|
Specifies the content
of the package or envelope. For example: <ContentType>DOCUMENTS</ContentType> Note: Enumerations are case sensitive “NonnegotiableDocument” and
“Documents” both signify mailable non-negotiable
documents and are insured automatically
for up to $100. Additional Insurance
cannot be purchased. Any non-document
ContentType values are insured
automatically for up to $200. Additional
Insurance can be purchased for values $200 and greater. |
String |
enumerations= ·
MERCHANDISE ·
SAMPLE ·
GIFT ·
DOCUMENTS ·
RETURN ·
HUMANITARIAN ·
DANGEROUSGOODS ·
NonnegotiableDocument ·
PHARMACEUTICALS ·
MEDICALSUPPLIES ·
OTHER |
||||
eVSPriorityMailIntlRequest / ContentTypeOther |
Optional
|
Required
when <ContentType>OTHER<ContentType>.
Maximum length enforced via truncation |
String |
maxLength=15 whiteSpace=collapse
|
||||
eVSPriorityMailIntlRequest / Agreement |
Required
|
Requires
a value of Y to print <FromFirstName/> and
<FromLastName/> in Signature Box along with
Current Date (Central Time USA). Any other value returns an error. |
String |
enumeration= ·
Y ·
N |
||||
eVSPriorityMailIntlRequest / Comments |
Optional
|
Enter
any comments. For
example: <Comments></Comments> |
String |
maxLength=76
|
||||
eVSPriorityMailIntlRequest / LicenseNumber |
Optional
|
Enter
license number, if known or if included in package. For
example: <LicenseNumber>LIC-24356879</LicenseNumber> |
String |
maxLength=24
|
||||
eVSPriorityMailIntlRequest / CertificateNumber |
Optional
|
Enter
certificate number, if known or if included in package. For
example: <CertificateNumber>CERT-97865342</CertificateNumber> |
String |
maxLength=24
|
||||
eVSPriorityMailIntlRequest / InvoiceNumber |
Optional
|
Enter
invoice number, if known or if included in package. For
example: <InvoiceNumber>INV-040903</InvoiceNumber> |
String |
maxLength=24
|
||||
eVSPriorityMailIntlRequest / ImageType |
Required
|
For
example: <ImageType>PDF</ImageType> |
String |
enumeration= ·
PDF ·
TIF ·
NONE |
||||
eVSPriorityMailIntlRequest / ImageLayout |
Optional
|
Controls
how the multipage form is returned in the response tags.
"ONEPERFILE" returns one page per response tag while “ALLINONEFILE”
returns all pages in a single response tag. The
“TRIM” options conserve page space if possible by
combining two form parts on a single page. For
example: <ImageLayout>ONEPERFILE<ImageLayout> |
String |
default=ONEPERFILE enumerations= ·
ONEPERFILE ·
ALLINONEFILE ·
TRIMONEPERFILE ·
TRIMALLINONEFILE |
||||
eVSPriorityMailIntlRequest / CustomerRefNo |
Optional
|
Written
to Postal Manifest Detail record. For
example: <CustomerRefNo>Ref 369246</CustomerRefNo> |
String |
maxLength=30
|
||||
eVSPriorityMailIntlRequest / CustomerRefNo2 |
Optional
|
Written
to Postal Manifest Detail record. For
example: <CustomerRefNo2>ACT369246</CustomerRefNo2> |
String |
maxLength=30
|
||||
eVSPriorityMailIntlRequest / POZipCode |
Optional
|
ZIP of
Post Office where mailed if different from
<FromZip5/>. Written to Postal Manifest Detail record. Must be valid
ZIP Code. For
example: <POZipCode>00962</POZipCode> |
String |
whiteSpace=collapse length=5 pattern=\d{5} |
||||
eVSPriorityMailIntlRequest / LabelDate |
Optional
|
Date
the mail will enter the mail stream. No more than 3
days in the future. Default is day of request. For
example: <LabelDate>09/28/2010</LabelDate> |
String |
whiteSpace=collapse maxLength=10 pattern=\d{1,2}/\d{1,2}/\d\d(\d\d)?
|
||||
eVSPriorityMailIntlRequest / HoldForManifest |
Optional
|
Restricted
use. Holds manifest record for possible inclusion in SCAN request. |
String |
enumeration= ·
Y ·
N |
||||
eVSPriorityMailIntlRequest / EELPFC |
Optional |
Exemption and Exclusion Legend
or PFC Code. Use in conjunction with
Revision tag with value of 1 to indicate and trigger new functionality. Please
refer to the International Mail Manual for further information - http://pe.usps.gov/text/imm/immc5_007.htm. To
activate check boxes use ”30.37a” or “30.37h”. For
example: <EELPFC>30.37a</EELPFC> |
String |
whiteSpace=collapse minLength=0 |
||||
eVSPriorityMailIntlRequest / PriceOptions |
Optional |
Price
option for package. |
String |
default=commercial
base enumeration= ·
RETAIL ·
COMMERCIAL BASE ·
COMMERCIAL PLUS |
||||
eVSPriorityMailIntlRequest / Length |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
Decimal |
minExclusive=0.0 |
||||
eVSPriorityMailIntlRequest / Width |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error response will return. Example:
<Width>5</Width> <Length></Length> <Height>8</Height> 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
for non-rectangular packages. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
Decimal |
minExclusive=0.0 |
||||
eVSPriorityMailIntlRequest / Height |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing |
Decimal |
minExclusive=0.0 |
||||
eVSPriorityMailIntlRequest / Girth |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing |
Decimal |
minExclusive=0.0 |
||||
eVSPriorityMailIntlRequest / ExtraServices |
Optional |
Groups
extra services elements |
(Group) |
|
||||
eVSPriorityMailIntlRequest / ExtraServices / ExtraService |
Optional |
Parameters
used to specify desired ExtraService. Additional
occurrences for future. Note:
The <InsuredAmount> tag is used to indicate
insurance.
For
example: <ExtraService>105</ExtraService> |
String |
whiteSpace=collapse enumeration= ·
105 |
||||
eVSPriorityMailIntlRequest / ActionCode |
Optional |
Used to
specify the action code. Value is included in the Shipping Partner Event file
for customers who have chose to have a Shipping
Partner Event file submitted to USPS on their behalf. M0 – Mailer
Owner S0 – Service
Provider For example: <ActionCode>M0</ActionCode> |
String |
Default
= M0 enumeration= ·
M0 ·
S0 |
||||
eVSPriorityMailIntlRequest / OptOutOfSPE |
Optional |
Allows
a customer to opt out of SPE file creation. “false” WILL create a SPE file. |
Boolean |
Default
= True enumeration= ·
true ·
false |
||||
eVSPriorityMailIntRequest / PermitNumber |
Optional |
Number
associated with a mailing permit. The
permit is permission to use a certain postage payment method for bulk and
commercial mailings |
String |
minOccurs=0 |
||||
eVSPriorityMailIntRequest / AccountZipCode |
Optional |
ZIP of
Account Post Office where mailed if different from
<FromZip5/>. Written to Postal Manifest Detail record. Must be valid
ZIP Code. For
example: < AccountZipCode >00962</ AccountZipCode > |
String |
whiteSpace=collapse length=5 pattern=\d{5} |
||||
eVSPriorityMailIntRequest / ImportersReferenceType |
Conditionally
Required |
Tax code / VAT no. / Importer Code Note: Required when <ImportersReferenceNumber> is used. |
String |
minOccurs=0 Enumerations= ·
TAXCODE ·
VAT ·
IMPORTERCODE |
||||
eVSPriorityMailIntRequest / ImportersTelephoneNumber |
Optional |
For Importer: 10 digits (including area
code), with no punctuation. Use format: 2125551234. For example: <FromPhone>2125551234</FromPhone> |
String |
whiteSpace=collapse length=10 pattern=\d{10} |
||||
eVSPriorityMailIntRequest / ImportersFaxNumber |
Optional |
For
Importer: No format checking is done on international fax numbers. For
example: <ImportersFaxNumber>011 52 (322)
222-0074</ImportersFaxNumber> |
String |
maxLength=30 |
||||
eVSPriorityMailIntRequest / ImportersEmail |
Optional |
For
Importer: Complete valid e-mail address is Required if tag is used. For
example: <ImportersEmail>cpapple@email.com</ImportersEmail l> |
String |
maxLength=30 whiteSpace=collapse pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4} |
||||
eVSPriorityMailIntRequest / Machinable |
Optional |
Indicates
whether or not the item is machinable. A surcharge
is applied to a First-Class Mail International item if it has one or more
non-machinable characteristics. See International Mail Manual (IMM) Section 241 for more information. For
example: <Machinable>false</Machinable> |
Boolean |
default=true whiteSpace=collapse
|
||||
eVSPriorityMailIntRequest / DestinationRateIndicator |
Required |
Required for destination entry
packages. I = International Service Center (ISC) N =
None |
String |
enumerations= ·
I ·
N |
||||
eVSPriorityMailIntRequest / MID |
Optional |
Mailer
ID (MID), Represents Mail Owner MID. Located
in position #13 in the Detail 1 record of the Shipping Services File v2.0. For
example: <MID>847654321</ MID> |
String |
minOccurs=0 |
||||
eVSPriorityMailIntRequest / LogisticsManagerMID |
Optional |
The MID
of the company that manages the mailing. Located
in position #12 in the Detail 1 record of the Shipping Services File v2.0. Note:
If LogisticsManagerMID is populated, either CRID or
MID must also be populated. For
example: <LogisticsManagerMID>489001< / LogisticsManagerMID> |
String |
minOccurs=0 |
||||
eVSPriorityMailIntRequest / CRID |
Optional |
Customer
Registration ID, Represents Mail Owner CRID. Located
in position #20 in the Detail 1 record of the Shipping Services File v2.0. For
example: <CRID>544762</ CRID> |
String |
minOccurs=0 |
||||
eVSPriorityMailIntRequest / VendorCode |
Optional |
Code
from vendor software to identify the developer of the shipping system. Located
in position #15 in the Detail 1 record of the Shipping Services File v2.0. For
example: <VendorCode>1234<VendorCode> |
String |
minOccurs=0 Default=8300 |
||||
eVSPriorityMailIntRequest / VendorProductVersionNumber |
Optional |
Shipping
software’s product version number. Located
in position #16 in the Detail 1 record of the Shipping Services File v2.0. For
example: <VendorProductVersionNumber>5.02.1B</ VendorProductVersionNumber> |
String |
minOccurs=0 |
||||
eVSPriorityMailIntRequest / ePostageMailerReporting |
Optional |
Verifies Sender Information, sender fields
must match From information when <ePostageMailerReporting>=1 1 - (ePostage
sender information in SSF ) 2 - (ePostage sender information through DES) 3 - (ePostage
sender information using child MID) |
String |
enumerations= ·
1 ·
2 ·
3 |
||||
eVSPriorityMailIntRequest / SenderFirstName |
Optional |
First
Name of Sender. For
example: <SenderFirstName>Adam</SenderFirstName>
Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSPriorityMailIntRequest / SenderLastName |
Optional |
Last
Name of Sender. For
example: <SenderLastName>Smith</SenderLastName> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSPriorityMailIntRequest / SenderBusinessName |
Optional |
Values
for Sender Business Name must be sent. For
example: <SenderBusinessName>USPS</SenderBusinessName> |
String |
minLength=0 |
||||
eVSPriorityMailIntRequest / SenderAddress1 |
Optional |
Sender
address line. Use this tag for full address (Address1 and Address2) Must
match Address1 and Address2 or will produce an error. For
example: <SenderAddress1>STE 150 10 Elm Street </SenderAddress1> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSPriorityMailIntRequest / SenderCity |
Optional |
Sender
city. For example:
<SenderCity>BETHESDA</SenderCity>Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSPriorityMailIntRequest / SenderState |
Optional |
Sender
state. For
example: <SenderState>MD</ SenderState> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSPriorityMailIntRequest / SenderZip5 |
Optional |
Sender
ZIP code. For
example: <SenderZip5>20212</SenderZip5> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSPriorityMailIntRequest / SenderPhone |
Optional |
Sender
Phone #. 10 digits Required (including area code), with no punctuation.
For
example: <SenderPhone>2125551234</ SenderPhone> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 pattern=d(10) |
||||
eVSPriorityMailIntRequest / SenderEmail |
Optional |
E-mail
Address of Sender. Valid e-mail addresses must be used. For
example: <SenderEMail>cpapple@email.com</ SenderEMail> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4} |
||||
eVSPriorityMailIntRequest / ChargebackCode |
Optional |
Code
used with the federal Agency Number or code for the customer’s internal use. |
String |
123456
(alphanumeric) |
||||
eVSPriorityMailIntlRequest |
Optional |
|
(Alias) |
|
Request:eVSPriorityMailInt <eVSPriorityMailIntlCertifyRequest
USERID="XXXXXXXXX" PASSWORD="XXXXXXXXX"> <Option /> <Revision>2</Revision> <ImageParameters /> <FromFirstName>Garrison</FromFirstName> <FromMiddleInitial>A</FromMiddleInitial> <FromLastName>Johns</FromLastName> <FromFirm /> <FromAddress1>radlab</FromAddress1> <FromAddress2>6406 Ivy Lane</FromAddress2> <FromCity>Greenbelt</FromCity> <FromState>MD</FromState> <FromZip5>20770</FromZip5> <FromZip4>1234</FromZip4> <FromPhone>3019187658</FromPhone> <ToName></ToName> <ToFirstName>Reza</ToFirstName> <ToLastName>Dianat</ToLastName> <ToFirm>HP</ToFirm> <ToAddress1>HP</ToAddress1> <ToAddress2>5th floor</ToAddress2> <ToAddress3>6406 Ivy Lane</ToAddress3> <ToCity>Greenbelt</ToCity> <ToProvince>Md</ToProvince> <ToCountry>Switzerland</ToCountry> <ToPostalCode>20770</ToPostalCode> <ToPOBoxFlag>N</ToPOBoxFlag> <ToPhone>5555555555</ToPhone> <ToFax>3012929999</ToFax> <ToEmail>b@aol.com</ToEmail> <NonDeliveryOption>Return</NonDeliveryOption> <Container>SMFLATRATEBOX</Container> <ShippingContents> <ItemDetail> <Description>Description 1</Description> <Quantity>1</Quantity> <Value>1.11</Value> <NetPounds>1</NetPounds> <NetOunces>1</NetOunces> <HSTariffNumber>123456</HSTariffNumber> <CountryOfOrigin>Brazil</CountryOfOrigin> </ItemDetail> <ItemDetail> <Description>Description 2</Description> <Quantity>2</Quantity> <Value>2.22</Value> <NetPounds>2</NetPounds> <NetOunces>2</NetOunces> <HSTariffNumber>234567</HSTariffNumber> <CountryOfOrigin>Switzerland</CountryOfOrigin> </ItemDetail> </ShippingContents> <Insured>N</Insured> <InsuredNumber></InsuredNumber> <InsuredAmount></InsuredAmount> <GrossPounds>3</GrossPounds> <GrossOunces>5</GrossOunces> <ContentType>Documents</ContentType> <Agreement>Y</Agreement> <Comments>PriorityMailIntl
Comments</Comments> <ImageType>TIF</ImageType> <POZipCode>20770</POZipCode> <LabelDate></LabelDate> <HoldForManifest>N</HoldForManifest> <ExtraServices> <ExtraService></ExtraService> </ExtraServices> <DestinationRateIndicator>N</DestinationRateIndicator> </eVSPriorityMailIntlCertifyRequest> eVS
Priority Mail International w/ HS Tarriff Number & Tags <eVSPriorityMailIntlCertifyRequest USERID="XXXXXXXXX"
PASSWORD="XXXXXXXXX"> <Option /> <Revision>2</Revision> <ImageParameters> <ImageParameter>4BY6LABEL</ImageParameter> </ImageParameters> <FromFirstName>Garrison</FromFirstName> <FromMiddleInitial>A</FromMiddleInitial> <FromLastName>Johns</FromLastName> <FromFirm
/> <FromAddress1>radlab</FromAddress1> <FromAddress2>6406 Ivy
Lane</FromAddress2> <FromCity>Greenbelt</FromCity> <FromState>MD</FromState> <FromZip5>20770</FromZip5> <FromZip4>1234</FromZip4> <FromPhone>3019187658</FromPhone> <ToName></ToName> <ToFirstName>Reza</ToFirstName> <ToLastName>Dianat</ToLastName> <ToFirm>HP</ToFirm> <ToAddress1>HP</ToAddress1> <ToAddress2>5th
floor</ToAddress2> <ToAddress3>6406 Ivy
Lane</ToAddress3> <ToCity>Greenbelt</ToCity> <ToProvince>Md</ToProvince> <ToCountry>Switzerland</ToCountry> <ToPostalCode>20770</ToPostalCode> <ToPOBoxFlag>N</ToPOBoxFlag> <ToPhone>5555555555</ToPhone> <ToFax>3012929999</ToFax> <ToEmail>b@aol.com</ToEmail> <NonDeliveryOption>Return</NonDeliveryOption>
<Container>MDFLATRATEBOX</Container> <ShippingContents> <ItemDetail> <Description>Policy guidelines
document</Description> <Quantity>1</Quantity> <Value>55.00</Value> <NetPounds>1</NetPounds> <NetOunces>5</NetOunces> <HSTariffNumber>4901.10.0000</HSTariffNumber> <CountryOfOrigin>United
States</CountryOfOrigin> <ItemCategory>turbo</ItemCategory> <ItemSubCategory>charger</ItemSubCategory> </ItemDetail> </ShippingContents> <Insured>N</Insured> <InsuredNumber></InsuredNumber> <InsuredAmount></InsuredAmount> <GrossPounds>3</GrossPounds> <GrossOunces>5</GrossOunces> <ContentType>Documents</ContentType> <Agreement>Y</Agreement> <Comments>PriorityMailIntl
Comments</Comments> <ImageType>TIF</ImageType> <ImageLayout></ImageLayout> <POZipCode>20770</POZipCode> <LabelDate></LabelDate> <HoldForManifest>N</HoldForManifest> <ExtraServices> <ExtraService></ExtraService> </ExtraServices> <DestinationRateIndicator>N</DestinationRateIndicator> </eVSPriorityMailIntlCertifyRequest> |
Tag Name |
Occurs |
Description |
Type |
Validation |
eVSPriorityMailIntlResponse |
Required
|
|
(Alias)
|
|
eVSPriorityMailIntlResponse / Postage |
Required
|
Postage
amount |
Decimal |
|
eVSPriorityMailIntlResponse / TotalValue |
Required
|
Value
of all items being shipped |
Decimal |
|
eVSPriorityMailIntlResponse / SDRValue |
Required
|
Special
Drawing Right calculated on Insured Amount |
Decimal |
|
eVSPriorityMailIntlResponse / BarcodeNumber |
Required
|
Mail service related barcode. |
String |
|
eVSPriorityMailIntlResponse / LabelImage |
Required
|
Encoded
images of label (may be empty depending upon layout option selected) |
base64Binary |
|
eVSPriorityMailIntlResponse / Page2Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected)
|
base64Binary |
|
eVSPriorityMailIntlResponse / Page3Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected)
|
base64Binary |
|
eVSPriorityMailIntlResponse / Page4Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected)
|
base64Binary |
|
eVSPriorityMailIntlResponse / Page5Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected)
|
base64Binary |
|
eVSPriorityMailIntlResponse / Page6Image |
Required
|
Encoded
images of label (may be empty depending upon layout option selected)
|
base64Binary |
|
eVSPriorityMailIntlResponse / Prohibitions |
Required
|
List of
items prohibited from mailing based on country of destination |
String |
|
eVSPriorityMailIntlResponse / Restrictions |
Required
|
Restrictions
on items being shipped based on country of destination |
String |
|
eVSPriorityMailIntlResponse / Observations |
Required
|
Additional
mailing information based on country of destination |
String |
|
eVSPriorityMailIntlResponse / Regulations |
Required
|
Additional
regulations for shipping to destination country |
String |
|
eVSPriorityMailIntlResponse / AdditionalRestrictions |
Optional
|
Additional
restrictions on items being shipped to destination country. This
tag is available when the request Revision tag >= 2. If Revsion tag < 2, the additional restrictions are
appended to the Restrictions tag. |
String |
minOccurs=0 |
eVSPriorityMailIntlResponse / DestinationBarcodeNumber |
Optional |
|
String |
minOccurs=0 |
eVSPriorityMailIntlResponse / ParcelIndemnityCoverage |
Required
|
Indemnity
value |
Decimal |
|
eVSPriorityMailIntlResponse / InsuranceFee |
Optional |
Fee for
insurance |
Decimal |
minExclusive=0.0 |
eVSPriorityMailIntlResponse / ExtraServices |
Optional
|
Grouping
of extra services |
(Group) |
minOccurs=0 |
eVSPriorityMailIntlResponse / ExtraServices / ExtraService |
Optional,
repeating up to unbounded times |
Groups
extra service information |
(Group) |
|
eVSPriorityMailIntlResponse / ExtraServices / ExtraService
/ ServiceID |
Required
|
Extra
Service ID echoed from request |
String |
|
eVSPriorityMailIntlResponse / ExtraServices / ExtraService
/ ServiceName |
Required
|
Extra
Service name |
String |
|
eVSPriorityMailIntlResponse / ExtraServices / ExtraService
/ Price |
Required
|
Extra
Service fee |
Decimal |
|
eVSPriorityMailIntlResponse / RemainingBarcodes |
Required |
This
contains the number of remaining barcodes that can be generated for this particular request. |
String |
|
eVSPriorityMailIntlResponse / Warning |
Optional |
|
String |
|
eVSPriorityMailIntlResponse |
Required |
|
(Alias)
|
|
<eVSPriorityMailIntlResponse> <Postage>23.50</Postage> <TotalValue>3.33</TotalValue> <SDRValue></SDRValue> <BarcodeNumber>LZ333007781US</BarcodeNumber> <LabelImage>.......suppressed........</LabelImage> <Page2Image></Page2Image> <Page3Image></Page3Image> <Page4Image></Page4Image> <Page5Image></Page5Image> <Page6Image></Page6Image> <Prohibitions> Arms and weapons. Firing caps and loaded metal
cartridges for portable firearms, nonexplosive parts of artillery fuses,
flammable films, or articles made of celluloid. Human remains. Live plants and animals. Lottery tickets and
advertisements for lotteries. Mini-spies (miniature wireless transmitters). Radar detectors. </Prohibitions> <Restrictions>No list furnished.</Restrictions> <Observations> 1. A parcel may be addressed
to a street address or to a post office box. A local telephone number for the
addressee should be provided when the item is addressed to a street address
and must be provided when the item is addressed to a post office box. 2. For parcels, an invoice, in
duplicate, is Required for all commercial shipments regardless of value and
all personal shipments valued at $300 or more. The invoices must be affixed
to the outside of the parcel or may be enclosed in PS Form 2976-E with the
customs declaration. 3. A letter or card fully
prepaid and bearing the same address as that of a Priority Mail International
parcel may be tied to or otherwise securely attached to the outside of the
parcel in such manner as to prevent its separation therefrom and not to interfere
with the address of the parcel. Stamps to cover postage on the parcel must be
affixed to the wrapper of the parcel. Stamps to pay postage on the letter
must be affixed to the envelope thereof, or in the case of a postcard, to the
address side of the card, preferably the upper-right portion. Priority Mail
International parcels to which such letters or cards are attached are treated
as parcel post. </Observations> <Regulations> Country Code: CH Reciprocal Service Name: There
is no reciprocal service. Required Customs
Form/Endorsement 1. Business correspondence and
commercial papers/documents. No form Required. Endorse item
clearly next to mailing label as BUSINESS PAPERS. 2. Merchandise samples without
commercial value. PS Form 2976, Customs - CN 22
and Sender's Declaration. 3. Merchandise and all
articles subject to customs duty. PS Form 2976-A, Customs
Declaration and Dispatch Note CP 72, inside a PS Form 2976-E, Customs
Declaration Envelope CP 91. An invoice, in duplicate, is Required for all
commercial shipments regardless of value and all personal shipments valued at
$300 or more. The invoices must be either affixed to the outside of the
parcel or enclosed in PS Form 2976-E with the customs declaration. Notes: 1. An invoice, in duplicate,
is Required for all commercial shipments regardless of value and for all
personal shipments valued at $300 or more. The invoices must be either
affixed to the outside of the parcel or enclosed in PS Form 2976-E with the
customs declaration. 2. Arms, weapons, and human
remains are prohibited. 3. Coins; banknotes; currency
notes, including paper money; securities of any kind payable to bearer;
traveler's checks; platinum, gold, and silver; precious stones; jewelry;
watches; and other valuable articles are prohibited in Priority Mail Express
International shipments to Switzerland. 4. An
Priority Mail Express International shipment may be addressed to a street
address or to a post office box. A local telephone number for the addressee
should be provided when the item is addressed to a street address and must be
provided when the item is addressed to a post office box. Areas Served: All points in Switzerland and
Liechtenstein. </Regulations> <AdditionalRestrictions>No
Additional Restrictions Data found.</AdditionalRestrictions> <ParcelIndemnityCoverage>0.00</ParcelIndemnityCoverage> <ExtraServices> <ExtraService> <ServiceID>9</ServiceID> <ServiceName>Electronic
USPS Delivery Confirmation International</ServiceName> <Price>0.00</Price> </ExtraService> </ExtraServices> <RemainingBarcodes>29<
RemainingBarcodes> </eVSPriorityMailIntlResponse> |
The First Class Mail International Label API lets customers
generate First Class International labels given the weight and dimensions of
the item.
Note: The “eVSFirstClassMailIntlCertify”
API signature is for testing purposes and will not generate usable labels and
barcodes.
Scheme |
Host |
Path |
API |
XML |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSFirstClassMailIntl |
&XML=(see
Tag Descriptions below) |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSFirstClassMailIntlCertify |
&XML=(see
Tag Descriptions below) |
Tag Name |
Occurs |
Description |
Type |
Validation |
||||
eVSFirstClassMailIntlRequest |
Required
|
|
(Alias)
|
|
||||
eVSFirstClassMailIntlRequest / USERID |
Required |
This attribute specifies your Web Tools user ID. See the Developer's Guide for information on obtaining your USERID. For Example: USERID="XXXXXXX" |
NMTOKEN |
|||||
eVSFirstClassMailIntlRequest / PASSWORD |
Required |
This attribute specifies your Web Tools password. See the Developer's Guide for information on your Password. For Example: PASSWORD="XXXXXXX" |
NMTOKEN |
|
||||
eVSFirstClassMailIntlRequest / Option |
Optional
|
For
future use. |
Empty |
|
||||
eVSFirstClassMailIntlRequest / Revision |
Required |
Use of
value 2 Required as of January 2011. For
example: <Revision>2</Revision> |
String |
|
||||
eVSFirstClassMailIntlRequest / ImageParameters |
Optional
|
Groups
alternate image options. |
(Group) |
minoccurs=0 |
||||
eVSFirstClassMailIntlRequest / ImageParameters / ImageParameter |
Optional,
repeating up to 3 times |
Returns alternate label image. Only alternate 4’’x6’’ size label image may
be requested at this time. ·
4X6LABEL (4X6 on a full
page 8.5/11” background) ·
4X6LABELL (Landscape –
true size 4X6; image rotated, not on an 8.5 x 11 background page) ·
4X6LABELP (Portrait –
true size 4X6, not on an 8.5 x 11 background page) ·
4X6ZPL203DPI (ZPL - Zebra
Programming Language) format
·
For example: <ImageParameter>4X6LABEL</ImageParameter> |
String |
Enumerations= ·
4X6LABEL ·
4X6LABELL ·
4X6LABELP ·
4X6ZPL203DPI ·
4X6ZPL300DPI |
||||
eVSFirstClassMailIntlRequest / FromFirstName |
Required |
Both FromFirstName and FromLastName
are Required if FromFirmName is left blank. Maximum
Length: 32 characters total for First, Middle, and Last Names with space
after first and middle name. For
example: <FromFirstName>John</FromFirstName> |
String |
maxLength=30 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / FromMiddleInitial |
Optional
|
Middle
Initial. Maximum Length: 32 characters total for First, Middle, and Last
Names with space after first and middle name. For
example: <FromMiddleInitial>L</FromMiddleInitial> |
String |
maxLength=1 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / FromLastName |
Required |
Both FromFirstName and FromLastName
are Required if FromFirmName is left blank. Maximum Length: 32 characters total for
First, Middle, and Last Names with space after first and middle name. For
example: <FromLastName>Doe</FromLastName> |
String |
maxLength=30 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / FromFirm |
Required |
FromFirm is Required
if FromFirstName and FromLastName
are left blank. For
example: <FromFirm>XYZ</FromFirm> |
String |
maxLength=32 |
||||
eVSFirstClassMailIntlRequest / FromAddress1 |
Optional
|
Use
this tag for a suite or apartment number only. For
example: <FromAddress1>Suite 100</FromAddress1> |
String |
maxLength=32 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / FromAddress2 |
Required
|
Use
this tag for the primary address line. For
example: <FromAddress2>10 Elm Street</FromAddress2> |
String |
maxLength=32 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / FromUrbanization |
Optional
|
Use
this tag for Puerto Rico only. ZIP Code prefixes 006 to 009, if area is so
designated. For
example:<FromUrbanization>URB Caparra
Ter</FromUrbanization> |
String |
maxLength=32 |
||||
eVSFirstClassMailIntlRequest / FromCity |
Required
|
Use
this tag to specify originating city. For
example: <FromCity>Anytown</FromCity> |
String |
maxLength=16 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / FromState |
Required
|
Use
2-letter USPS abbreviation. For
example: <FromState>AK</FromState> |
String |
length=2 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / FromZip5 |
Required
|
Five-digit
valid ZIP code Required. For
example: <FromZip5>01234</FromZip5> |
String |
whiteSpace=collapse length=5 pattern=\d{5} |
||||
eVSFirstClassMailIntlRequest / FromZip4 |
Optional
|
If
value is entered, four digits are Required. Must be a valid ZIP+4 extension. For
example: <FromZip4>5678</FromZip4> |
String |
whiteSpace=collapse length=4 pattern=\d{4} |
||||
eVSFirstClassMailIntlRequest / FromPhone |
Required
|
10
digits Required (including area code), with no punctuation. Use format: 2125551234 For
example: <FromPhone>5555555555</FromPhone> |
String |
whiteSpace=collapse length=10 pattern=\d{10} |
||||
eVSFirstClassMailIntlRequest / ToName |
Optional |
Deprecated. See “ToFirstName”
and “ToLastName” tags. |
String |
maxLength=36 |
||||
eVSFirstClassMailIntlRequest / ToFirstName |
Required |
Both ToFirstName and ToLastName are Required
if ToFirm is left blank. For
example: <ToFirstName>John</ToFirstName> |
String |
maxLength=30 |
||||
eVSFirstClassMailIntlRequest / ToLastName |
Required |
Both ToFirstName and ToLastName are Required
if ToFirm is left blank. For
example: <ToLastName>Doe</ToLastName> |
String |
maxLength=30 |
||||
eVSFirstClassMailIntlRequest / ToFirm |
Required |
ToFirm is Required
if ToFirstName and ToLastName
are left blank. For
example: <ToFirm></ToFirm> |
String |
maxLength=36 |
||||
eVSFirstClassMailIntlRequest / ToAddress1 |
Optional |
Three
address lines are provided, but only one is Required. Use as many as needed
for complete address. For
example: <ToAddress1>Apartado
3068</ToAddress1> |
String |
maxLength=36 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToAddress2 |
Required |
Three
address lines are provided, but only one is Required. Use as many as needed
for complete address. For
example: <ToAddress2></ToAddress2> |
String |
maxLength=36 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToAddress3 |
Optional
|
Three
address lines are provided, but only one is Required. Use as many as needed
for complete address. For
example: <ToAddress3/> |
String |
maxLength=36 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToCity |
Required
|
Recipient's
city. For
example: <ToCity>PUERTO VALLARTA</ToCity> |
String |
maxLength=18 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToProvince |
Optional
|
Enter
the province for the recipient. For
example: <ToProvince>JALISCO</ToProvince> |
String |
maxLength=9 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToCountry |
Required
|
The
country name entered must match an entry from the USPS-approved International
Index of Countries and Localities or be "United States". (http://pe.usps.gov/text/Imm/Immctry.htm - click on the link for
"International Country Listings.") Using a country name not on the
list will result in a request failure. For
example: <ToCountry>MEXICO</ToCountry> |
String |
minLength=1 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToPostalCode |
Required
|
Enter
the postal code for the recipient. For
example: <ToPostalCode>46807</ToPostalCode> |
String |
maxLength=9 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToPOBoxFlag |
Required
|
Indicates
whether or not the To Address is a Post Office Box. For
example: <ToPOBoxFlag>N</ToPOBoxFlag> |
String |
whiteSpace=collapse enumeration= ·
Y ·
N |
||||
eVSFirstClassMailIntlRequest / ToPhone |
Optional
|
No
format checking is done on international phone numbers. Required when FirstClassMailIntlRequest[ToPOBoxFlag='Y']. For
example: <ToPhone>011 52 (322) 222-0069</ToPhone> |
String |
maxLength=30 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToFax |
Optional
|
No
format checking is done on international fax numbers. For
example: <ToFax>011 52 (322) 222-0074</ToFax> |
String |
maxLength=30 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ToEmail |
Optional
|
One
single, complete, and valid e-mail address is Required if tag is used. For
example: <ToEmail>cpapple@email.com</ToEmail> |
String |
maxLength=30 whiteSpace=collapse pattern=([\w\-\.]+)@(([\w-]+\.))+[a-zA-Z]{2,4} |
||||
eVSFirstClassMailIntlRequest / FirstClassMailType |
Optional
|
Used to
determine the postage rate. See also FirstClassMailIntlRequest/Machinable.
For
example: <FirstClassMailType>LETTER</FirstClassMailType> |
String |
default=
PACKAGE SERVICE whiteSpace=collapse enumeration= ·
PACKAGE SERVICE |
||||
eVSFirstClassMailIntlRequest / ShippingContents |
Required
|
|
(Group)
|
|
||||
eVSFirstClassMailIntlRequest / ShippingContents / ItemDetail |
Required
repeating up to 5 times |
|
(Group)
|
|
||||
eVSFirstClassMailIntlRequest / ShippingContents / ItemDetail
/ Description |
Required
|
Description of the item. Per international
shipping regulatory mandates, shipments to European Union (EU) countries are
required to contain a valid Harmonization Code and Content/Item description.
To learn more about providing acceptable item descriptions, view the chart in
Appendix C or read the EU’s guidance on acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods For
certain countries/destinations (i.e., when the Web Tools Price Calculator
APIs return <HSCodeEnforced>=“true”) the API enforces a blacklist of descriptions not permitted:
none, not applicable, n/a, null, gift, merchandise Other
non-descriptive wording always results in an error: gift, sample, other For
example: <Description>Policy guidelines document</Description> |
String |
maxLength=30 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ShippingContents / ItemDetail
/ Quantity |
Required
|
Quantity
of the item. Integer value Required. For
example: <Quantity>1</Quantity> |
Integer |
whiteSpace=collapse minExclusive=0 |
||||
eVSFirstClassMailIntlRequest / ShippingContents / ItemDetail
/ Value |
Required
|
The
data entered with this tag provides the value of the set of items. If the
item is 2 boxes of 50 pens and the value of each box is $10.00,
"20.00" (2 boxes x $10.00) should be entered. If the value of each
pen is .25 then "25.00" (100 pens x .25) should be entered. For
example: <Value>55.00</Value> |
Decimal |
whiteSpace=collapse minExclusive=0 |
||||
eVSFirstClassMailIntlRequest / ShippingContents / ItemDetail
/ NetPounds |
Required
|
Provide
the pounds component of the weight of the individual item listed within this ItemDetail. For
example: <NetPounds>1</NetPounds> |
Integer |
default=0 whiteSpace=collapse minInclusive=0
|
||||
eVSFirstClassMailIntlRequest / ShippingContents / ItemDetail
/ NetOunces |
Required
|
Provide
the ounces component of the weight of the individual item listed within this ItemDetail. For
example: <NetOunces>5</NetOunces> |
Decimal |
default=0.0 whiteSpace=collapse minInclusive=0
|
||||
eVSFirstClassMailIntlRequest / ShippingContents / ItemDetail
/ HSTariffNumber |
Required
|
For commercial items only. HS Tariff Numbers must be based on the Harmonized Commodity Description and Coding System 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
certain countries/destinations (i.e., when the Web Tools Price Calculator APIs
return <HSCodeEnforced>=“true”)
the API requires a valid <HSTariffNumber>. Web Tools will not validate <HSTariffNumber> if provided in the correct format, but
Web Tools will attempt to obtain a valid <HSTariffNumber>
using the required <Description> and optional <ItemCategory>
and <ItemSubCategory> values provided if <HSTariffNumber> is not provided or is in an incorrect format. For example: <HSTariffNumber>4901.10.0000</HSTariffNumber> |
String |
whiteSpace=collapse maxLength=17 pattern=\d{12} |
||||
eVSFirstClassMailIntlRequest / ShippingContents / ItemDetail
/ CountryOfOrigin |
Required
|
For
commercial items only. Country of Origin means the country where the goods
originated, e.g. were produced, manufactured, or assembled. It is recommended
you supply this information and attach an invoice to the outside to
accelerate customs clearance in processing the items. The
country name entered must match an entry from the USPS-approved International
Index of Countries and Localities or be "United States". (http://pe.usps.gov/text/Imm/Immctry.htm - click on the link for
"International Country Listings.") Using a country name not on the
list will result in a request failure.
For
example: <CountryOfOrigin>United States</CountryOfOrigin> |
String |
whiteSpace=collapse minLength=0
|
||||
eVSFirstClassMailIntlRequest / ShippingContents
/ ItemDetail / ItemCategory |
Optional |
Item
Category. Per international shipping regulatory mandates, shipments to
European Union (EU) countries are required to contain a valid Harmonization
Code and Content/Item description. To learn more about providing acceptable
item descriptions, view the chart in Appendix C or read the EU’s guidance on
acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods. |
String |
minLength=0 maxLength=100 |
||||
eVSFirstClassMailIntlRequest / ShippingContents
/ ItemDetail / ItemSubCategory |
Optional |
Item
Subcategory. Per international shipping regulatory mandates, shipments to
European Union (EU) countries are required to contain a valid Harmonization
Code and Content/Item description. To learn more about providing acceptable
item descriptions, view the chart in Appendix C or read the EU’s guidance on
acceptable terms at Guidance on Acceptable and Unacceptable
Terms for the Description of Goods. |
String |
minLength=0 maxLength=100 |
||||
eVSFirstClassMailIntlRequest / Postage |
Optional
|
Use
this tag for entering a postage amount, if known. If the tag is present, but
the value is blank, the postage will be automatically calculated. For
example: <Postage></Postage> |
String |
length=0 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / GrossPounds |
Required
|
Gross
pounds and ounces together represent the total package weight, including
packing material. For example, a package weighing 3 lbs
8 ounces would have "3" entered here and "8" entered with
the "GrossOunces" tag. The Web Tool will
check for maximum shipping weight of 70 pounds. Allowable weight may change
based on the service used to send package and the destination country. For
example: <GrossPounds>4</GrossPounds> |
Integer |
whiteSpace=collapse minInclusive=0
|
||||
eVSFirstClassMailIntlRequest / GrossOunces |
Required
|
Enter
the ounces component of the total package weight with this tag. For
example: <GrossOunces>0</GrossOunces> |
Integer |
whiteSpace=collapse minInclusive=0
|
||||
eVSFirstClassMailIntlRequest / Machinable |
Optional
|
Indicates
whether or not the item is machinable. A surcharge
is applied to a First-Class Mail International item if it has one or more
non-machinable characteristics. See International Mail Manual (IMM) Section 241 for more information. For
example: <Machinable>false</Machinable> |
Boolean |
default=true
whiteSpace=collapse enumeration= ·
false ·
true |
||||
eVSFirstClassMailIntlRequest / ContentType |
Required
|
Specifies
the content of the package or envelope. For example: <ContentType>DOCUMENTS</ContentType> |
String |
whiteSpace=collapse enumeration= ·
MERCHANDISE ·
SAMPLE ·
GIFT ·
DOCUMENTS ·
HUMANITARIAN ·
DANGEROUSGOODS ·
OTHER |
||||
eVSFirstClassMailIntlRequest / ContentTypeOther |
Optional
|
Required
when FirstClassMailIntlRequest[ContentType='OTHER']. |
String |
maxLength=15 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / Agreement |
Required
|
Indicates
the requestor's agreement to terms and conditions of mailing. Requires a
value of Y to print and in Signature Box along with Current Date (Central
Time USA). Any other value returns an error. |
String |
whiteSpace=collapse enumeration= ·
Y |
||||
eVSFirstClassMailIntlRequest / Comments |
Optional
|
For
future use. |
String |
maxLength=76 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / LicenseNumber |
Optional
|
For
future use. |
String |
maxLength=24 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / CertificateNumber |
Optional
|
For
future use. |
String |
maxLength=24 whiteSpace=collapse |
||||
eVSFirstClassMailIntlRequest / InvoiceNumber |
Optional
|
For
future use. |
String |
maxLength=24 whiteSpace=collapse
|
||||
eVSFirstClassMailIntlRequest / ImageType |
Required
|
For
example: <ImageType>PDF</ImageType> |
String |
whiteSpace=collapse enumeration= ·
PDF ·
TIF ·
NONE |
||||
eVSFirstClassMailIntlRequest / ImageLayout |
Optional
|
Specified
whether the pages are to be returned one per file or all in one file. The
current FCMI label is one page so this tag has no
effect. For
example: <ImageLayout>ONEPERFILE</ImageLayout> |
String |
default=ONEPERFILE whiteSpace=collapse enumeration= ·
ONEPERFILE ·
ALLINONEFILE |
||||
eVSFirstClassMailIntlRequest / CustomerRefNo |
Optional
|
Written
to Postal Manifest Detail record. For
example: <CustomerRefNo>Ref 369246</CustomerRefNo> |
String |
maxLength=30 |
||||
eVSFirstClassMailIntlRequest / CustomerRefNo2 |
Optional
|
Written
to Postal Manifest Detail record For
example: <CustomerRefNo2>ACT 369246</ CustomerRefNo2> |
String |
maxLength=30 |
||||
eVSFirstClassMailIntlRequest / LabelDate |
Optional
|
Date
the mail will enter the mail stream. No more than
three days in the future. Default is day of request. For
example: <LabelDate>09/28/2010</LabelDate> |
String |
whiteSpace=collapse maxLength=10 pattern=\d{1,2}/\d{1,2}/\d\d(\d\d)?
|
||||
eVSFirstClassMailIntlRequest / HoldForManifest |
Optional
|
Restricted
use. Holds manifest record for possible inclusion in SCAN request. |
String |
enumeration= ·
Y ·
N |
||||
eVSFirstClassMailIntlRequest / EELPFC |
Optional
|
Exemption
and Exclusion Legend or PFC Code.
Currently Optional, in the future it may be Required for use. Please
refer to the International Mail Manual for further information - http://pe.usps.gov/text/imm/immc5_007.htm. To
activate check boxes use ”30.37a” or “30.37h”. For
example: <EELPFC>30.37a</EELPFC> |
String |
whiteSpace=collapse minLength=0 |
||||
eVSFirstClassMailIntlRequest / Container |
Optional
|
This
tag has been deprecated |
String |
|||||
eVSFirstClassMailIntlRequest / Length |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
Decimal |
minExclusive=0.0 totalDigits=10
|
||||
eVSFirstClassMailIntlRequest / Width |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error response will return. Example:
<Width>5</Width> <Length></Length> <Height>8</Height> 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
for non-rectangular packages. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
Decimal |
minExclusive=0.0 totalDigits=10
|
||||
eVSFirstClassMailIntlRequest / Height |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing |
Decimal |
minExclusive=0.0 totalDigits=10
|
||||
eVSFirstClassMailIntlRequest / Girth |
Optional |
Value
must be numeric. Units are inches. If
partial dimensions are provided, an error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing |
Decimal |
minExclusive=0.0 totalDigits=10
|
||||
eVSFirstClassMailIntlRequest / ExtraServices |
Optional |
Groups
extra services elements |
(Group) |
|
||||
eVSFirstClassMailIntlRequest / ExtraServices / ExtraService |
Optional,
repeating up to 3 times |
Use to
specify extra services. Currently,
available extra service is electronic USPS Delivery Confirmation
International.
For
example: <ExtraService>109</ExtraService> |
String |
enumeration= ·
109 |
||||
eVSFirstClassMailIntlRequest / PriceOptions |
Optional |
Indicates
if retail, commercial base or commercial plus pricing should be returned. For
example: <PriceOptions>COMMERCIAL BASE</PriceOptions> |
String |
default=RETAIL enumeration= ·
COMMERCIAL BASE ·
COMMERCIAL PLUS |
||||
eVSFirstClassMailIntlRequest / ActionCode |
Optional |
Passed
to SPE file via the shipment manifest. |
String |
Default = M0 enumeration= ·
M0 ·
S0 |
||||
eVSFirstClassMailIntlRequest / OptOutOfSPE |
Optional |
Allows
a customer to opt out of SPE file creation. “false” WILL create a SPE file. |
boolean |
Default = True enumeration= ·
true ·
false |
||||
eVSFirstClassMailIntRequest / PermitNumber |
Optional |
Number
associated with a mailing permit. The
permit is permission to use a certain postage payment method for bulk and
commercial mailings |
String |
minOccurs=0 |
||||
eVSFirstClassMailIntRequest / AccountZipCode |
Optional |
ZIP of
Account Post Office where mailed if different from
<FromZip5/>. Written to Postal Manifest Detail record. Must be valid
ZIP Code. For
example: <POZipCode>00962</POZipCode> |
String |
whiteSpace=collapse length=5 pattern=\d{5} |
||||
eVSFirstClassMailIntRequest / DestinationRateIndicator |
Required |
Required for destination entry
packages I = International Service Center (ISC) N = None |
String |
enumerations= ·
I ·
N |
||||
eVSFirstClassMailIntRequest / MID |
Optional |
Mailer
ID (MID), Represents Mail Owner MID. Located
in position #13 in the Detail 1 record of the Shipping Services File v2.0. For
example: <MID>847654321</ MID> |
String |
minOccurs=0 |
||||
eVSFirstClassMailIntRequest / LogisticsManagerMID |
Optional |
The MID
of the company that manages the mailing. Located
in position #12 in the Detail 1 record of the Shipping Services File v2.0. Note:
If LogisticsManagerMID is populated, either CRID or
MID must also be populated. For
example: <LogisticsManagerMID>489001< / LogisticsManagerMID> |
String |
minOccurs=0 |
||||
eVSFirstClassMailIntRequest / CRID |
Optional |
Customer
Registration ID, Represents Mail Owner CRID. Located
in position #20 in the Detail 1 record of the Shipping Services File v2.0. For
example: <CRID>544762</ CRID> |
String |
minOccurs=0 |
||||
eVSFirstClassMailIntRequest / VendorCode |
Optional |
Code
from vendor software to identify the developer of the shipping system. Located
in position #15 in the Detail 1 record of the Shipping Services File v2.0. For
example: <VendorCode>1234<VendorCode> |
String |
minOccurs=0 default=8300 |
||||
eVSFirstClassMailIntRequest / VendorProductVersionNumber |
Optional |
Shipping
software’s product version number. Located
in position #16 in the Detail 1 record of the Shipping Services File v2.0. For
example: <VendorProductVersionNumber>5.02.1B</ VendorProductVersionNumber> |
String |
minOccurs=0 |
||||
eVSFirstClassMailIntRequest / ePostageMailerReporting |
Optional |
Verifies Sender Information, sender fields
must match From information when <ePostageMailerReporting>=1 1 - (ePostage
sender information in SSF ) 2 - (ePostage sender information through DES) 3 - (ePostage
sender information using child MID) |
String |
enumerations= ·
1 ·
2 ·
3 |
||||
eVSFirstClassMailIntRequest / SenderFirstName |
Optional |
First
Name of Sender. For
example: <SenderFirstName>Adam </ SenderFirstName> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSFirstClassMailIntRequest / SenderLastName |
Optional |
Last
Name of Sender. For
example: <SenderLastName>Smith </ SenderLastName> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSFirstClassMailIntRequest / SenderBusinessName |
Optional |
Values
for Sender Business Name must be sent. For
example: <SenderBusinessName>USPS</ SenderBusinessName> |
String |
minLength=0 |
||||
eVSFirstClassMailIntRequest / SenderAddress1 |
Optional |
Sender
address line. Use this tag for full address (Address1 and Address2) Must
match Address1 and Address2 or will produce an error. For
example: <SenderAddress1>STE 150 10 Elm Street </SenderAddress1> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSFirstClassMailIntRequest / SenderCity |
Optional |
Sender
city For
example: <SenderCity>BETHESDA</ SenderCity> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSFirstClassMailIntRequest / SenderState |
Optional |
Sender
state. For
example: <SenderState>MD</ SenderState> Required when <ePostageMailerReporting>=1 |
String |
minLength=0 |
||||
eVSFirstClassMailIntRequest / SenderZip5 |
Optional |
Sender
ZIP code. For example:
<SenderZip5>20212</SenderZip5> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 pattern=d(5) |
||||
eVSFirstClassMailIntRequest / SenderPhone |
Optional |
Sender
Phone #. 10 digits Required (including area code), with no punctuation.
For
example: <SenderPhone>2125551234</ SenderPhone> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 pattern=d(10) |
||||
eVSFirstClassMailIntRequest / SenderEmail |
Optional |
E-mail
Address of Sender. Valid e-mail addresses must be used. For example:
<SenderEMail>cpapple@email.com</ SenderEMail> Required
when <ePostageMailerReporting>=1 |
String |
minLength=0 pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4} |
||||
eVSFirstClassMailIntRequest / RemainingBarcodes |
Required |
This
contains the number of remaining barcodes that can be generated for this particular request. |
String |
|
||||
eVSFirstClassMailIntRequest / ChargebackCode |
Optional |
Code
used with the federal Agency Number or code for the customer’s internal use. |
String |
123456
(alphanumeric) |
||||
eVSFirstClassMailIntlRequest / ImportersReferenceType |
Conditionally
Required |
Tax code / VAT no. / Importer Code Enter a
value for Importers Reference Type to pass IOSS data in the SSF for
export compliance. Note: Required when <ImportersReferenceNumber>
is used. |
String |
minOccurs=0 enumeration= ·
TAXCODE ·
VAT ·
IMPORTERCODE |
||||
eVSFirstClassMailIntlRequest / ImportersReferenceNumber |
Optional |
Enter a
value for Importers Reference to pass IOSS data in the SSF for export
compliance. The text entered is any
reference number that the recipient wishes to use. Note: Requires <ImportersReferenceType>
to be specified if used. For
example: <ImportersReferenceNumber>Order
23432</ImportersReferenceNumber> |
String |
maxLength=40 |
||||
eVSFirstClassMailIntlRequest / FromCustomsReference |
Optional |
Enter a value for Sender Customs Reference Number
to pass IOSS data in the SSF for export compliance. The text entered is any reference number that the sender wishes to
use. For example: <FromCustomsReference></FromCustomsReference> |
String |
maxLength=14 |
||||
eVSFirstClassMailIntlRequest |
Required |
|
(Alias) |
|
Request: eVSFirstClassMailIntl <eVSFirstClassMailIntlRequest USERID="XXXXXXXXX"
PASSWORD="XXXXXXXXX"> |
<Option
/> |
<Revision>2</Revision> |
<ImageParameters /> |
<FromFirstName>John</FromFirstName> |
<FromMiddleInitial>L</FromMiddleInitial> |
<FromLastName>Doe</FromLastName> |
<FromFirm /> |
<FromAddress1>test</FromAddress1> |
<FromAddress2>7
N Wilkes-Barre Blvd.</FromAddress2> |
<FromCity>Wilkes-Barre</FromCity> |
<FromState>PA</FromState> |
<FromZip5>18702</FromZip5> |
<FromZip4></FromZip4> |
<FromPhone>5708203158</FromPhone> |
<ToName></ToName> |
<ToFirstName>Reza</ToFirstName> |
<ToLastName>Dianat</ToLastName> |
<ToFirm>HP</ToFirm> |
<ToAddress1>HP</ToAddress1> |
<ToAddress2>5th
floor</ToAddress2> |
<ToAddress3>6406
Ivy Lane</ToAddress3> |
<ToCity>Greenbelt</ToCity> |
<ToProvince>Md</ToProvince> |
<ToCountry>Brazil</ToCountry> |
<ToPostalCode></ToPostalCode> |
<ToPOBoxFlag>N</ToPOBoxFlag> |
<ToPhone>5555555555</ToPhone> |
<ToFax>3012929999</ToFax> |
<ToEmail>b@aol.com</ToEmail> |
<FirstClassMailType></FirstClassMailType> |
<ShippingContents> |
<ItemDetail> |
<Description>Description
1</Description> |
<Quantity>1</Quantity> |
<Value>1.11</Value> |
<NetPounds>1</NetPounds> |
<NetOunces>1</NetOunces> |
<HSTariffNumber>123456</HSTariffNumber> |
<CountryOfOrigin>Switzerland</CountryOfOrigin> |
</ItemDetail> |
</ShippingContents> |
<GrossPounds>3</GrossPounds> |
<GrossOunces>2</GrossOunces> |
<ContentType>Documents</ContentType> |
<Agreement>Y</Agreement> |
<Comments>FirstClassMailIntl Comments</Comments> |
<ImageType>TIF</ImageType> |
<LabelDate></LabelDate> |
<HoldForManifest>N</HoldForManifest> <Container></Container> |
<Length>15.5</Length> |
<Width>5.5</Width> |
<Height>5.5</Height> |
<Girth></Girth> |
<ExtraServices> |
<ExtraService>109</ExtraService> |
</ExtraServices> |
<PriceOptions>COMMERCIAL BASE</PriceOptions> |
<DestinationRateIndicator>N</DestinationRateIndicator> |
</eVSFirstClassMailIntlRequest> eVS
FirstClass Mail Intl Request with HS Tarriff Number
and Tags <eVSFirstClassMailIntlCertifyRequest USERID="XXXXXXXXX"
PASSWORD="XXXXXXXXX"> <Option /> <Revision>2</Revision> <ImageParameters
/> <FromFirstName>John</FromFirstName> <FromMiddleInitial>L</FromMiddleInitial> <FromLastName>Doe</FromLastName> <FromFirm
/>
<FromAddress1>test</FromAddress1> <FromAddress2>7 N Wilkes-Barre
Blvd.</FromAddress2> <FromCity>Wilkes-Barre</FromCity> <FromState>PA</FromState> <FromZip5>18702</FromZip5> <FromZip4></FromZip4> <FromPhone>5708203158</FromPhone> <ToName></ToName> <ToFirstName>Reza</ToFirstName> <ToLastName>Dianat</ToLastName> <ToFirm>HP</ToFirm> <ToAddress1>HP</ToAddress1> <ToAddress2>5th
floor</ToAddress2> <ToAddress3>6406 Ivy
Lane</ToAddress3> <ToCity>Greenbelt</ToCity> <ToProvince>Md</ToProvince> <ToCountry>Brazil</ToCountry> <ToPostalCode></ToPostalCode> <ToPOBoxFlag>N</ToPOBoxFlag> <ToPhone>5555555555</ToPhone> <ToFax>3012929999</ToFax> <ToEmail>b@aol.com</ToEmail> <FirstClassMailType></FirstClassMailType> <ShippingContents> <ItemDetail> <Description>Policy guidelines
document</Description> <Quantity>1</Quantity> <Value>55.00</Value> <NetPounds>1</NetPounds> <NetOunces>5</NetOunces> <HSTariffNumber>4901.10.0000</HSTariffNumber> <CountryOfOrigin>United
States</CountryOfOrigin> <ItemCategory>turbo</ItemCategory> <ItemSubCategory>charger</ItemSubCategory> </ItemDetail> </ShippingContents> <GrossPounds>3</GrossPounds> <GrossOunces>2</GrossOunces> <ContentType>Documents</ContentType> <Agreement>Y</Agreement> <Comments>FirstClassMailIntl
Comments</Comments> <ImageType>TIF</ImageType> <LabelDate></LabelDate> <HoldForManifest>N</HoldForManifest>
<Container>RECTANGULAR</Container> <Size>LARGE</Size> <Length>15.5</Length> <Width>5.5</Width> <Height>5.5</Height> <Girth></Girth> <ExtraServices> <ExtraService/> </ExtraServices> <PriceOptions>COMMERCIAL
BASE</PriceOptions> <DestinationRateIndicator>N</DestinationRateIndicator> </eVSFirstClassMailIntlCertifyRequest> |
Tag Name |
Occurs |
Description |
Type |
Validation |
eVSFirstClassMailIntlResponse |
Required
|
|
(Alias)
|
|
eVSFirstClassMailIntlResponse / Postage |
Required
|
Postage
amount |
Decimal |
|
eVSFirstClassMailIntlResponse / TotalValue |
Required
|
Value
of all items being shipped |
Decimal |
|
eVSFirstClassMailIntlResponse / BarcodeNumber |
Required
|
Mail service related barcode. |
String |
|
eVSFirstClassMailIntlResponse / LabelImage |
Required
|
Encoded
images of label. (may be empty depending upon layout selection or items
shipped) |
base64Binary |
|
eVSFirstClassMailIntlResponse / Page2Image |
Required
|
Encoded
images of label. (may be empty depending upon layout selection or items
shipped) |
base64Binary |
|
eVSFirstClassMailIntlResponse / Page3Image |
Required
|
Encoded
images of label. (may be empty depending upon layout selection or items
shipped) |
base64Binary |
|
eVSFirstClassMailIntlResponse / Prohibitions |
Required
|
List of
items prohibited from mailing based on country of destination |
String |
|
eVSFirstClassMailIntlResponse / Restrictions |
Required
|
Restrictions
on items being shipped based on country of destination |
String |
|
eVSFirstClassMailIntlResponse / Observations |
Required
|
Additional
mailing information based on country of destination |
String |
|
eVSFirstClassMailIntlResponse / Regulations |
Required
|
Additional
regulations for shipping to destination country |
String |
|
eVSFirstClassIntlResponse / AdditionalRestrictions |
Required |
Additional
restrictions on items being shipped to destination country |
String |
|
eVSFirstClassIntlResponse / DestinationBarcodeNumber |
Optional |
|
String |
minOccurs=0 |
eVSFirstClassIntlResponse / ExtraServices |
Optional
|
Appears
if ExtraServices was populated in the request |
(Group) |
|
eVSFirstClassIntlResponse / ExtraServices / ExtraService |
Optional,
repeating up to unbounded times |
Groups
extra service information |
(Group) |
|
eVSFirstClassIntlResponse / ExtraServices / ExtraService
/ ServiceID |
Required
|
Extra
Service ID echoed from request |
String |
|
eVSFirstClassIntlResponse / ExtraServices / ExtraService
/ ServiceName |
Required
|
Extra
Service name |
String |
|
eVSFirstClassIntlResponse / ExtraServices / ExtraService/
Price |
Required
|
Extra
Service fee |
Decimal |
|
eVSFirstClassMailIntlResponse / Warning |
Optional |
|
String |
|
eVSFirstClassMailIntlCertifyResponse |
Required
|
|
(Alias)
|
|
<eVSFirstClassMailIntlResponse> |
<Postage>30.42</Postage> |
<TotalValue>1.11</TotalValue> |
<BarcodeNumber>LZ333007778US</BarcodeNumber> |
<LabelImage>......removed......</LabelImage> |
<Page2Image></Page2Image> |
<Page3Image></Page3Image> |
<Prohibitions> |
Banknotes;
currency notes; paper money; securities payable to bearer; and traveler's
checks. |
Coins;
manufactured and unmanufactured platinum, gold, and silver; precious stones;
jewels; expensive jewelry; and other valuable articles. |
Commercial
samples that promote tobacco products or smoking-related merchandise. |
Commercial
shipments that contain cigarettes, cigarillos, cigars, loose and packaged
tobacco, pipes, and other smoking devices. |
Items
that are fragile, either by nature or due to inadequate packing, that could
cause harm to individuals or equipment. |
Medicines
whose formulas are not listed in the official pharmacopeias or not licensed
by the Brazilian Department of Public Health. |
Perishable
infectious biological substances. |
Perishable
noninfectious biological substances. |
Playing
cards. |
Poniards,
stilettos, poniard blades; canes, umbrellas, or any other articles containing
swords, daggers, or guns; handcuffs, and blackjacks. |
Primary
educational books not written in Portuguese. |
Radioactive
materials. |
Regulation
arms and munitions of Brazil and parts. Air guns. Reducing tubes and
silencers for firearms. |
Salted
or smoked meat, and other foodstuffs of animal origin. |
Seeds
and seedlings of coffee, shrubs. |
Used
consumer goods (See Observation #5 for exception). |
</Prohibitions> |
<Restrictions> |
Medicines
must be accompanied by a prescription from the attendant Brazilian doctor.
This prescription should be on a chemist's form, bearing the name, private
address or office of the doctor, his registration number with the Brazil
National Medical Council and a Portuguese translation of the instructions, as
necessary. Postal packages containing medicaments and not satisfying the
above-mentioned conditions will be returned to the senders or, if abandoned,
treated as undeliverable items. |
Postage
stamps are admitted only in registered shipments. |
Saccharine
and other artificial sweeteners for artificial beverages require permission
from the Brazilian Department of Public Health for importation. |
</Restrictions> |
<Observations> |
1.
Brazil reserves the right to collect a "presentation-to-Customs
charge" from customers for any item submitted to customs control, even
if no customs charges are levied. |
2.
Import licenses are Required for many kinds of goods and senders should
ascertain from the addressee before mailing that the necessary documents are
held. |
3.
Imports are allowed by mail, including mail order catalog shipments, up to a
value of U.S. $500 (U.S. $1000 for computer software) without the requirement
of an import license provided the item is not for resale. Shipments valued at
no more than U.S. $50 are duty free and are delivered to the addressee;
shipments above U.S. $50 can be picked up at the post office upon payment of
import duties. Imports that are prohibited or subject to special regulations
must comply with applicable Brazilian government provisions. Identical
shipments from the same source to the same person or address in Brazil within
a 90 day period are considered part of the same
shipment and may be subject to confiscation. Other merchandise that usually
enters duty free includes items such as newspapers, maps, books, and
magazines. |
4.
Shipments for which an import permit has not been issued are considered
contraband and confiscated. |
5.
Shipments that do not indicate the applicable postage and fees on PS Form
2976-A will hinder the customs clearance process, causing delays to clear the
items. |
6. Used
consumer goods may only be sent to charitable organizations that are
recognized by the Brazilian government as being entities which serve the
public interest. |
</Observations> |
<Regulations> |
Country
Code: |
BR |
|
Reciprocal
Service Name; |
Serca |
Required
Customs Form/Endorsement |
1.
Correspondence and business papers. |
PS Form
2976, Customs - CN 22 and Sender's Declaration. Endorse item clearly next to
mailing label as BUSINESS PAPERS. |
2.
Merchandise, merchandise samples without commercial value, documents,
computer data, and all articles subject to customs duty. |
PS Form
2976-A, Customs Declaration and Dispatch Note CP 72, inside a PS Form 2976-E,
Customs Declaration Envelope CP 91. Include an invoice with all commercial
shipments. |
Note: |
Coins;
banknotes; currency notes, including paper money; securities of any kind
payable to bearer; traveler's checks; platinum, gold, and silver; precious
stones; jewelry; watches; and other valuable articles are prohibited in
Priority Mail Express International shipments to Brazil. |
Areas
Served: All |
</Regulations> |
<AdditionalRestrictions>No Additional Restrictions Data
found.</AdditionalRestrictions> |
<ExtraServices> |
<ExtraService> |
<ServiceID>10</ServiceID> |
<ServiceName>Electronic USPS Delivery Confirmation
International (Service temporarily suspended)</ServiceName> |
<Price>0.00</Price> |
</ExtraService> |
</ExtraServices> |
<RemainingBarcodes>5< RemainingBarcodes> |
</eVSFirstClassMailIntlResponse> |
Global
Express Guaranteed is our fastest international shipping service, with
transportation and delivery by FedEx Express. It features date-certain delivery
in 1-3 business days* to more than 190 countries with a money-back guarantee**
to all destinations. This document contains a Reference Guide to the eVS GXG Get Label Request.
Please note
that the GXG airway bill image is not currently supported in the response. The
API returns the appropriate barcode numbers but requires the integrator to
produce the GXG airway bill image.
Scheme |
Host |
Path |
API |
XML |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSGXGGetLabel |
&XML=(see
Tag Descriptions below) |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSGXGGetLabelCertify |
&XML=(see
Tag Descriptions below) |
Tag
Name |
Occurs |
Description |
Type |
Validation |
eVSGXGGetLabelRequest |
Required
|
|
(Alias)
|
|
eVSGXGGetLabelRequest / USERID |
Required |
This attribute specifies your Web Tools user ID. See the Developer's Guide for information on obtaining your USERID. For Example: USERID="XXXXXXX" |
NMTOKEN |
|
eVSGXGGetLabelRequest / PASSWORD |
Required |
This attribute specifies your Web Tools password. See the Developer's Guide for information on your Password. For Example: PASSWORD="XXXXXXX" |
NMTOKEN |
|
eVSGXGGetLabelRequest / Option |
Required
|
For
future use. |
Empty |
|
eVSGXGGetLabelRequest / Revision |
Optional |
This is
for versioning of the APIs and for triggering response tags for future
versions. In this
API use a value of 2 to trigger new functionality. For
example: <Revision>1</Revision> |
String |
minLength=0 pattern=\d{1} |
eVSGXGGetLabelRequest / ImageParameters |
Required
|
For
future use. |
Empty |
|
eVSGXGGetLabelRequest / FromFirstName |
Required
|
First
and Last Name must be sent. Maximum Length: 32 characters total for First,
Middle, and Last Names with space after first and middle name. For
example: <FromFirstName>John</FromFirstName> |
String |
minLength=1 |
eVSGXGGetLabelRequest / FromMiddleInitial |
Optional
|
First
and Last Name must be sent. Maximum Length: 32 characters total for First,
Middle, and Last Names with space after first and middle name. For
example: <FromMiddleInitial>L</FromMiddleInitial> |
String |
minLength=0 |
eVSGXGGetLabelRequest / FromLastName |
Required
|
First
and Last Name must be sent. Maximum Length: 32 characters total for First,
Middle, and Last Names with space after first and middle name. For
example: <FromLastName>Doe</FromLastName> |
String |
minLength=1 |
eVSGXGGetLabelRequest / FromFirm |
Required |
Firm
Name. For
example: <FromFirm>USPS</FromFirm> |
String |
minLength=0 |
eVSGXGGetLabelRequest / FromAddress1 |
Optional
|
Secondary
address unit designator and number (such as an apartment or suite number (APT
202, STE 100)). For
example: <FromAddress1/> |
String |
minLength=0 |
eVSGXGGetLabelRequest / FromAddress2 |
Required
|
Street
number and name (including predirectional, suffix,
and postdirectional as shown in USPS ZIP+4 Product
for the delivery address or rural route and box number (RR 5 BOX 10), highway
contract route and box number (HC 4 BOX 45), or post office box number (PO
BOX 458). For
example: <FromAddress2>10 Elm Street </FromAddress2> |
String |
minLength=1 |
eVSGXGGetLabelRequest / FromUrbanization |
Optional
|
Urbanization
name (Puerto Rico only, ZIP Code prefixes 006 to 009, if area is so
designated). For
example: <FromUrbanization>URB Caparra
Ter</FromUrbanization> |
String |
minLength=0 |
eVSGXGGetLabelRequest / FromCity |
Required
|
City
name. For
example: <FromCity>Anytown</FromCity> |
String |
minLength=1 |
eVSGXGGetLabelRequest / FromState |
Required
|
Use
2-letter USPS state abbreviation. For
example: <FromState>PA</FromState> |
String |
pattern=\w\w
|
eVSGXGGetLabelRequest / FromZIP5 |
Required
|
Five-digit
ZIP code. For
example: <FromZip5>01234</FromZip5> |
String |
pattern=\d{5} |
eVSGXGGetLabelRequest / FromZIP4 |
Optional
|
Four-digit
extension of ZIP+4 code. For
example: <FromZip4>5678</FromZip4> |
String |
minLength=0 pattern=\d{4} |
eVSGXGGetLabelRequest / FromPhone |
Required
|
10
digits Required (including area code), with no punctuation. Use format: 2125551234 For
example: <FromPhone>5555555555</FromPhone> |
String |
pattern=\d{10} |
eVSGXGGetLabelRequest / ShipFromZIP |
Optional
|
Origin
ZIP Code shall be accepted as component in request via "ShipFromZip" tag. For
example: <ShipFromZIP>18701</ShipFromZIP> |
String |
minLength=0 pattern=\d{5} |
eVSGXGGetLabelRequest / SenderEMail |
Optional
|
E-mail
address of sender. Valid e-mail
addresses must be used. Note: No
e-mail is returned when generating a Sample label request. For
example: <SenderEMail>cpapple@email.com</SenderEMail> |
String |
pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4} pattern= |
eVSGXGGetLabelRequest / ToFirstName |
Required
|
First
and Last Name must be sent. Maximum Length: 36 characters total for First,
and Last Names with space after first name. For
example: <ToFirstName>John</ToFirstName> |
String |
minLength=1 |
eVSGXGGetLabelRequest / ToLastName |
Required
|
First
and Last Name must be sent. Maximum Length: 36 characters total for First,
and Last Names with space after first name. For
example: <ToLastName>John</ToLastName> |
String |
minLength=1 |
eVSGXGGetLabelRequest / ToFirm |
Required
|
Firm
Name. For
example: <ToFirm>USPS</ToFirm> |
String |
minLength=0 |
eVSGXGGetLabelRequest / ToAddress1 |
Optional |
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. For
example: <ToAddress1>10 Elm Street </ToAddress1> |
String |
minLength=1 |
eVSGXGGetLabelRequest / ToAddress2 |
Required |
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. For
example: <ToAddress2>Suite 4000</ToAddress2> |
String |
minLength=0 |
eVSGXGGetLabelRequest / ToAddress3 |
Optional
|
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. For
example: <ToAddress3/> |
String |
minLength=0 |
eVSGXGGetLabelRequest / ToPostalCode |
Optional
|
Destination
Postal Code. For
example: <ToPostalCode> T2G 2W1</ToPostalCode> |
String |
minLength=1 |
eVSGXGGetLabelRequest / ToPhone |
Optional
|
Up to
25 digits allowed with no punctuation. For
example: <ToPhone>1234567890</ToPhone> |
String |
pattern=\d{25} |
eVSGXGGetLabelRequest / RecipientEMail |
Optional
|
E-mail
address of recipient. Valid e-mail
addresses must be used. Note: No
e-mail is returned when generating a Sample label request. For
example: <RecipientEMail>cpapple@email.com</RecipientEMail> |
String |
pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4} pattern= |
eVSGXGGetLabelRequest / ToDPID |
Required
|
The
Delivery Point ID as determined via the GXGGetDeliveryPoint
API response. Please contact webtools@usps.gov for more information. For
example: <ToDPID>142</ToDPID> |
String |
pattern=\d{1,10} |
eVSGXGGetLabelRequest / ToProvince |
Optional
|
Enter
the province for the recipient. For
example: <ToProvince>JALISCO</ToProvince> |
String |
minLength=0 |
eVSGXGGetLabelRequest / ToTaxID |
Optional
|
Tax ID For
example: <ToTaxID/> |
String |
minLength=0 |
eVSGXGGetLabelRequest / Container |
Required
|
Container
type. USPS refers to USPS-supplied large flat envelopes which incur
weight-based postage. For
example: <Container>LETTER</Container> |
String |
enumeration= ·
VARIABLE ·
LARGEENVELOPE ·
LETTER ·
LEGALENVELOPE ·
USPSGXGENVELOPE ·
USPSGXGLEGALENVELOPE ·
USPSGXGTYVEKENVELOPE ·
PACKAGE |
eVSGXGGetLabelRequest / ContentType |
Required
|
Content
type. For
example: <ContentType>DOCUMENTS</ContentType> |
String |
enumeration= ·
DOCUMENTS ·
NON-DOC |
eVSGXGGetLabelRequest / ShippingContents |
Required
|
Contents
of package. |
(Group)
|
|
eVSGXGGetLabelRequest / ShippingContents / ItemDetail |
Required
repeating up to 30 times |
One
item detail per item type enclosed. |
(Group)
|
|
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ Description |
Required
|
Description
of the item. For
certain countries/destinations (i.e., when the Web Tools Price Calculator
APIs return <HSCodeEnforced>=“true”) the API enforces a blacklist of descriptions not permitted:
none, not applicable, n/a, null, gift, merchandise Other
non-descriptive wording always results in an error: gift, sample, other For
example: <Description>Policy guidelines
document</Description> |
String |
minLength=1 |
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ Commodity |
Required
|
Commodity
shall be a text String matching Commodity Name from GXGGetCommodityInfo.
For
example: <Commodity>Documents</Commodity> |
String |
minLength=1 |
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ Restriction |
Optional
repeating up to 4 times |
Allows
integrators to pass restrictions information (responses to footnote
questions) for each "Commodity/CommodityName." |
(Group)
|
|
eVSGXGGetLabelRequest/ShippingContents / ItemDetail
/ Restriction / FootnoteNumber |
Required
|
Number
associated with the commodity restriction question returned from the Get
Commodity Restrictions service. Using a number which does not pertain to the
passed commodity and derived country will result in an error return. For
example: <FootnoteNumber>196</FootnoteNumber> |
String |
maxLength=4
|
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ Restriction / Response |
Required
|
May
affect the need to use a Commercial invoice, and/or the ability to continue
the transaction at all. For
example: <Response>Y</Response> |
String |
enumeration= ·
Y ·
N |
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ Quantity |
Required
|
Quantity
of the item. For
example: <Quantity>4</Quantity> |
String |
pattern=\d{5} |
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ UnitValue |
Required
|
The
data entered with this tag provides the value of the one of items in this
Item Detail. For
example: <UnitValue>125.00</UnitValue> |
Decimal |
minExclusive=0.0
|
eVSGXGGetLabelRequest /S hippingContents / ItemDetail
/ NetPounds |
Optional |
Rules:
1. If
any <ItemDetail> contains either a <NetPounds> or <NetOunces>
sub-tag, then all <ItemDetail> nodes must
specify at least a <NetPounds> or <NetOunces> tag. 2.
If the <NetPounds> and/or <NetOunces> are specified successfully, then those
values will be used in the manifesting of the Customs Declarations. 3. If
<NetPounds> and <NetOunces>
are note specified, then the value for <NetPounds>
and <NetOunces> for each customs declaration
will be the <GrossPounds> and <GrossOunces> divided by the number of <ItemDetails> present. |
Integer |
minInclusive=0 |
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ NetOunces |
Optional |
Rules:
1. If
any <ItemDetail> contains either a <NetPounds> or <NetOunces>
sub-tag, then all <ItemDetail> nodes must
specify at least a <NetPounds> or <NetOunces> tag. 2. If
the <NetPounds> and/or <NetOunces> are specified successfully, then those
values will be used in the manifesting of the Customs Declarations. 3. If
<NetPounds> and <NetOunces>
are note specified, then the value for <NetPounds>
and <NetOunces> for each customs declaration
will be the <GrossPounds> and <GrossOunces> divided by the number of <ItemDetails> present. |
Decimal |
default=0.0 minInclusive=0 |
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ UnitOfMeasure |
Optional
|
Unit of
Measure for item quantity. For
example: <UnitOfMeasure>Dozen</UnitOfMeasure> |
String |
minLength=0 |
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ HSTariffNumber |
Optional
|
For
commercial items only. If known, the HS tariff number must be based on the
Harmonized Commodity Description and Coding System developed by the World
Customs Organization. For
example: <HSTariffNumber>123456</HSTariffNumber> |
String |
minLength=1 |
eVSGXGGetLabelRequest / ShippingContents / ItemDetail
/ CountryofManufacture |
Optional
|
The
country name entered must match an entry from the USPS-approved International
Index of Countries and Localities or be "United States". Click on
the link for "International Country Listings." Using a country name not on the
list will result in a request failure. Required
when CIRequired=”true”. For
example: <CountryOfManufacture>United
States</CountryOfManufacture> |
String |
minLength=1
|
eVSGXGGetLabelRequest / PurposeOfShipment |
Required
|
Statement of shipment purpose. For example: <PurposeOfShipment>Gift</PurposeOfShipment> |
String |
minLength=1
|
eVSGXGGetLabelRequest / PartiesToTransaction |
Optional
|
Defines
relationship of parties to transaction. For
example: <PartiesToTransaction>Related</PartiesToTransaction> |
String |
enumeration= ·
Related ·
Unrelated ·
Other |
eVSGXGGetLabelRequest / Agreement |
Required
|
Agreement
to GXG service terms and conditions. For
example: <Agreement>Y</Agreement> |
String |
enumeration= ·
Y ·
N |
eVSGXGGetLabelRequest / Postage |
Optional
|
Use
this tag for entering the postage amount, if known, excluding extra services. If the
value is blank, the postage will be automatically calculated using retail
rates. For
example: <Postage>137.95</Postage> |
Decimal |
minInclusive=0 |
eVSGXGGetLabelRequest / InsuredValue |
Optional
|
If
specified, InsuredValue is used to calculate the
Insurance Fee. For
example: <InsuredValue>180.00</InsuredValue> |
Decimal |
minExclusive=0.0
|
eVSGXGGetLabelRequest / GrossPounds |
Optional
|
GrossPounds + (GrossOunces/16) must be less than 70. For
example: <GrossPounds>40</GrossPounds> |
Decimal |
maxInclusive=70
|
eVSGXGGetLabelRequest / GrossOunces |
Optional
|
GrossPounds + (GrossOunces/16) must be less than 70. For
example: <GrossOunces>5</GrossOunces> |
Decimal |
maxInclusive=1120
|
eVSGXGGetLabelRequest / Length |
Optional |
Value
must be numeric. Units are inches. If partial dimensions are provided, an
error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
Decimal |
pattern=\d{1,2} |
eVSGXGGetLabelRequest / Width |
Optional |
Value
must be numeric. Units are inches. If partial dimensions are provided, an
error 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
for non-rectangular packages. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
Decimal |
pattern=\d{1,2} |
eVSGXGGetLabelRequest / Height |
Optional |
Value
must be numeric. Units are inches. If partial dimensions are provided, an
error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
Decimal |
pattern=\d{1,2} |
eVSGXGGetLabelRequest / Girth |
Optional |
Value
must be numeric. Units are inches. If partial dimensions are provided, an
error 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
for non-rectangular package. Please
reference https://about.usps.com/postal-bulletin/2018/pb22509/html/updt_002.htm
for more details on
dimensional weight pricing. |
Decimal |
pattern=\d{1,2} |
eVSGXGGetLabelRequest / Shape |
Optional
|
Required
except when Container=”USPS”. Shape, plus the
package's physical dimensions, help determine whether the scale weight or the
dimensional weight is used to calculate the shipping cost. For
example: <Shape>RECTANGULAR</Shape> |
String |
default=RECTANGULAR enumeration= ·
RECTANGULAR ·
NONRECTANGULAR |
eVSGXGGetLabelRequest / CIRequired |
Optional
|
Indicates
if Commercial Invoice is Required.
When CIRequired=”true”,
commercial invoice image will be generated. For
example: <CIRequired>true</CIRequired> |
boolean |
default=false |
eVSGXGGetLabelRequest / InvoiceDate |
Optional
|
Invoice
date. Required when CommercialShipment=”true”. For
example: <InvoiceDate>01/01/2012</InvoiceDate> |
|
dateTime |
eVSGXGGetLabelRequest / InvoiceNumber |
Optional
|
Invoice
number. Required when CommercialShipment=”true”. For
example: <InvoiceNumber>20120101</InvoiceNumber> |
String |
minLength=1 |
eVSGXGGetLabelRequest / CustomerOrderNumber |
Optional
|
Customer
order number. User assigned number for
internal use. For
example: <CustomerOrderNumber>20120101</CustomerOrderNumber> |
String |
maxLength=20
|
eVSGXGGetLabelRequest / CustOrderNumber |
Optional
|
Customer
order number. User assigned number for
internal use. Either use CustomerOrderNumber or CustOrderNumber. For
example: <CustOrderNumber>20120101</CustOrderNumber> |
String |
maxLength=20
|
eVSGXGGetLabelRequest / TermsDelivery |
Optional
|
Indicates
terms of delivery. Required when CommercialShipment=”true”. For
example: <TermsDelivery>CPT</TermsDelivery> |
String |
enumeration= ·
CPT ·
CIP ·
DAF ·
DDU ·
OTHER |
eVSGXGGetLabelRequest / TermsDeliveryOther |
Optional
|
Terms
description. Required when
TermsDelivery=”OTHER”. For
example: <TermsDeliveryOther>DES</TermsDeliveryOther> |
String |
minLength=1 maxLength=30 |
eVSGXGGetLabelRequest / PackingCost |
Optional
|
Packing
cost. For
example: <PackingCost>15.00</PackingCost> |
Decimal |
minInclusive=0.00 |
eVSGXGGetLabelRequest / CountryUltDest |
Required
|
Ultimate
destination country. For
example: <CountryUltDest>Austria</CountryUltDest> |
String |
minLength=1 |
eVSGXGGetLabelRequest / CIAgreement |
Optional
|
Agreement
to Commercial Invoice terms and conditions.
Required when CIRequired=”true”. For
example: <CIAgreement>true</CIAgreement> |
boolean |
|
eVSGXGGetLabelRequest / ImageType |
Required
|
Controls
the file format of the commercial invoice image returned. For
example: <ImageType>NONE</ImageType> |
String |
enumeration= ·
PDF ·
TIF ·
NONE |
eVSGXGGetLabelRequest / ImageLayout |
Optional
|
For
future use. |
Empty |
|
eVSGXGGetLabelRequest / CustomerRefNo |
Optional
|
Written
to Postal Manifest Detail record. For
example: <CustomerRefNo>Ref 369246</CustomerRefNo> |
String |
maxLength=30 |
eVSGXGGetLabelRequest / CustomerRefNo2 |
Optional
|
Written
to Postal Manifest Detail record. For
example: <CustomerRefNo2>ACT 369246</ CustomerRefNo2> |
String |
maxLength=30 |
eVSGXGGetLabelRequest / ShipDate |
Required
|
Format:
mm/dd/yyyy. Should "ShipDate"
value not be provided, the service shall use the current date as a basis for
delivery date calculations. For
example: <ShipDate>01/01/2012</ShipDate> |
String |
minLength=0 pattern=\d{1,2}/\d{1,2}/\d{4} |
eVSGXGGetLabelRequest / HoldForManifest |
Optional
|
Restricted
use. For authorized users, holds manifest record for possible inclusion in
SCAN request when Y. All other users should omit or specify N. For
example: <HoldForManifest>Y</HoldForManifest> |
String |
enumeration= ·
Y ·
N |
eVSGXGGetLabelRequest / PriceOptions |
Optional
|
Returns
commercial pricing. |
String |
minOccurs=0
default=COMMERCIAL
BASE |
eVSGXGGetLabelRequest / CommercialShipment |
Optional
|
If
True, then Invoice/Buyer info Required.
If False, then Optional. For
example: <CommercialShipment>true</CommercialShipment> |
boolean |
default=false |
eVSGXGGetLabelRequest / BuyerFirstName |
Optional
|
Buyer
first name. Required when CommercialShipment=”true”. For
example: <BuyerFirstName>John</BuyerFirstName> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerLastName |
Optional
|
Buyer
last name. Required when CommercialShipment=”true”. For
example: <BuyerLastName>Smith</BuyerLastName> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerAddress1 |
Optional
|
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. Required
when CommercialShipment=”true”. For
example: <BuyerAddress1>Lazarette Str. 7</BuyerAddress1> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerAddress2 |
Optional
|
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. For
example: <BuyerAddress2/> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerAddress3 |
Optional
|
Three
address lines are provided, but only 1 is Required. Use as many as needed for
complete address. For
example: <BuyerAddress3/> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerCity |
Optional
|
Buyer
city. Required when CommercialShipment=”true”. For
example: <BuyerCity>Berlin</BuyerCity> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerState |
Optional
|
Buyer
state. Required when CommercialShipment=”true”. For
example: <BuyerState/> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerPostalCode |
Optional
|
Buyer
postal code. Required when CommercialShipment=”true”. For
example: <BuyerPostalCode>10117</BuyerPostalCode> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerCountry |
Optional
|
Buyer
country. Required when CommercialShipment=”true”. For
example: <BuyerCountry>Germany</BuyerCountry> |
String |
minLength=0 |
eVSGXGGetLabelRequest / BuyerTaxID |
Optional
|
Buyer TaxID. For
example: <BuyerTaxID>11123456789</BuyerTaxID> |
String |
minLength=1 |
eVSGXGGetLabelRequest / BuyerRecipient |
Optional
|
Indicates
that Buyer and Recipient are the same. When CommercialShipment=”true”
and BuyerRecipient =”true”, buyer information is
not Required. For
example: <BuyerRecipient>true</BuyerRecipient> |
Boolean |
default=true |
eVSGXGGetLabelRequest / TermsPayment |
Optional |
TermsPayment is
Required when CommercialShipment =”true”. For
example: <TermsPayment>Net 50</TermsPayment> |
String |
minLength=1 |
eVSGXGGetLabelRequest / ActionCode |
Optional |
Passed
to SPE file via the shipment manifest. |
String |
Default
= M0 enumeration= ·
M0 ·
S0 |
eVSGXGGetLabelRequest / OptOutOfSPE |
Optional |
Allows
a customer to opt out of SPE file creation. “false” WILL create a SPE file. |
boolean |
Default
= true enumeration= ·
true ·
false |
eVSGXGGetLabelRequest / PermitNumber |
Optional |
Number
associated with a mailing permit. The
permit is permission to use a certain postage payment method for bulk and
commercial mailings |
String |
minOccurs=0 |
eVSGXGGetLabelRequest / AccountZipCode |
Optional |
ZIP of
Account Post Office where mailed if different from
<FromZip5/>. Written to Postal Manifest Detail record. Must be valid
ZIP Code. For
example: <POZipCode>00962</POZipCode> |
String |
whiteSpace=collapse length=5 |
eVSGXGGetLabelRequest / Machinable |
Optional |
Indicates
whether or not the item is machinable. A surcharge
is applied to a First-Class Mail International item if it has one or more
non-machinable characteristics. See International Mail Manual (IMM) Section 241 for more information. For
example: <Machinable>false</Machinable> |
Boolean |
default=true |
eVSGXGGetLabelRequest / DestinationRateIndicator |
Required |
Required for destination entry
packagesenter either “I” or “N”. I= International Service Center (ISC) N = None |
String |
enumeration= ·
I ·
N |
eVSGXGGetLabelRequest / MID |
Optional |
Mailer
ID (MID), Represents Mail Owner MID. Located
in position #13 in the Detail 1 record of the Shipping Services File v2.0. For
example: <MID>847654321</ MID> |
String |
minOccurs=0 |
eVSGXGGetLabelRequest / LogisticsManagerMID |
Optional |
The MID
of the company that manages the mailing. Located
in position #12 in the Detail 1 record of the Shipping Services File v2.0. Note:
If LogisticsManagerMID is populated, either CRID or
MID must also be populated. For
example: <LogisticsManagerMID>489001< / LogisticsManagerMID> |
String |
minOccurs=0 |
eVSGXGGetLabelRequest / CRID |
Optional |
Customer
Registration ID, Represents Mail Owner CRID. Located
in position #20 in the Detail 1 record of the Shipping Services File v2.0. For
example: <CRID>544762</ CRID> |
String |
minOccurs=0 |
eVSGXGGetLabelRequest / VendorCode |
Optional |
Code
from vendor software to identify the developer of the shipping system. Located
in position #15 in the Detail 1 record of the Shipping Services File v2.0. For
example: <VendorCode>1234<VendorCode> |
String |
minOccurs=0 default=8300 |
eVSGXGGetLabelRequest / VendorProductVersionNumber |
Optional |
Shipping
software’s product version number. Located
in position #16 in the Detail 1 record of the Shipping Services File v2.0. For
example: <VendorProductVersionNumber>5.02.1B</ VendorProductVersionNumber> |
String |
minOccurs=0 |
eVSGXGGetLabelRequest / OverrideMID |
Optional |
|
String |
|
eVSGXGGetLabelRequest / ChargebackCode |
Optional |
|
String |
|
eVSGXGGetLabelRequest |
Required |
|
(Alias) |
|
Request:
eVSGXGGetLabelRequest <eVSGXGGetLabelRequest USERID="XXXXXXXXX"
PASSWORD="XXXXXXXXX"> |
<Option></Option> |
<Revision>2</Revision> |
<ImageParameters></ImageParameters> |
<FromFirstName>Test From
First</FromFirstName> |
<FromMiddleInitial></FromMiddleInitial> |
<FromLastName>Test From
Last</FromLastName> |
<FromFirm>Test From Firm</FromFirm> |
<FromAddress1>APT
1027</FromAddress1> |
<FromAddress2>15555
N FRANK LLOYD WRIGHT BLVD</FromAddress2> |
<FromUrbanization></FromUrbanization> |
<FromCity>SCOTTSDALE</FromCity> |
<FromState>AZ</FromState> |
<FromZIP5>85260</FromZIP5> |
<FromZIP4>2073</FromZIP4> |
<FromPhone>5555555555</FromPhone> |
<ShipFromZIP>85260</ShipFromZIP> |
<ToFirstName>TestToFirst</ToFirstName> |
<ToLastName>TestToLast</ToLastName> |
<ToFirm>TestToFirm</ToFirm> |
<ToAddress1>Test
ToAddress1</ToAddress1> |
<ToAddress2>Test
ToAddress2</ToAddress2> |
<ToAddress3>Test
ToAddress3</ToAddress3> |
<ToDPID>108993</ToDPID> |
<ToProvince></ToProvince> |
<ToTaxID></ToTaxID> |
<Container>VARIABLE</Container> |
<ContentType>NON-DOC</ContentType> |
<ShippingContents> |
<ItemDetail> |
<Description>cabling
kit</Description> |
<Commodity>pamphlets</Commodity> |
<Quantity>1</Quantity> |
<UnitValue>89.0</UnitValue> |
<HSTariffNumber>854411</HSTariffNumber> |
<CountryofManufacture>China</CountryofManufacture> |
</ItemDetail> |
</ShippingContents> |
<Agreement>Y</Agreement> |
<InsuredValue></InsuredValue> |
<GrossPounds>2</GrossPounds> |
<GrossOunces>11</GrossOunces> |
<Length>13.5</Length> |
<Width>6.5</Width> |
<Height>5.5</Height> |
<Girth>7.75</Girth> |
<Shape>RECTANGULAR</Shape> |
<CIRequired></CIRequired> |
<InvoiceDate></InvoiceDate> |
<InvoiceNumber></InvoiceNumber> |
<CustOrderNumber></CustOrderNumber> |
<TermsDelivery></TermsDelivery> |
<PackingCost></PackingCost> |
<CountryUltDest></CountryUltDest> |
<CIAgreement></CIAgreement> |
<ImageType>TIF</ImageType> |
<ImageLayout></ImageLayout> |
<ShipDate></ShipDate> |
<HoldForManifest>N</HoldForManifest> |
<PriceOptions></PriceOptions> |
<DestinationRateIndicator>N</DestinationRateIndicator> |
</eVSGXGGetLabelRequest> |
Tag Name |
Occurs |
Description |
Type |
Validation |
eVSGXGGetLabelResponse |
Required
|
Public GXGGetLabel API |
(Alias)
|
|
eVSGXGGetLabelResponse / Postage |
Required
|
Postage
for this package. |
Decimal |
minExclusive=0.0
|
eVSGXGGetLabelResponse / CommodityGuarantee |
Required
|
|
(Group)
|
|
eVSGXGGetLabelResponse / CommodityGuarantee / CommodityType |
Required
|
Guarantee
date shall be provided in response where all commodities 'W' or 'D' only.
|
String |
enumeration= ·
D ·
W |
eVSGXGGetLabelResponse / CommodityGuarantee / GuaranteeDate |
Required
|
Where
CI Required, the non-document transit time/number of days will be used in calculating
the guarantee GXG date. |
String |
pattern=\d{1,2}/\d{1,2}/(\d{2})?\d{2} |
eVSGXGGetLabelResponse / Insurance |
Optional
|
Deprecated. |
Decimal |
|
eVSGXGGetLabelResponse / USPSBarcodeNumber |
Required
|
USPS 10 digit human readable barcode number. |
String |
pattern=82\d{8} |
eVSGXGGetLabelResponse / FedExBarcodeNumber |
Required
|
FedEx 12 digit human readable barcode number. |
String |
pattern=8982\d{8} |
eVSGXGGetLabelResponse / LabelImage |
Required
|
For
future use. Will still return an empty response tag when request
indicates an image is requested. |
base64Binary |
minLength=0
|
eVSGXGGetLabelResponse / LabelImagePage2 |
Required
|
For
future use. Will still return an empty response tag when request
indicates an image is requested. |
base64Binary |
minLength=0
|
eVSGXGGetLabelResponse / LabelImagePage3 |
Required
|
For
future use. Will still return an empty response tag when request
indicates an image is requested. |
base64Binary |
minLength=0
|
eVSGXGGetLabelResponse / LabelImagePage4 |
Required
|
For
future use. Will still return an empty response tag when request
indicates an image is requested. |
base64Binary |
minLength=0
|
eVSGXGGetLabelResponse / CIImage |
Required
|
When CIAgreement and CIRequired both
= true in the request, the Commercial Invoice image is returned. Will still
return an empty response tag when request indicates an image is requested. |
base64Binary |
minLength=0
|
eVSGXGGetLabelResponse / CIImagePage2 |
Required
|
When CIAgreement and CIRequired both
= true in the request, the Commercial Invoice image is returned. Will still
return an empty response tag when request indicates an image is requested. |
base64Binary |
minLength=0
|
eVSGXGGetLabelResponse / CIImagePage3 |
Required
|
When CIAgreement and CIRequired both
= true in the request, the Commercial Invoice image is returned. Will still
return an empty response tag when request indicates an image is requested. |
base64Binary |
minLength=0
|
eVSGXGGetLabelResponse / CIImagePage4 |
Required
|
When CIAgreement and CIRequired both
= true in the request, the Commercial Invoice image is returned. Will still
return an empty response tag when request indicates an image is requested. |
base64Binary |
minLength=0
|
eVSGXGGetLabelResponse / InsuranceFee |
Optional
|
Insurance
fee as calculated from the InsuredValue in GXGGetLabelRequest |
Decimal |
minExclusive=0.0
|
eVSGXGGetLabelResponse / DimensionalWeight |
Required |
|
String |
|
eVSGXGGetLabelResponse / LogMessage |
Optional |
A text
message for integrators of this 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. |
String |
|
eVSGXGGetLabelResponse / RemainingBarcodes |
Required |
This
contains the number of remaining barcodes that can be generated for this particular request. |
String |
|
eVSGXGGetLabelResponse |
Required
|
|
(Alias)
|
|
Response:
eVSGXGGetLabel <eVSGXGGetLabelResponse> |
<Postage>68.37</Postage> |
<CommodityGuarantee> |
<CommodityType>W</CommodityType> |
<GuaranteeDate>03/09/2015</GuaranteeDate> |
</CommodityGuarantee> |
<Insurance></Insurance> |
<USPSBarcodeNumber>8399055744</USPSBarcodeNumber> |
<FedExBarcodeNumber>898399055744</FedExBarcodeNumber> |
<LabelImage></LabelImage> |
<LabelImagePage2></LabelImagePage2> |
<LabelImagePage3></LabelImagePage3> |
<LabelImagePage4></LabelImagePage4> |
<CIImage></CIImage> |
<CIImagePage2></CIImagePage2> |
<CIImagePage3></CIImagePage3> |
<CIImagePage4></CIImagePage4> |
<InsuranceFee>0.00</InsuranceFee> |
<DimensionalWeight>4</DimensionalWeight> |
<LogMessage></LogMessage> |
<RemainingBarcodes>1202< RemainingBarcodes> |
The eVS International Cancel request allows an eVS label to be removed from processing if the request is
made prior to 11:59 PM Central Time on the day of label creation.
Scheme |
Host |
Path |
API |
XML |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSICancel |
&XML=(see
Tag Descriptions below) |
https:// |
secure.shippingapis.com |
/ShippingAPI.dll? |
API=eVSICancelCertify |
&XML=(see
Tag Descriptions below) |
Tag
Name |
Occurs |
Description |
Type |
Validation |
eVSICancelRequest |
Required
|
|
(Group)
|
|
eVSICancelRequest / USERID |
Required |
This attribute specifies your Web Tools user ID. See the Developer's Guide for information on obtaining your USERID. For Example: USERID="XXXXXXX" |
NMTOKEN |
|
eVSICancelRequest / PASSWORD |
Required |
This attribute specifies your Web Tools password. See the Developer's Guide for information on your Password. For Example: PASSWORD="XXXXXXX" |
NMTOKEN |
|
eVSICancelRequest
/ BarcodeNumber |
Required |
BarcodeNumber
of original label. Length
of 22, 30 or 34 numbers. Note: The eVSICancel API can contain only one package barcode in a single
request. |
|
|
eVSICancelRequest |
Required |
|
|
|
<eVSICancelRequest USERID="XXXXXXXXX"
PASSWORD="XXXXXXXXX"> <BarcodeNumber>1234567890</BarcodeNumber> </eVSICancelRequest> |
Tag Name |
Occurs |
Description |
Type |
Validation |
eVSICancelResponse |
Required
|
|
(Alias)
|
|
eVSICancelResponse / BarcodeNumber |
Required |
Returned
in the eVS Label Request Length
of 22, 30 or 34 numbers. |
|
|
eVSICancelResponse / Status |
Required
|
Success
or Failure Indicator |
String |
“Cancelled” “Not
Cancelled” |
eVSICancelResponse / Reason |
Required
|
|
String |
“Order
Cancelled Successfully” “Order
Already Cancelled” “Order
Not Found” |
eVSICancelResponse |
Required |
|
(Alias)
|
|
|
Country |
Code |
Abu
Dhabi |
AE |
Admiralty
Islands (Papua New guinea) |
PG |
Afghanistan |
AF |
Aitutaki,
Cook Islands (New Zealand) |
NZ |
Ajman
(United Arab Emirates) |
AE |
Aland
Island (Finland) |
FI |
Albania |
AL |
Alberta
(Canada) |
CA |
Alderney
(Channel Islands) (Great Britain and Northern Ireland) |
GB |
Algeria |
DZ |
Alhucemas
(Spain) |
ES |
Alofi
Island (New Caledonia) |
NC |
American
Samoa, United States |
AS |
Andaman
Islands (India) |
IN |
Andorra |
AD |
Angola |
AO |
Anguilla |
AI |
Anjouan
(Comoros) |
KM |
Annobon Island
(Equatorial Guinea) |
GQ |
Antigua (Antigua
and Barbuda) |
AG |
Argentina |
AR |
Armenia |
AM |
Aruba |
AO |
Ascension |
SH |
Astypalaia
(Greece) |
GR |
Atafu
(Samoa) |
WS |
Atiu,
Cook Islands (New Zealand) |
CK |
Australia |
AU |
Austria |
AT |
Avarua
(New Zealand) |
NZ |
Azerbaijan |
AZ |
Azores
(Portugal) |
PT |
Bahamas |
BS |
Bahrain |
BH |
Balearic
Islands (Spain) |
ES |
Balochistan
(Pakistan) |
PK |
Bangladesh |
BD |
Banks
Island (Vanuatu) |
VU |
Barbados |
BB |
Barduda
(Antigua and Barbuda) |
AG |
Barthelemy
(Guadeloupe) |
BL |
Belarus |
BY |
Belgium |
BE |
Belize |
BZ |
Benin |
BJ |
Bermuda |
BM |
Bhutan |
BT |
Bismark
Archipelago (Papua New Guinea) |
PG |
Bolivia |
BO |
Bonaire,
Sint Eustatius and Saba |
BQ |
Bora
Bora (French Polynesia) |
PF |
Borneo
(Indonesia) |
ID |
Botswana |
BW |
Bougainville
(Papua New Guinea) |
PG |
Bourbon
(Reunion) |
RE |
Brazil |
BR |
CA |
|
GY |
|
VG |
|
Brunei
Darussalam |
BN |
Buka
(Papua New Guinea) |
PG |
Bulgaria |
BG |
Burkina
Faso |
BF |
Burundi |
BI |
Caicos Islands(Turks and Caicos Islands) |
TC |
Cambodia |
KH |
Cameroon |
CM |
Canada |
CA |
Canary
Islands (Spain) |
ES |
Canton
Island (Kiribati) |
KI |
Cape
Verde |
CV |
Cayman
Islands |
KY |
Central
African Republic |
CF |
ES |
|
LK |
|
Chad |
TD |
Chaferinas
Islands (Spain) |
ES |
Chalki (Greece) |
GR |
Channel
Islands (Jersey, Guemsey, Alderney and Sark) (Great
Britain and Norther Ireland) |
JE |
Chile |
CL |
China |
CN |
Christmas
Island (Australia) |
AU |
Christmas
Island (Kiribati) |
KI |
Cocos
(Keeling) Islands |
CC |
Colombia |
CO |
Comoros |
KM |
Congo,
the Democratic Republic of the |
CD |
Congo |
CG |
Cook
Islands |
CK |
Corisco Island
(Equatorial Guinea) |
GQ |
Corsica
(France) |
FR |
Costa
Rica |
CR |
Cote dIvoire |
CI |
Crete
(Greece) |
GR |
Croatia |
HR |
Cuba |
CU |
Cumino Island
(Malta) |
MT |
Curacao |
CW |
Cyjrenaica
(Libya) |
LY |
Cyprus |
CY |
Czech
Republic |
CZ |
Dahomey
(Benin) |
BN |
Damao
(India) |
IN |
Danger
Islands (New Zealand) |
NZ |
Denmark |
DK |
Desirade Island
(Guadeloupe) |
GP |
Diu
(India) |
IN |
Djibouti |
DJ |
Dodecanese
Islands (Greece) |
GR |
Doha
(Qatar) |
QA |
Dominica |
DM |
Dominican
Republic |
DO |
Dubai
(United Arab Emirates) |
AE |
East
Timor (Timor-Leste) |
TL |
Ecuador |
EC |
Egypt |
EG |
Eire
(Ireland) |
IE |
El
Salvador |
SV |
Ellice
Islands (Tuvalu) |
TV |
Elobey Islands
(Equatorial Guinea) |
GQ |
Enderbury
Island (Kirbati) |
KI |
England
(Great Britain and Northern Ireland) |
GB |
Equatorial
Guinea |
GQ |
Eritrea |
ER |
Ethiopia |
ET |
Estonia |
EE |
Fakaofo
(Samoa) |
WS |
Falkland
Islands (Malvinas) |
FK |
Fanning
Island (Kiribati) |
KI |
Faroe
Islands |
FO |
Femando Po
(Equatorial Guinea) |
GQ |
Fiji |
FJ |
Fezzan
(Libya) |
LY |
Finland |
FI |
Fomosa
(Taiwan) |
TW |
France |
FR |
French
Guiana |
GF |
PF |
|
PF |
|
GP |
|
MQ |
|
TO |
|
AE |
|
WF |
|
Gabon |
GA |
Gambia |
GM |
PF |
|
Georgia |
GE |
Germany |
DE |
Ghana |
GH |
Gibaltar |
GI |
KI |
|
IN |
|
Gozo
Island (Malta) |
MT |
KM |
|
GB |
|
Greece |
GR |
Greenland |
GL |
GD |
|
VC |
|
GP |
|
GT |
|
Guernsey (Channel Islands) (Great Britain and |
GG |
GN |
|
GW |
|
GY |
|
CN |
|
Haiti |
HT |
JO |
|
NZ |
|
PF |
|
NL |
|
HN |
|
Hong
Kong |
HK |
HM |
|
HN |
|
Hungary |
HU |
Iceland |
IS |
India |
IN |
Indonesia |
ID |
Iran |
IR |
ID |
|
Isle of
Man |
IM |
NC |
|
CU |
|
Israel |
IL |
Issas
(Djibouti) |
DJ |
Italy |
IT |
CI |
|
Iraq |
IQ |
Jersey |
JE |
Jamaica |
JM |
Jordan |
JO |
Johore
(Malaysia) |
MY |
Japan |
JP |
Kalymnos
(Greece) |
GR |
Kampuchea
(Cambodia) |
CO |
Karpathos
(Greece) |
GR |
Kassos (Greece) |
GR |
Kazakhstan |
KZ |
Kedah
(Malaysia) |
MY |
Keeling
Islands (Australia) |
AU |
Kelantan
(Malaysia) |
MY |
Kenya |
KE |
Kiribati |
KI |
Korea,
Democratic People’s Republic of |
KP |
Korea,
Republic of |
KR |
Kos (Greece) |
GR |
Kosovo,
Republic of |
RS |
Kowloon
(Hong Kong) |
HK |
Kuwait |
KW |
Kyrgyzstan |
KG |
Labrador
(Canada) |
CA |
Laos
People’s democratic Republic |
LA |
Latvia |
LV |
Labuan
(Malaysia) |
MY |
Lebanon |
LB |
Leipsos
(Greece) |
GR |
Leros
(Greece) |
GR |
Les
Saints Island (Guadeloupe) |
GP |
Liberia |
LR |
Lesotho |
LS |
Libya |
LY |
Liechtenstein |
LI |
Lithuania |
LT |
Lord
Howe Island (Austrailia) |
AU |
Loyalty
Islands (New Caledonia) |
NC |
Luxembourg |
LU |
Macao |
MO |
Macau
(Macao) |
MO |
Macedonia,
the former Yugoslav Republic of |
MK |
Madagascar |
MG |
Madeira
Islands (Portugal) |
PT |
Malacca
(Malaysia) |
MY |
Malawi |
MW |
Malaysia |
MY |
Maldives |
MV |
Mali |
ML |
Malta |
MT |
Manahiki (New
Zealand) |
NZ |
Manchuria
(China) |
CN |
Manitoba
(Canada) |
CA |
Marie
Galante (Guadeloupe) |
GP |
Marquesas
Islands (French Polynesia) |
PF |
Martinique |
MQ |
Mauritania |
MR |
Mauritius |
MU |
Mayotte
(France) |
FR |
Melilla
(Spain) |
ES |
Mexico |
MX |
PM |
|
KM |
|
Moldova,
Republic of |
MD |
Monaco |
MC |
Mongolia |
MN |
Montenegro |
ME |
Montserrat |
MS |
Moorea
(French Polynesia) |
PF |
Morocco |
MA |
Mozambique |
MZ |
Muscat
(Oman) |
OM |
Myanmar
(Burma) |
MM |
Namibia |
NA |
Nansil Islands
(Japan) |
JP |
Nauru |
NR |
Negri
Sembilan (Malaysia) |
MY |
Nepal |
NP |
Netherlands |
NL |
Nevis
(Saint Kitts and Nevis) |
KN |
New Britain
(Papua New guinea) |
PG |
New
Brunswick (Canada) |
CA |
New
Caledonia |
NC |
New
Hanover (Paoua New Guinea) |
PG |
New
Hebrides (Vanuatu) |
VU |
PG |
|
AU |
|
New
Zealand |
NZ |
CA |
|
Nicaragua |
NI |
Niger |
NE |
Nigeria |
NG |
Nissiros
(Greece) |
GR |
Niue |
NU |
Norfolk
Island |
NF |
North
Borneo (Malaysia) |
MY |
North
Korea |
KP |
GB |
|
CA |
|
Norway |
NO |
Nova
Scotia (Canada) |
CA |
Nukahiva (French Polynesia) |
PF |
Nukunonu
(Samoa) |
WS |
Ocean
Island (Kirbati) |
KI |
JP |
|
Ontario
(Canada) |
CA |
Oman |
OM |
PK |
|
NZ |
|
Panama |
PA |
Papua
New Guinea |
PG |
Paraguay |
PY |
NZ |
|
GR |
|
TZ |
|
MY |
|
TW |
|
ES |
|
Penrhyn, Tongareva (New
Zealand) |
NZ |
MY |
|
MY |
|
IR |
|
Peru |
PE |
TW |
|
GP |
|
Philippines |
PH |
Poland |
PL |
Pitcaim |
PN |
Puerto
Rico |
PR |
Prince
Edward Island (Canada) |
CA |
Portugal |
PT |
Pukapuka (New Zeland) |
NZ |
Qatar |
QA |
Qubec (Canada) |
CA |
Queensland
(Australia) |
AU |
Quemoy
(Taiwan) |
TW |
Raiatea
(French Polynesia) |
PF |
Rakaanga (New
Zealand) |
NZ |
NZ |
|
Ras al Kaimah
(United Arab Emirates) |
AE |
AG |
|
Reunion |
RE |
GN |
|
GR |
|
MU |
|
Romania |
RO |
RW |
|
Russian
Federation |
RU |
Rwanda |
RW |
SA |
|
MY |
|
BL |
|
BL |
|
SH |
|
KN |
|
LC |
|
MF |
|
PM |
|
VC |
|
MG |
|
SV |
|
WS |
|
SM |
|
SB |
|
ST |
|
MY |
|
GB |
|
CA |
|
Saudi
Arabia |
SA |
NZ |
|
WS |
|
GB |
|
MY |
|
MY |
|
SN |
|
RS |
|
SC |
|
AE |
|
JP |
|
SL |
|
IN |
|
SG |
|
SE |
|
Solomon
Islands |
SB |
Seychelles |
SC |
Sudan |
SD |
Sweden |
SE |
Singapore |
SG |
Saint
Helena, Ascension and Tristan da Cunha |
SH |
Sint
Maarten |
SX |
Slovakia |
SK |
SI |
|
PF |
|
SB |
|
SN |
|
Somalia |
SO |
SO |
|
ZA |
|
AU |
|
FK |
|
KR |
|
ES |
|
NO |
|
LK |
|
SD |
|
SR |
|
NZ |
|
Swan Islands
(Honduras) |
HN |
SZ |
|
SE |
|
GR |
|
SY |
|
Swaziland |
SZ |
Symi (Greece) |
GR |
Syrian
Arab Republic (Syria) |
SY |
PF |
|
PF |
|
Taiwan,
Province of China |
TW |
Tajikistan |
TJ |
TZ |
|
AU |
|
TD |
|
Thailand |
TH |
AU |
|
CN |
|
CR |
|
ID |
|
TL |
|
Trinidad
and Tobago |
TT |
Togo |
TG |
Tokelau |
TK |
Tonga |
TO |
NZ |
|
JP |
|
VU |
|
JO |
|
ZA |
|
MY |
|
LY |
|
TA |
|
AE |
|
PF |
|
PF |
|
TN |
|
TM |
|
TC |
|
Türkiye |
TR |
Tuvalu |
TV |
Ukraine |
UA |
Uganda |
UG |
Umm al Quaiwain
(United Arab Emirates) |
AE |
QA |
|
AE |
|
GB |
|
WS |
|
United
States of America |
US |
Uruguay |
UY |
Uzbekistan |
UZ |
VA |
|
Venezuela,
Bolivarian Republic of |
VE |
AU |
|
Viet
Nam |
VN |
VG |
|
GB |
|
Vanuatu |
VU |
Wallis
and Futuna |
WF |
MY |
|
PG |
|
AU |
|
Yemen |
YE |
CA |
|
SB |
|
Zambia |
ZM |
TZ |
|
Zimbabwe |
ZW |
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 |
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 |
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 |
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 |
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 |
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 |
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 |