eVS Label

 

 

USPS Web Tools™

Application Programming Interface

用户指南

Version 4.15 (01/05/2024)

 

 

 

Logo Description automatically generated

 

 


 

目录

1.0       Introduction. 3

1.1       Before you get started: 3

2.0       eVS Label API 3

2.1       Overview.. 3

2.1.1     API Signature. 4

2.2       Request Descriptions. 4

2.2.1     Sample Request 35

2.3       Response Descriptions. 45

2.3.1     Sample Response. 50

3.0       eVS Cancel API 53

3.1       Overview.. 53

3.1.1     API Signature. 53

3.2       Request Descriptions. 53

3.2.1     Sample Request 53

3.3       Response Descriptions. 54

3.3.1     Sample Response. 54

4.0       Appendices. 54

4.1       Appendix A. 54

4.1.1     Priority Mail Express Label 55

4.1.2     Priority Mail Label 56

4.1.3     Ground Advantage Label 57

4.1.4     Library Mail Label 58

4.1.5     Media Mail Label 59

4.1.6     BPM Label 60

4.1.7     Priority Mail Cubic Label 61

4.1.8     Priority Mail Domestic Integrated Customs Form.. 62

4.1.9     Parcel Select Destination Entry. 63

4.1.10   Parcel Locker 64

4.2       Appendix B - Special Situations. 65

4.2.1     GDE Customers. 65

4.2.2     Shipping to a Parcel Locker 65

4.3       Appendix C - Parcel Select Service Combinations. 66

4.4       Appendix D - Categories for International Shipping Regulatory Mandates. 67

 


 

1.0        Introduction

This document contains a Reference Guide to the eVS Label API. See the Developers Guide to learn the administrative process for gaining access to the Web Tools APIs as well as the basic mechanism for calling the APIs and processing the results. The Developer’s Guide also contains information on testing and troubleshooting.

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

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

<ZipDestination>12345</ZipDestination>

In this instance, you will replace “12345” with the destination ZIP Code for the domestic-bound package.

For label specifications such as package dimensions, delivery information, etc., please refer to the Domestic Mail Manual (DMM) at http://pe.usps.com/.

For information specific to domestic mail pieces sent to an Army Post Office (APO), Fleet Post Office (FPOs), and or Diplomatic Post Offices (DPO) see the DMM at http://pe.usps.com/text/dmm300/703.htm and http://pe.usps.com/text/dmm300/608.htm.

1.1     Before you get started:

Whether you are a new or existing mailer, USPS strongly suggests a conversation with you to discuss your business requirements so your account will be properly configured. To initiate this conversation please contact the National Customer Support Center (NCSC) at 877-264-9693 Option 4 and request a referral to an Operations Integration Specialist (OIS) and Technical Integration Specialist (TIS). USPS will align the appropriate team to assist with swift onboarding.

Depending on your needs, your account may be configured in many flexible ways; however, each account will be configured with credentials in a master/child relationship. Minimally, credentials will be established as follows:

·        A master Mailer ID is created

o   Child Mailer IDs are created for each origin site and may be created as needed by the requirements of your business units and brands.

·        A permit number is created

o   Additional permit numbers may be created as needed by the requirements of your business units and brands

·        A CAPS Debit account is created for payment processing

o   Additional CAPS Debit accounts may be created as needed

Your Operations Integration Specialist and Technical Integration Specialist will be involved at the local and national levels to ensure successful launch and introduction to appropriate production support teams.

2.0        eVS Label API

2.1     Overview

The only option for creating outbound shipping labels through our APIs requires eVS setup/enrollment. In general, eVS:

·        Requires 50 pieces or 50 pounds per mailing

·        Requires a permit imprint

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

·        Handles origin entered mail

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

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

·        Supports Priority Mail Cubic and Ground Advantage Cubic (Contact your Technical Integration Specialist for further details)

·        Supports Parcel Select Destination Entry (PSDE) label creation

·        Supports Global Direct Entry (GDE)

 

eVS, or Electronic Verification System, allows high-volume package mailers and package consolidators to document and pay postage, including special service fees, using electronic manifest files. The files are transmitted over the Internet to a Postal Service™ database.

If you want to explore using eVS, please first contact the eVS@usps.gov.

 

For registration please visit: https://zh.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.

 

2.1.1     API Signature

Scheme

Host

小道

API

XML

https://

secure.shippingapis.com

/ShippingAPI.dll?

API=eVS

&XML=(see below)

https://

secure.shippingapis.com

/ShippingAPI.dll?

API=eVSCertify

&XML=(see below)

备注: The “eVSCertify” API signature is for testing purposes and will not generate usable labels and barcodes.

2.2     Request Descriptions

Tag Name

Occurs

描述

类型

Validation

eVSRequest

需要

API=eVS

(Group)

 

eVSRequest / USERID

需要

This attribute specifies your Web Tools user ID. See the Developer's Guide for information on obtaining your USERID.

例如:USERID="XXXXXXX"

NMTOKEN

 

eVSRequest / PASSWORD

需要

This attribute specifies your Web Tools password. See the Developer's Guide for information on your Password.

例如:PASSWORD="XXXXXXX"

NMTOKEN

 

eVSRequest / Option

Optional

For future use.

Empty

 

eVSRequest/ Revision

Optional

Used to indicate API version. Use a value of “2” or above to return a shortened IMpb barcode in the <TrackingNumber> tag.

Use a value of “3” to return a new ServiceType attribute in the <Postage> response tag that echoes the <ServiceType> used to price and generate the label.

例如:<Revision>3</Revision>

String

 

eVSRequest/ ImageParameters

Optional

 

(group)

 

eVSRequest/ ImageParameters/ ImageParameter

Optional

Returns alternate label image.

·     BARCODE ONLY- label option returns a barcode and Package ID Code (PIC) number without the return and delivery name and address. No label image is returned.

·     CROP - reduces the image size to half-sheet (approximately), instructions sheet will be returned, and label image will return as a landscape orientation

·     4X6LABELL- Label image will return as a Landscape – True size 4 inches vertical by 6 inches horizontal (image rotated 90 degrees from “4X6LABELP” orientation, not returned on an 8.5 x 11 background page)

·     6X4Label – Label image will be returned as traditional landscape orientation with the horizontal dimension longer than the vertical dimension (6 inches horizontal by 4 inches vertical)

·     4X6LABEL – Label image will be returned as a Portrait orientation with the vertical dimension longer than the horizontal dimension (4 inches horizontal by 6 inches vertical)

·     4X6LABELP – Label image with be returned as a Portrait – True size 4 inches horizontal orientation by 6 inches vertical (not returned on an 8.5 x 11 background page)

·     4X6ZPL203DPI - (ZPL - Zebra Programming Language) format. When using this enumeration, <ImageType> is required - this tag cannot be left blank. Integrators should use either “TIF” or “PDF” for ZPL – neither value will impact the label image itself, but it must be included in the request to return a successful response.

·     4X6ZPL300DPI – Prints a label formatted for ZPL printers in 300 dpi. When using this enumeration, <ImageType> is required - this tag cannot be left blank. Integrators should use either “TIF” or “PDF” for ZPL – neither value will impact the label image itself, but it must be included in the request to return a successful response.

·     SEPARATECONTINUEPAGE – will force the continuation page (if the item count causes the need for a continuation page) onto a separate page. This allows for two images to return, one label image and one continuation page

例如:<ImageParameter>4X6LABEL</ImageParameter>

String

Default=4X6LABEL

 

Enumerations=

·  BARCODE ONLY

·  CROP

·  4X6LABEL

·  4X6LABELL

·  6X4LABEL

·  4X6LABELP

·  4X6LABELP PAGE

·  4X6ZPL203DPI

·  4X6ZPL300DPI

·  SEPARATECONTINUEPAGE

eVSRequest/ ImageParameters/ XCoordinate

Optional

Value of the horizontal coordinate where the upper left corner of the label is placed. Combination of X and Y Coordinates will be validated to fit on the page.

 

For example:< XCoordinate>200</ XCoordinate>

Integer

minValue=0

maxValue=900

default=500 (centered)

eVSRequest/ ImageParameters/ YCoordinate

Optional

Value of the vertical coordinate where the upper left corner of the label is placed. Combination of X and Y Coordinates will be validated to fit on the page.

 

For example:<YCoordinate>250</ YCoordinate>

Integer

minValue=0

maxValue=1000

default=450 (centered)

eVSRequest /  ImageParameters/  LabelSequence

Optional

To be used in the case of multiple packages.   Not Required only one package.

String

minOccurs="0" maxOccurs="1"

eVSRequest /  ImageParameters/  LabelSequence / PackageNumber

需要

Required if <LabelSequence> is selected

Integer

minInclusive value = "1"

maxInclusive value = "999"

eVSRequest /  ImageParameters /  LabelSequence/  TotalPackages

需要

Required if <LabelSequence> is selected

Integer

minInclusive value = "1"

maxInclusive value = "999"

eVSRequest/ FromName

需要

Values for either First and Last Name of Sender or Firm must be sent.

例如:<FromName>AA BB</FromName>

 

备注: If a domestic integrated customs form is required based on Customs Content Type and Weight, then FromName must be used with at least 2 names with a minimum of 2 alpha characters A-Z each.

String

minLength=0

maxLength=100

eVSRequest/ FromFirm

需要

Values for either First and Last Name of Sender or Firm must be sent.

例如:<FromFirm>USPS</FromFirm>

 

注意: If a domestic integrated customs form is required based on Customs Content Type and Weight, FromFirm must be used with at least 2 characters, or else an error will return.

 

注意: Maximum length printed on the label is 32 characters for all <ServiceType> enumerations. Values exceeding 32 characters will be truncated due to space limitations on the label. API request eligible to accept up to 50 characters.

String

minLength=0
maxLength=50

eVSRequest/ FromAddress1

Optional

From address line 1. Use this field for secondary address information such as an apartment or suite number if applicable. 

例如:<ToAddress1> Suite 4D </ToAddress1>

 

注意:When populating the address fields, do not include additional information such as building name or company.

String

minLength=0
maxLength=50

eVSRequest/ FromAddress2

需要

From address line 2. Use this field for a primary street address.

例如:<ToAddress2>1234 MAIN ST</ ToAddress2>

 

注意: When populating the address fields, do not include additional information such as building name or company.

String

minLength=1
maxLength=50

eVSRequest/ FromCity

需要

From city.


例如:<FromCity>BETHESDA</ FromCity>

String

minLength=1
maxLength=28

eVSRequest/ FromState

需要

From state. Value should be passed as two-letter state abbreviation.


例如:<FromState>MD</FromState>

String

minLength=2
maxLength=2

eVSRequest/ FromZip5

需要

From ZIP code.


例如:<FromZip5>20212</FromZip5>

String

pattern=\d{5}

eVSRequest/ FromZip4

Optional

From ZIP+4 extension.


例如:<FromZip4>2402</FromZip4>

String

minLength=0
pattern=\d{4}

eVSRequest/ FromPhone

Optional

From Phone #. 10 digits required (including area code), with no punctuation.

例如:<FromPhone>2125551234</ FromPhone>

 

注意: This field is used to return on the receipt and label only when <ServiceType>= “PRIORITY EXPRESS”.

String

pattern=\d{10}

eVSRequest/ POZipCode

Optional

ZIP Code of Post Office or collection box where item is mailed. May be different than FromZip5. This tag will take precedence over FromZip5 when provided. Will be used to populate the SSFv2.0 H1 pos. 7 Entry Facility ZIP Code field.

 

例如:<POZipCode>20770</ POZipCode>

 

说明:Required when <ServiceType>= “PARCEL SELECT DE”

String

minLength=0
maxLength=5

eVSRequest/ AllowNonCleansedOriginAddr

Optional

Allows Non-Validated Origin Street Address. Enter “true” to bypass street address validation failures/errors or “false” if only validated addresses should be allowed.

例如:<AllowNonCleansedOriginAddr>True

</ AllowNonCleansedOriginAddr>

 

注意: Integrators are recommended to always use “false” to ensure no delivery issues. In the event USPS cannot validate the street address, this tag will “bypass” address validation error when “true” is indicated to allow label creation which could impact delivery. The <AllowNonCleansedOriginAddr> excludes City, State, and ZIP Code which must be valid for a successful response. Reference https://pe.usps.com/text/pub28/28c2_001.htm.

Boolean

Default=False

Enumerations=

·  True

·  False

 

eVSRequest/ ToName

需要

Values for either First and Last Name of Recipient or Firm must be sent.

 

例如:<ToName>Smith</ ToName>

 

注意:If a domestic integrated customs form is required based on Customs Content Type and Weight, then ToName must be used with at least 2 names with a minimum of 2 alpha characters A-Z each.

String

minLength=0
maxLength=100

eVSRequest/ ToFirm

需要

Values for either First and Last Name of Recipient or Firm must be sent.

例如:<ToFirm>ABC CORPORATION</ ToFirm>

 

注意: Maximum length printed on the label is 28 characters for all <ServiceType> enumerations. Values exceeding 28 characters will be truncated due to space limitations on the label. API request eligible to accept up to 50 characters.

String

minLength=0
maxLength=50

eVSRequest/ ToAddress1

Optional

Recipient address line 1. Use this field for secondary address information such as an apartment or suite number if applicable. 

例如:<ToAddress1> Suite 4D </ToAddress1>

 

注意: When populating the address fields, do not include additional information such as building name or company.

 

注意:Destination address ignored when <ParcelLocker>=“true”. When shipping to a Parcel Locker the <FacilityID> tag is required and used to determine destination address.

String

minLength=0
maxLength=50

eVSRequest/ ToAddress2

需要

Recipient address line 2. Use this field for a primary street address.

例如:<ToAddress2>1234 MAIN ST</ ToAddress2>

 

注意: When populating the address fields, do not include additional information such as building name or company. 

 

注意:Destination address ignored when <ParcelLocker>=“true”. When shipping to a Parcel Locker the <FacilityID> tag is required and used to determine destination address.

String

minLength=1
maxLength=50

eVSRequest/ ToCity

需要

Recipient city.

 

例如:<ToCity>ANYTOWN</ ToCity>

 

注意:Destination address ignored when <ParcelLocker>=“true”. When shipping to a Parcel Locker the <FacilityID> tag is required and used to determine destination address.

String

minLength=0
maxLength=28

eVSRequest/ ToState

需要

Recipient state.

 

例如:<ToState>MN</ ToState>

 

注意:Destination address ignored when <ParcelLocker>=“true”. When shipping to a Parcel Locker the <FacilityID> tag is required and used to determine destination address.

String

minLength=0
pattern=\w{2}

eVSRequest/ ToZip5

需要

Recipient ZIP code.

 

例如:<ToZip5>12345</ ToZip5>

 

注意:Destination address ignored when <ParcelLocker>=“true”. When shipping to a Parcel Locker the <FacilityID> tag is required and used to determine destination address.

String

minLength=0
pattern=\d{5}

eVSRequest/ ToZip4

Optional

Recipient ZIP+4 extension.

 

例如:<ToZip4>1844</ToZip4>

 

注意:Destination address ignored when <ParcelLocker>=“true”. When shipping to a Parcel Locker the <FacilityID> tag is required and used to determine destination address.

String

minLength=0
pattern=\d{4}

eVSRequest/ ToPhone

Optional

Recipient Phone #. If value is entered, 10 digits are required (including area code), with no punctuation.

例如:<ToPhone>2125551234</ ToPhone>

 

注意: This field is used to return on the receipt only when <ServiceType>=“PRIORITY EXPRESS”.

String

pattern=\d{10}

eVSRequest/ POBox

Optional

Indicates if destination address is a PO Box.

 

例如:<POBox>True</ POBox>

Boolean

Default=False

Enumerations=

·  True

·  False

eVSRequest/ ToContactPreference

Optional

This indicates how the recipient will be notified that the package is available for pickup. Specify WAIVED if notification is not desired.

例如:<ToContactPreference>EMAIL</ ToContactPreference>

 

注意: Required when <ParcelLocker>=“true”; only “EMAIL” or “EMAILSMS” values permitted.

String

whitespace=collapse

Enumerations=

·  EMAIL

·  EMAILSMS

·  SMS

·  WAIVED

eVSRequest/ ToContactMessaging

Optional

This contains a text messaging address or is blank depending on the ToContactPreference tag. If the EMAILSMS or SMS enumeration is used in ToContactPreference, this value must be a syntactically valid email address. If EMAIL or WAIVED is used, this value must be blank.

例如:<ToContactMessaging>user@example.com</ ToContactMessaging>

String

maxLength=64

whitespace=collapse

pattern=\w{0}

pattern=([\w_\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4}

eVSRequest/ ToContactEMail

Optional

This contains an email address or is blank depending on the ToContactPreference tag. If the EMAILSMS or EMAIL enumeration is used in ToContactPreference, this value must be a syntactically valid email address. If SMS or WAIVED is used, this value must be blank.

例如: <ToContactEMail>John.Smith@example.com </ ToContactEMail>

 

注意: Required when <ParcelLocker>=“true”

String

minLength=0
pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4}

eVSRequest/ AllowNonCleansedDestAddr

Optional

Allows Non-Validated Destination Street Address. Enter “true” to bypass street address validation failures/errors or “false” if only validated addresses should be allowed.

例如:<AllowNonCleansedDestAddr>true</AllowNonCleansedDestAddr>

 

注意: Integrators are recommended to always use “false” to ensure no delivery issues. In the event USPS cannot validate the street address, this tag will “bypass” address validation error when “true” is indicated to allow label creation which could impact delivery. The <AllowNonCleansedDestAddr> excludes City, State, and ZIP Code which must be valid for a successful response. Reference https://pe.usps.com/text/pub28/28c2_001.htm.

 

注意: Not applicable when shipping to a Parcel Locker.  

Boolean

Default=False

Enumerations=

·  True

·  False

 

eVSRequest/ WeightInOunces

需要

包裹重量。Items must weigh 70 pounds (1120 ounces) or less.

 

例如:<WeightInOunces>80</ WeightInOunces>

String

pattern=\d{0,4}

 

eVSRequest/ ServiceType

需要

Mail service type desired. 例如:<ServiceType>PRIORITY</ServiceType> 

 

注意: For Priority Mail Cubic and Ground Advantage Cubic, the following is required:

·        <ServiceType> must equal “PRIORITY MAIL CUBIC” or “GROUND ADVANTAGE CUBIC”

·        <Container> must equal “CUBIC PARCELS” or “CUBIC SOFT PACK”

·        <PriceOptions> can equal “Commercial Plus” or “Commerical Base

It is recommended to pass the largest Cubic dimension as “Length” in <Length> request tag and the second largest dimension as “Width” in <Width> request tag.

 

注意: When <ServiceType>=“PARCEL SELECT DE”:

·       Additional permissions are required during setup otherwise an error will return. Contact your TIS representative for details.

·       <POZipCode> request tag will be required to collect Destination Entry Facility ZIP Code and populate SSFv2.0 H1 pos. 7 Entry Facility ZIP Code field.

·       <OptOutOfSPE> must equal “false” or an error will return.

String

Enumerations=

·  PRIORITY EXPRESS

·  PRIORITY

·  PRIORITY MAIL CUBIC

·  GROUND ADVANTAGE

·  GROUND ADVANTAGE CUBIC

·  LIBRARY

·  MEDIA

·  BPM

·  PARCEL SELECT DE

eVSRequest/ Container

Optional

Use to specify USPS containers/packaging or container attributes that may affect postage. If null value is supplied, then default container will be “VARIABLE”.

 

例如:<Container>统一邮资信封</Container> 

 

 

String

whitespace=collapse

Default=VARIABLE

Enumerations=

·  VARIABLE

·  FLAT RATE ENVELOPE

·  LEGAL FLAT RATE ENVELOPE

·  PADDED FLAT RATE ENVELOPE

·  GIFT CARD FLAT RATE ENVELOPE

·  SM FLAT RATE ENVELOPE

·  WINDOW FLAT RATE ENVELOPE

·  SM FLAT RATE BOX

·  MD FLAT RATE BOX

·  LG FLAT RATE BOX

·  PACKAGE SERVICE

·  CUBIC PARCELS

·  CUBIC SOFT PACK

eVSRequest/ Width

Optional

Value must be numeric. Units are inches. If 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 only for a non-rectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for non-rectangular packages.

 

For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm

Decimal

minExclusive=0.0
totalDigits=10

eVSRequest/ 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 only for a non-rectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for non-rectangular packages.

 

For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm

Decimal

minExclusive=0.0
totalDigits=10

eVSRequest/ 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 only for a non-rectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for non-rectangular packages.

 

For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm

Decimal

minExclusive=0.0
totalDigits=10

eVSRequest / 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 only for a non-rectangular package in addition to Length, Width, Height when any dimension of the package exceeds 12 inches. For rectangular packages, the Girth dimension must be left blank as this dimension is to only be used for non-rectangular packages.

 

For more details on dimensional weight pricing or dimension validation reference DMM https://pe.usps.com/text/dmm300/index.htm

Decimal

minExclusive=0.0
totalDigits=10  

eVSRequest/ Machinable

Optional

Machinable parcels are defined as parcels less than or equal to 15”x18”x22” inches and less than or equal 25 pounds. Any parcel that exceeds either threshold (dimensions or weight) will be considered nonmachinable.

 

说明:The API will validate provided dimensions and/or weight to determine machinability. In this case the <Machinable> tag will be ignored. If these are not provided, then the <Machinable> tag will be used to designate if shipment is Machinable (True), Nonmachinable (False) or Irregular.

String

Default=True

Enumerations=

·  True

·  False

·  Irregular

eVSRequest/ PriceOptions

Optional

Indicates pricing that should be returned.

例如:<PriceOptions>Commercial Base</PriceOptions>

 

注意:When <ServiceType>=“PRIORITY MAIL CUBIC”, <PriceOptions> must equal “Commercial Plus”.

 

注意:A value of “Commercial Base” will return “Commercial” prices if applicable. Reference USPS Notice 123 Price List.

String

Default=Commercial Base

Enumerations=

·  Commercial Plus

·  Commercial Base

eVSRequest/ InsuredAmount

Optional

Use this tag for entering an insurance amount, if applicable.

例如:<InsuredAmount>100.00</InsuredAmount>

Decimal

Default=0

minInclusive=0

maxInclusive=9999.99

totalDigits=8

whitespace=collapse

eVSRequest/ AddressServiceRequested

Optional

You can request the USPS to alert you when a customer changes their address. This feature is especially useful to ensure correct billing. The words “Address Service Requested” will appear on the shipping label immediately below the return address. By using this tag, you will receive the following service with Priority Mail: For 12 months after an address change, the mail piece is forwarded at no charge. However, a separate notice of the new address is returned to you and an address correction fee is charged. For months 13-18 after an address change, the mail piece is returned with the new address attached at no charge. After 18 months, or if undeliverable, the mail piece is returned with the reason for nondelivery attached at no charge. For fees for this service with Package Services, refer to the Domestic Mail Manual.

例如:<AddressServiceRequested>True</AddressServiceRequested>

Boolean

Default=False

Enumerations=

·  True

·  False

 

eVSRequest/ ExpressMailOptions

Optional

Groups Express Mail Delivery and Signature options. Valid when <ServiceType>=“PRIORITY EXPRESS”

(group)

 

eVSRequest/ ExpressMailOptions/ DeliveryOption

Optional

Indicates desired delivery option:

 

Service Option

ServiceID

Normal Delivery (Default)

1

No Weekend Delivery

2

No Holiday Delivery

3

No Weekend or Holiday Delivery

4

No Saturday Delivery

5

No Sunday Delivery

6

Sunday Delivery

7

Holiday Delivery

8

No Sunday or Holiday Delivery

9

Scheduled End of Day

E

Scheduled End of Day No Sun/ Hol Delivery

F

Scheduled End of Day No Weekend/ Hol Delivery

G

例如:<DeliveryOption>4</ DeliveryOption>

String

whitespace=collapse

Default=1

Enumerations=

·  1

·  2

·  3

·  4

·  5

·  6

·  7

·  8

·  9

·  E

·  F

·  G

 

eVSRequest/ ExpressMailOptions/ WaiverOfSignature

Optional

No Signature Required for Delivery. Enter “True” if you do not want a signature for receipt of the package or “False” if you do.

例如:<WaiverOfSignature>False</WaiverOfSignature>

Boolean

Default=True

Enumerations=

·  True

·  False

eVSRequest/ ExpressMailOptions/eSOFAllowed

Optional

Electronic Signature On File Allowed.  This value is used to allow retailers to request that Electronic Signature On File (eSOF) be overridden such that a physical or “wet” signature is required.  This field should be populated with “False” to request that the use of eSOF be disallowed for the shipment.

例如:   <eSOFAllowed>False</eSOFAllowed>

Boolean

Default=True

Enumerations=

·  True

·  False

 

eVSRequest/ ShipDate

Optional

Date Package Will Be Mailed. Ship date may be today plus 0 to 7 days in advance. Enter the date in either format: dd-mmm-yyyy (i.e., 14-Feb-2011) or mm/dd/yyyy (i.e., 02/14/ 2011). If <ShipDate> value is not provided, the current date will be used for delivery date calculations.

例如:<ShipDate>02/14/2011</ShipDate>

String

Default=Current Date

minLength=0
pattern=\d{1,2}/ \d{1,2}/ \d\d(\d\d)?

eVSRequest/ CustomerRefNo

Optional

User-assigned Number for Internal Use. Up to 30 characters accepted but only 18 will be displayed on the shipping label image.

例如:<CustomerRefNo>XYZ 123</ CustomerRefNo>

The <CustomerRefNo> value will be used to populate the SSFv2.0 D1 pos. 21 Customer Reference Number field.

 

说明:The <PrintCustomerRefNo> must be set to “true” to be printed on the label.

String

minLength=0
maxLength=30

eVSRequest/ CustomerRefNo2

Optional

User-assigned Number for Internal Use. Up to 30 characters accepted but only 18 will be displayed on the shipping label image. Will be positioned below the <CustomerRefNo> value on the label image. The <CustomerRefNo2> value will be used to populate the SSFv2.0 D1 pos. 76 Customer Reference Number 2 field.

 

注意:Required when <ePostageMailerReporting>=“1” For example:

<CustomerRefNo2>XYZ 123</ CustomerRefNo2>

 

说明:The <PrintCustomerRefNo2> must be set to “true” to be printed on the label.

String

minLength=0
maxLength=30

eVSRequest/ ExtraServices

Optional

Groups extra services elements

(Group)

 

eVSRequest/ ExtraServices/ ExtraService

Optional, repeating up to unbounded times

Use to specify extra services.

 

Service Name

Service ID

保险

100

Insurance (PME)

101

退回收据

102

Certified Mail

105

电子退回收据

110

Return Receipt Express Mail

118

成人签名

119

成人签名受限投递

120

Insurance (PM)

125

USPS Tracking Electronic

155

Signature Confirmation Electronic

156

认证邮件受限投递

170

需要认证邮件成人签名

171

CERTIFIED MAIL 成人签名受限投递

172

Signature Confirmation Electronic Restricted Delivery

174

保险受限投递

177

Insurance Restricted Delivery (PME)

178

Insurance Restricted Delivery (PM)

179

Scan Retention

181

Scan + Signature Retention

182

HAZMAT Services

Service ID

Air Eligible Ethanol Package

810

Class 1 – Toy Propellant/Safety Fuse Package

811

Class 3 – Flammable Liquid Package

812

Class 7 – Radioactive Materials Package

813

Class 8 – Corrosive Materials Package

814

Class 8 – Nonspillable Wet Battery Package

815

Class 9 – Lithium Battery Marked – Ground Only Package

816

Class 9 – Lithium Battery – Returns Package

817

Class 9 – Lithium batteries, marked package

818

Class 9 – Dry Ice Package

819

Class 9 – Lithium batteries, unmarked package

820

Class 9 – Magnetized Materials Package

821

Division 4.1 – Flammable Solids or Safety Matches Package

822

Division 5.1 – Oxidizers Package

823

Division 5.2 – Organic Peroxides Package

824

Division 6.1 – Toxic Materials Package

825

Division 6.2 – Infectious Substances Package

826

Excepted Quantity Provision Package

827

Ground Only Hazardous Materials

828

ID8000 Consumer Commodity Package

829

Lighters Package

830

LTD QTY Ground Package

831

Small Quantity Provision Package

832

 

:When <ExtraService>=“125” is indicated and insured amount is less than or equal to $100, the insurance price returned will be zero (“$0.00”) to reflect baked-in insurance. If insured amount is greater than $100, the insurance price returned will reflect an extra cost since baked-in insurance was exceeded.

 

注意:If HAZMAT extra services “813” and “826” are indicated when a domestic integrated customs form returns, a <CustomsContentType> of "DANGEROUSGOODS" will be required.

String

whiteSpace=collapse

Enumerations=

·  100

·  101

·  102

·  105

·  110

·  118

·  119

·  120

·  125

·  155

·  156

·  170

·  171

·  172

·  174

·  177

·  178

·  179

·  181

·  182

HAZMAT Services:

·  810

·  811

·  812

·  813

·  814

·  815

·  816

·  817

·  818

·  819

·  820

·  821

·  822

·  823

·  824

·  825

·  826

·  827

·  828

·  829

·  830

·  831

·  832

 

 

eVSRequest/ HoldForPickup

Optional

For future use.

(Group)

 

eVSRequest/ OpenDistribute

Optional

For future use.

(Group)

 

eVSRequest/ PermitNumber

Optional

For future use.

String

 

eVSRequest/ PermitZIPCode

Optional

For future use.

String

 

eVSRequest/ PermitHolderName

Optional

For future use.

String

 

eVSRequest/ CRID

Optional

Customer Registration ID, Represents Mail Owner CRID.

Will be used to populate the SSFv2.0 D1 pos. 20 CRID field.

例如:<CRID>544762</CRID>

String

minLength=0
maxLength=15

eVSRequest/ MID

Optional

Mailer ID (MID), Represents Mail Owner MID.

Will be used to populate the SSFv2.0 D1 pos. 13 Mail Owner MID field.

例如:<MID>847654321</MID>

String

Length=6 or 9 positions if populated

eVSRequest/ LogisticsManagerMID

Optional

The MID of the company that manages the mailing. 例如:<LogisticsManagerMID>489001</ LogisticsManagerMID>

Will be used to populate the SSFv2.0 D1 pos 12 Logistics Manager MID field.

 

注意:If <LogisticsManagerMID> is populated, either CRID or MID must also be populated.

String

Length=6 or 9 positions if populated

eVSRequest/ VendorCode

Optional

Code from vendor software to identify the developer of the shipping system.

Will be used to populate the SSFv2.0 H1 pos. 15 Software Vendor Code field.

例如:<VendorCode>1234<VendorCode>

String

minLength=0
maxLength=4

default=8300

eVSRequest/ VendorProductVersionNumber

Optional

Shipping software’s product version number.

Will be used to populate the SSFv2.0 H1 pos. 16 Software Vendor Product Version Number field.

例如:<VendorProductVersionNumber>5.02.1B</VendorProductVersionNumber>

String

minLength=0
maxLength=8

eVSRequest/ SenderName

Optional

The name of the person or company sending the USPS tracking email notification.

注意:No email is returned when generating a Sample (i.e., API=eVSCertify) request.  

String

minLength=0

maxLength=50

eVSRequest/ SenderEMail

Optional

Email address of sender used for USPS tracking email notification. Valid email addresses must be used.

 

注意:<RecipientEMail> must be populated to generate USPS tracking email notification. If <SenderEMail> provided without <RecipientEMail>, USPS tracking email notification will not be generated.

 

注意:No email is returned when generating a Sample (i.e., API=eVSCertify) request.  

String

minLength=0
pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4}

eVSRequest/ RecipientName

Optional

The name of the person or company receiving the USPS tracking email notification. If recipient name not provided, email will be addressed to <RecipientEMail> value provided.

String

minLength=0

maxLength=50

eVSRequest/ RecipientEMail

Optional

Email address of recipient receiving the USPS tracking email notification. This field is required to generate tracking email. Valid email addresses must be used.

 

注意:No email is returned when generating a Sample (i.e., API=eVSCertify) request.  

String

minLength=0
pattern=([\w\-\.]+)@(([\w-]+\.)+)[a-zA-Z]{2,4}

eVSRequest/ ReceiptOption

Optional

Label & Receipt print layout options. Enter "SEPARATE PAGE" if you want the shipping label and online customer record printed on two separate pages, "SAME PAGE" if you want them printed on the same single page, or “NONE” if no receipt is requested.

例如:<ReceiptOption>SAME PAGE</ReceiptOption>

 

注意: When <ImageParameter> = “4X6ZPL203DPI” or “4X6ZPL300DPI” a receipt is eligible to return but it will not be ZPL encoded.

String

Default=SAME PAGE

Enumerations=

·  SEPARATE PAGE

·  SAME PAGE

·  NONE

eVSRequest/ ImageType

需要

Label Image Type.

例如:<ImageType>PDF</ ImageType>

 

注意: All <ImageType> values are ignored when <ImageParameter>= “4X6ZPL203DPI” or “4X6ZPL300DPI”.

String

Enumerations=

·  PDF

·  TIF

·  NONE

eVSRequest/ HoldForManifest

Optional

Restricted use. Holds manifest record for possible inclusion in SCAN request.

String

Default=N

Enumerations=

·  Y

·  N

eVSRequest/ NineDigitRoutingZip

Optional

Indicates if nine-digit routing zip code is included in the barcode.

例如:<NineDigitRoutingZip>False</ NineDigitRoutingZip>

 

注意: This request tag must equal “true” for a 9-digit ZIP to be included in the barcode otherwise, even if <ToZip4> is provided in the request it will not be present in the barcode.

Boolean

Default=False

Enumerations=

·  True

·  False

 

eVSRequest/ ShipInfo

Optional

Indicates if revenue protection information is printed on the label.

例如:<ShipInfo>False</ShipInfo>

Boolean

Default=False

Enumerations=

·  True

·  False

eVSRequest/

CarrierRelease

Optional

Indicates if the ‘CARRIER – LEAVE IF NO RESPONSE’ is to be printed on the label. This endorsement cannot be applied to Express Mail or items requiring a signature at delivery (e.g., Signature Confirmation, Insurance > $500).

例如:<CarrierRelease>False</CarrierRelease>

Boolean

Default=False

Enumerations=

·  True

·  False

 

 

eVSRequest/

DropOffTime

Optional

Indicates the time the package will be dropped off.

Time is specified in military time.

例如:<DropOffTime>13:00</DropOffTime>

Boolean

 

eVSRequest/

ReturnCommitments

Optional

Indicates that the CommitmentName and Scheduled DeliveryDate will be returned in the response.

例如:<ReturnCommitments>False</ ReturnCommitments>

Boolean

Default=False

Enumerations=

·  True

·  False

 

eVSRequest/

PrintCustomerRefNo

Optional

Print <CustomerRefNo> in the additional information section.

 

注意: For the <CustomerRefNo> value to print on the label you must also indicate “True” for the <PrintCustomerRefNo> tag.

Boolean

Default=False

Enumerations=

·  True

·  False

eVSRequest/

PrintCustomerRefNo2

Optional

Print <CustomerRefNo2> in the additional information section.

 

注意: For the <CustomerRefNo2> value to print on the label you must also indicate “True” for the <PrintCustomerRefNo2> tag.

Boolean

Default=False

Enumerations=

·  True

·  False

eVSRequest/

Content

Optional

Groups Content

(Group)

 

eVSRequest/

Content/ ContentType

Conditionally Required

(Required when Content grouping is included)

Use to specify ContentType. Currently available types are:

ContentType

CrematedRemains

Lives

易腐邮件

Pharmaceuticals

MedicalSupplies

例如:<ContentType>Lives</ContentType >

 

注意: A <ContentType> is not allowed if ParcelLocker is true.

String

Enumerations=

·  CrematedRemains

·  Lives

·  Perishable

·  Pharmaceuticals

·  MedicalSupplies

eVSRequest/

Content/ ContentDescription

Conditionally Required

Use to specify Content Description. Required when <ContentType>Lives</ ContentType> is supplied. Valid Values

ContentDescription

小蜜蜂

DayOldPoultry

AdultBirds

其他

For example:<ContentDescription>DayOldPoultry</ContentDescription>

String

Enumerations=

·  Bees

·  DayOldPoultry

·  AdultBirds

·  Other

eVSRequest/ActionCode

Optional

Used to specify the SPE action code. Value is included in the Shipping Partner Event (SPE) file for customers who have chosen to have a Shipping Partner Event file submitted to USPS on their behalf.

M0 – Mailer Owner

S0 – Service Provider

例如:<ActionCode>M0</ActionCode>

String

Default=M0

Enumerations=

·  M0

·  S0

eVSRequest/ OptOutOfSPE

Optional

Used to specify if a Shipping Partner Event (SPE) file will be created. Use “false” to create an SPE file.

例如:<OptOutOfSPE>false</OptOutOfSPE>

 

注意:Web Tools will return an error if <OptOutOfSPE>= “false” when <ServiceType> = “PARCEL SELECT DE”.

注意: This request tag is case sensitive.

Boolean

Default=true

Enumerations=

·  true

·  false

eVSRequest/

SortationLevel

Optional

Presort grouping of mail.

 

Sortation Level

价值

3-Digit

3D

Origin Entry

3-Digit implied

Mix

3-Digit implied

SCF

5-Digit

5D

String

Enumerations=

·  3D

·  None

·  NDC

·  Mix

·  SCF

·  5D

eVSRequest/

DestinationEntryFacilityType

Conditionally Required

注意:Required when <ServiceType>= “PARCEL SELECT DE”.

Destination Type

价值

Destination Delivery Unit

DDU

Destination Hub

DHUB

Destination Sectional Center Facility

DSCF

Destination Network Distribution Unit

DNDC

String

Enumerations=

·  DDU

·  DHUB

·  DSCF

·  DNDC

·  NONE

eVSRequest/

ContainerID1

Conditionally Required

Barcode on container 1.

例如:<ContainerID1>222010127123456789912345</ContainerID1>

 

注意: Required when <DestinationEntryFacilityType>=“DNDC” or “DSCF”

String

maxLength=34,

minLength=0

Alphanumeric (34)

eVSRequest/

ContainerID2

Optional

Barcode on container 2.

例如:<ContainerID2>222010127123456789912345</ContainerID2>

String

maxLength=34,

minLength=0

Alphanumeric (34)

eVSRequest/

ContainerID3

Optional

Barcode on container 3.

例如:<ContainerID3>222010127123456789912345</ContainerID3>

String

maxLength=34,

minLength=0

Alphanumeric (34)

eVSRequest/

SortContainerType1

Conditionally Required

Describes type of container for ContainerID1.

注意:Required if <ContainerID1> is populated

Sort Container

价值

托盘

PT

Sack

SACK

String

maxLength=2,

minLength=0

Enumerations=

·  PT

·  SK

eVSRequest/

SortContainerType2

Conditionally Required

Describes type of container for ContainerID2.

注意:Required if <ContainerID2> is populated

 

String

maxLength=2,

minLength=0

Enumerations=

·  PT

·  SK

eVSRequest/

SortContainerType3

Conditionally Required

Describes type of container for ContainerID3.

注意:Required if <ContainerID3> is populated

 

String

maxLength=2,

minLength=0

Enumerations=

·  PT

·  SK

eVSRequest/

DiscountType

Optional

This tag is used to pass applicable discount codes. Refer to Pub199, Appendix J, Table 6 for the complete list of Discount Type codes https://postalpro.usps.com/pub199. Will be used to populate the SSFv2.0 D1 pos. 59 Discount Type field.

例如:<DiscountType>D1</DiscountType>

String

maxLength=2,

minLength=0

2-digit alphanumeric

eVSRequest/

DiscountAmount

Optional

This tag is used to pass the discount fee. Will be used to populate the SSFv2.0 D1 pos. 60 Discount Amount field.

例如:<DiscountAmount>20.00</DiscountAmount>

Decimal

maxLength=8,

minLength=0

eVSRequest/

SurchargeType

Conditionally Required

This tag is used to pass applicable surcharge codes. Refer to Pub199, Appendix J, Table 13 for the complete list of Surcharge Type codes https://postalpro.usps.com/pub199. Will be used to populate the SSFv2.0 D1 pos. 57 Surcharge Type field.

例如:<SurchargeType>E2</<SurchargeType>

注意:Required when <NextDay>=“Y”.

String

maxLength=2,

minLength=0

2-digit alphanumeric

eVSRequest/

SurchargeAmount

Conditionally Required

This tag is used to pass the surcharge fee. Will be used to populate the SSFv2.0 D1 pos. 58 Surcharge Amount field.

例如:<SurchargeAmount>20.00</SurchargeAmount>

注意:Required when <NextDay>=“Y”.

Decimal

maxLength=7,

minLength=0

eVSRequest/

ShipmentFeeCode

Optional

This tag is used to pass a Pickup on Demand fee code. Will be used to populate the SSFv2.0 H1 pos. 10 Shipment Fee Code field.

例如:

<ShipmentFeeCode>PKF</ShipmentFeeCode>

String

maxLength=3,

minLength=0

Alphanumeric (3)

eVSRequest/

ExtraFeeForShipment

Optional

This tag is used to pass a Pickup on Demand fee. Will be used to populate the SSFv2.0 H1 pos. 11 Extra Fee for Shipment field.

例如:<ExtraFeeForShipment>20.00</ExtraFeeForShipment>

Decimal

maxLength=7,

minLength=0

 

pattern= ^\d{1,4}([.]\d{1,2})?$

eVSRequest/

NextDay

Optional

Same Day/Next Day Program Indicator

 

注意:When “Y”, <SurchargeType> of “E2” (Same Day/Next Day) and <SurchargeAmount> required otherwise an error will be returned.

 

注意: When “Y”, "SAME DAY DELIVERY" endorsement and carrier release “CARRIER – LEAVE IF NO RESPONSE" markings will be displayed on the label.

 

注意:<NextDay> indicator will take precedence over <CarrierRelease> tag when determining markings printed on the label.

Boolean

Default=N

Enumerations=

·  Y

·  N

eVSRequest / ShippingContents

Conditionally Required

Required only if a domestic integrated customs form is required based on Customs Content Type and Weight.

(Group)

 

eVSRequest / 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)

 

eVSRequest / ShippingContents / ItemDetail / Description

Optional/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 D or read the EU’s guidance on acceptable terms at Guidance on Acceptable and Unacceptable Terms for the Description of Goods.

 

For EU destinations, vague item descriptions will return an error: none, not applicable, n/a, null, gift, merchandise

 

例如:<Description>Policy guidelines document</Description>

String

minLength=2

maxLength=30

eVSRequest / ShippingContents / ItemDetail /Quantity

Optional/Required

Quantity of the item. Integer value required. Required only if a customs form is required based on Customs Content Type and Weight.

例如:<Quantity>1</Quantity>

Integer

whitespace=collapse

maxInclusive  value=9999

eVSRequest / ShippingContents / ItemDetail / Value

Optional/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. Required only if a customs form is required based on Customs Content Type and Weight.

例如:<Value>55.00</Value>

Decimal

minExclusive value=0                                                  totalDigits value=8                                                  maxInclusive  value=99999.99

eVSRequest / ShippingContents / ItemDetail / NetPounds

Optional/Required

Provide the pounds OR ounces component of the weight of the individual item listed with <Description> when a customs form is required based on Customs Content Type and Weight.

例如:<NetPounds>1</NetPounds>

Integer

totalDigits value=2                                                  minInclusive value=0                                         maxInclusive value=70

eVSRequest / ShippingContents / ItemDetail / NetOunces

Optional/Required

Provide the ounces OR pounds component of the weight of the individual item listed with <Description> when a customs form is required based on Customs Content Type and Weight.

例如:<NetOunces>5</NetOunces>

Decimal

totalDigits value=5                                                 minInclusive value=0                                       maxInclusive value=1120

eVSRequest / ShippingContents / ItemDetail / HSTariffNumber

Optional

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.

 

例如:<HSTariffNumber>4901.10.0000</HSTariffNumber>

String

minLength=0

maxLength=16

eVSRequest / ShippingContents / ItemDetail / CountryOfOrigin

Optional

The country where the goods originated, e.g., were produced, manufactured, or assembled. The <CountryOfOrigin> value entered must match an entry from the USPS-approved International Index of Countries (see http://pe.usps.com/text/imm/immctry.htm) and Localities or be "United States".

例如:<CountryOfOrigin>United States</CountryOfOrigin>

String

minLength=0

maxLength=100

eVSRequest / 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 D or read the EU’s guidance on acceptable terms at Guidance on Acceptable and Unacceptable Terms for the Description of Goods.

String

 

eVSRequest / 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 D or read the EU’s guidance on acceptable terms at Guidance on Acceptable and Unacceptable Terms for the Description of Goods.

String

 

eVSRequest / CustomsContentType

需要

Specifies the content of the package or envelope. Field required when a domestic integrated customs form is needed usually when shipping TO/FROM APO/FPO/DPO+PTFAS locations.

例如:<CustomsContentType>DOCUMENTS</CustomsContentType>

 

注意: If the <CustomsContentType> value is “DOCUMENTS” and the <WeightInOunces> value specified is less than 16 oz. then an integrated domestic customs form is not required. Reference DMM for more information:http://pe.usps.com/text/dmm300/608.htm#1255642

 

注意:<CustomsContentType> must equal “DANGEROUSGOODS” when shipping HAZMAT extra services “813” and “826” to a destination that requires a domestic integrated customs form.

String

minOccurs=0

Enumerations=

·  MERCHANDISE

·  GIFT

·  DOCUMENTS

·  SAMPLE

·  RETURN

·  OTHER

·  HUMANITARIAN

·  DANGEROUSGOODS

eVSRequest / ContentComments

Optional

Required tag if <CustomsContentType>=Other

Enter any comments. 例如:<ContentComments>Parts</ContentComments>

String

minOccurs=0

maxLength=25

eVSRequest / RestrictionType

Optional

Restriction Types

String

minOccurs=0

Enumerations=

·  Quarantine

·  Sanitary Inspection

·  Phytosanitary Inspection

·  Other

eVSRequest / RestrictionComments

Optional

Restriction Comments.  Required when <RestrictionType>="Other”

String

minOccurs=0

eVSRequest / AESITN

Optional

AES/ITN Exemption is a code that indicates the reason why you did not need to file electronic export information

String

minOccurs=0

eVSRequest / ImportersReference

Optional

Importers Reference. The Importer’s Reference might be a tax code, importer code, or VAT number used for sales tax

String

minOccurs=0

eVSRequest / ImportersContact

Optional

Importers Contact. Enter, if known, the Importer’s telephone number, fax number, or email address, as such information might facilitate customs clearance or delivery.

String

minOccurs=0

eVSRequest / ExportersReference

Optional

Exporters Reference. The Exporter’s Reference might be a tax code, importer code, or VAT number used for sales tax

String

minOccurs=0

eVSRequest / ExportersContact

Optional

Exporters Contact. Enter, if known, the Exporter’s telephone number, fax number, or email address, as such information might facilitate customs clearance or delivery.

String

minOccurs=0

eVSRequest / InvoiceNumber

Optional

Invoice Number

String

minOccurs=0

maxOccurs=15

eVSRequest / LicenseNumber

Optional

License Number

String

minOccurs=0

maxOccurs=16

eVSRequest / CertificateNumber

Optional

Certificate Number

String

minOccurs=0

maxOccurs=12

eVSRequest / 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 in the below tags. "ABANDON" to dispose of undeliverable package.

例如:<NonDeliveryOption>RETURN</NonDeliveryOption>

String

Enumerations=

·  RETURN

·  REDIRECT

·  ABANDON

eVSRequest / AltReturnAddress1

Optional

Required when <NonDeliveryOption>=“REDIRECT”.

Suggested use of this tag is for an apartment or suite number.

例如:<AltReturnAddress1>Apt 1</AltReturnAddress1>

 

注意: Six AltReturn Address lines are provided but only one line is required. Use as many as needed for complete address.

String

minOccurs=0

eVSRequest / AltReturnAddress2

Optional

Required when <NonDeliveryOption>=“REDIRECT”.

Suggested use of this tag is the Recipient address line 2. Must be a valid address.

例如:<AltReturnAddress2>123 Main Ave </ AltReturnAddress2>

 

注意: Six AltReturn Address lines are provided but only one line is required. Use as many as needed for complete address.

String

minOccurs=0

eVSRequest / AltReturnAddress3

Optional

Required when <NonDeliveryOption>=“REDIRECT”.

Suggested use of this tag is the Recipient city.

 

注意: Six AltReturn Address lines are provided but only one line is required. Use as many as needed for complete address.

String

minOccurs=0

eVSRequest / AltReturnAddress4

Optional

Required when <NonDeliveryOption>=“REDIRECT”.

Suggested use of this tag is the Recipient state. Use 2-letter USPS abbreviation.

 

注意: Six AltReturn Address lines are provided but only one line is required. Use as many as needed for complete address.

String

minOccurs=0

eVSRequest / AltReturnAddress5

Optional

Required when <NonDeliveryOption>=“REDIRECT”.

Suggested use of this tag is the recipient ZIP code.

 

注意: Six AltReturn Address lines are provided but only one line is required. Use as many as needed for complete address.

String

minOccurs=0

eVSRequest / AltReturnAddress6

Optional

Required when <NonDeliveryOption>=“REDIRECT”.

Suggested use of this tag is the recipient ZIP+4 extension

 

注意: Six AltReturn Address lines are provided but only one line is required. Use as many as needed for complete address.

String

minOccurs=0

eVSRequest / AltReturnCountry

Optional

Required when <NonDeliveryOption>=“REDIRECT”.

Country. Tag must equal United States for this API.

String

minOccurs=0

eVSRequest/

LabelImportType

Optional

(Deprecated) Used by USPS meter label solution (MLS) for tracking purposes.

例如:<LabelImportType>CSV</LabelImportType>

String

 

eVSRequest/

ePostageMailerReporting

Optional

Used to identify ePostage sender/mailer and include Sender information in SSF.

·        1 (ePostage sender info in SSF)

·        2 (ePostage sender info through DES)

·        3 (ePostage sender info using child MID)

Verifies Sender informationsender fields are provided and must match From information when <ePostageMailerReporting>=1

ePostageMailerReporting value used in SSF for “PostageType

String

Enumerations=

·  1

·  2

·  3

eVSRequest/

SenderFirstName

Optional

First Name of Sender.

例如:<SenderFirstName>Adam </ SenderFirstName>

Required when <ePostageMailerReporting>=1

String

minLength=0, maxLength=49

 

eVSRequest/

SenderLastName

Optional

Last Name of Sender.

例如:<SenderLastName>Smith </ SenderLastName>

Required when <ePostageMailerReporting>=1

String

minLength=0, maxLength=75

eVSRequest/

SenderBusinessName

Optional

Values for Sender Business Name must be sent.

例如:<SenderBusinessName>USPS</ SenderBusinessName>

String

minLength=0, maxLength=100

eVSRequest/

SenderAddress1

Optional

Sender address. Use this tag for complete sender address

例如:<SenderAddress1>123 Main St STE 150</ SenderAddress1>

Required when <ePostageMailerReporting>=1

String

minLength=0, maxLength=148

eVSRequest/

SenderCity

Optional

Sender city.

例如:<SenderCity>BETHESDA</ SenderCity> Required when <ePostageMailerReporting>=1

String

minLength=0, maxLength=50

eVSRequest/

SenderState

Optional

Sender state.

例如:<SenderState>MD</ SenderState> Required when <ePostageMailerReporting>=1

String

minLength=0, maxLength=2

eVSRequest/

SenderZip5

Optional

Sender ZIP code.

例如:<SenderZip5>20212</SenderZip5>

Required when <ePostageMailerReporting>=1

String

minLength=0, pattern=d[5]

eVSRequest/

SenderPhone

Optional

Sender Phone #. 10 digits required (including area code), with no punctuation.

例如:<SenderPhone>2125551234</ SenderPhone>

Required when <ePostageMailerReporting>=1

String

minLength=0, pattern=d[10]

eVSRequest / ChargebackCode

Optional

Used in Shipping Services File v2.0 for G-10/OMAS labels. Contact your Technical Integration Specialist for details.

String

123456 (alphanumeric)

eVSRequest / TrackingRetentionPeriod

Optional

Used to determine period of Retention for tracking data. Required when <ExtraService>= “181” or “182”.

ServiceID

<TrackingRetentionPeriod>

181

“0.5” (6 Months)

181

“1” (1 Year)

181

“3” (3 Years)

181

“5” (5 Years)

181

“7” (7 Years)

182

“3” (3 Years)

182

“5” (5 Years)

182

“7” (7 Years)

String

minOccurs=0

maxOccurs=1

Enumerations=

·  0.5

·  1

·  3

·  5

·  7

eVSRequest/ReturnFees

Optional

Used to show additional pricing and package details. Include <Fees>=“true” in request to return <Fees> response tag with breakdown of fees applied to postage and <Attributes> response tag with package details.

Boolean

Default=false

Enumerations=

·  true

·  false

eVSRequest / FromContactPreference