Express Mail Label

API

 

USPS Web Tools™

Application Programming Interface

User’s Guide

Document Version 3.1 (05/31/2015)

 

 

 

 

 

 

United States Postal Service Logo 

 

 


 


Contents

Introduction to Web Tools. 3

Before you get started: 3

USPS Priority Mail Express Label API. 3

Overview.. 3

API Signature. 4

Tag Descriptions. 4

Request Parameters. 4

Sample Request 13

Response Parameters. 14

Sample Response. 17

Error Responses. 18

Label Example. 19


Introduction to Web Tools

This document contains a Reference Guide to the Priority Mail Express Label APIs.  See the Developer’s Guide (https://www.usps.com/business/web-tools-apis/technical-documentation.htm) to learn the administrative process for gaining access to the Web Tools APIs as well as the basic mechanism for calling the APIs and processing the results.  The Developer’s Guide also contains information on testing and trouble-shooting.

 

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

 

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

 

<ZipDestination>12345</ZipDestination>

 

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

Before you get started:

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

Label API access requires extra permissions; contact the Internet Customer Care Center uspstechnicalsupport@mailps.custhelp.com to request access. Indicate “Label API Access” in the subject line and explain in the body of the email:

1.       How the shipper intends to purchase and apply postage to the labels

2.       If the label image provided by the API will be modified in any way by the shipper or the software

USPS Priority Mail Express Label API

Overview

The Priority Mail Express Label API will let customers create Priority Mail Express Labels. Please note that the API labels are printed without postage. Postage must be purchased and applied separately. For more information on postage payment methods, see https://www.usps.com/business/postage-options.htm.

API Signature

Scheme

Host

Path

API

XML

https://

secure.shippingapis.com

/ShippingAPI.dll

?API=ExpressMailLabel

&XML=(see below)

https://

secure.shippingapis.com

/ShippingAPI.dll

?API=ExpressMailLabelCertify

&XML=(see below)

 

Note: The “ExpressMailLabelCertify” API signature is for testing purposes and will not generate usable labels and barcodes.

Tag Descriptions

Request Parameters

Tag Name

Occurs

Description

Type

Validation

ExpressMailLabelRequest

required once

API=ExpressMailLabel  

(group)

 

ExpressMailLabelRequest / @USERID

required

 

NMTOKEN

 

ExpressMailLabelRequest / Option

required once

For future use.  

empty

 

ExpressMailLabelRequest / Revision

optional

In this API use a value of 2 to trigger new functionality.

For example: <Revision>2</Revision>

string

minLength=0
pattern=\d{1}
pattern=  

ExpressMailLabelRequest / EMCAAccount

required

For future use.  

empty

 

ExpressMailLabelRequest / EMCAPassword

required

For future use.  

empty

 

ExpressMailLabelRequest / ImageParameters

required once

For future use.  

empty

 

ExpressMailLabelRequest / FromFirstName

required once

Values for either First and Last Name of Sender or Firm must be sent. Maximum Length: 26 characters for first and last names combined.


For example: <FromFirstName>MT</FromFirstName> 

string

maxLength=26
minLength=0  

ExpressMailLabelRequest / FromLastName

required once

Values for either First and Last Name of Sender or Firm must be sent. Maximum Length: 26 characters for first and last names combined.


For example: <FromLastName>MARTIAN</FromLastName> 

string

minLength=0
maxLength=26  

ExpressMailLabelRequest / FromFirm

required once

Values for either First and Last Name of Sender or Firm must be sent. Maximum Length: 26 characters for firm name.


For example: <FromFirm>USPS</FromFirm> 

string

minLength=0
maxLength=26  

ExpressMailLabelRequest / FromAddress1

required once

From address line 1. Use this tag for an apartment or suite number.


For example: <FromAddress1>STE 150</FromAddress1> 

string

minLength=0
maxLength=26  

ExpressMailLabelRequest / FromAddress2

required once

From address line 2.

For example: <FromAddress2>6600 ROCKLEDGE DR</FromAddress2> 

string

minLength=1
maxLength=26  

ExpressMailLabelRequest / FromCity

required once

From city.


For example: <FromCity>BETHESDA</FromCity> 

string

minLength=1
maxLength=13  

ExpressMailLabelRequest / FromState

required once

From state.


For example: <FromState>MD</FromState> 

string

minLength=2
maxLength=2  

ExpressMailLabelRequest / FromZip5

required once

From ZIP code.


For example: <FromZip5>20212</FromZip5> 

string

pattern=\d{5}  

ExpressMailLabelRequest / FromZip4

required once

From ZIP+4 extension.


For example: <FromZip4/> 

string

minLength=0
pattern=\d{4}
pattern=  

ExpressMailLabelRequest / FromPhone

required once

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


For example: <FromPhone>2125551234</FromPhone> 

string

pattern=\d{10}  

ExpressMailLabelRequest / ToFirstName

required once

Values for either First and Last Name of Recipient or Firm must be sent. Maximum Length: 26 characters for both names or firm name.  

 

For example: <ToFirstName>Adam</ToFirstName>

string

minLength=0
maxLength=26  

ExpressMailLabelRequest / ToLastName

required once

Values for either First and Last Name of Recipient or Firm must be sent. Maximum Length: 26 characters for both names or firm name.  

 

For example: <ToLastName>Smith</ToLastName> 

string

minLength=0
maxLength=26  

ExpressMailLabelRequest / ToFirm

required once

Values for either First and Last Name of Recipient or Firm must be sent. Maximum Length: 26 characters for both names or firm name.  

 

For example: <ToFirm>ABC CORPORATION</ToFirm> 

string

minLength=0
maxLength=26  

ExpressMailLabelRequest / ToAddress1

required once

Recipient address line 1. Use this tag for an apartment or suite number.  

 

For example: <ToAddress1/> 

string

minLength=0
maxLength=26  

ExpressMailLabelRequest / ToAddress2

required once

Recipient address line 2. Must be a valid address.  

 

For example: <ToAddress2>1234 MAIN ST</ToAddress2> 

string

minLength=1
maxLength=26  

ExpressMailLabelRequest / ToCity

required once

Recipient city. Unless declined using the <StandardizeAddress> tag the API will cleanse (check) the address using USPS databases. Values for either To City and To State or Zip 5 must be sent. Maximum Length: 26 characters for both City and State combined. 

 

For example: <ToCity>ANYTOWN</ToCity> 

string

minLength=0
maxLength=13

ExpressMailLabelRequest / ToState

required once

Recipient state. Unless declined using the <StandardizeAddress> tag the API will cleanse (check) the address using USPS databases. Values for either To City and To State or Zip 5 must be sent. Maximum Length: 26 characters for both City and State combined. 

 

For example: <ToState>MN</ToState> 

string

minLength=0
pattern=\w{2}

ExpressMailLabelRequest / ToZip5

required once

Recipient ZIP code. Must be a valid ZIP code. Unless declined using the <StandardizeAddress> tag the API will cleanse (check) the address using USPS databases. Values for either To City and To State or Zip 5 must be sent. Maximum Length: 26 characters for both City and State combined. 

 

For example: <ToZip5>12345</ToZip5> 

string

minLength=0
pattern=\d{5}

ExpressMailLabelRequest / ToZip4

required once

Recipient ZIP+4 extension.  

 

For example: <ToZip4/> 

string

minLength=0
pattern=\d{4}

ExpressMailLabelRequest / ToPOBoxFlag

optional

Indicates if the destination address is a PO Box.

 

For example: <ToPOBoxFlag>True</ToPOBoxFlag>

boolean

default=false 

ExpressMailLabelRequest / ToPhone

required once

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

 

For example: <ToPhone>2125551234 </ToPhone>

string

pattern=\d{10}

ExpressMailLabelRequest / ToContactPreference

Optional

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

 

For example: <ToContactPreference>EMAIL</ToContactPreference>

string

default=EMAIL

whiteSpace=collapse enumeration=EMAIL

enumeration=SMS enumeration=WAIVED

ExpressMailLabelRequest / ToContactMessaging

Optional

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

 

For example: <ToContactMessaging>user@anydomain.gov</ToContactMessaging>

string

maxLength=64

whiteSpace=collapse

pattern=\w{0}

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

ExpressMailLabelRequest / ToContactEmail

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:

<ToContactEMail>John.Smith@abc.com</ToContactEMail>

string

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

ExpressMailLabelRequest / WeightInOunces

required once

Package weight. Items must weigh 70 pounds or less. 

 

For example: <WeightInOunces>80</WeightInOunces> 

string

pattern=\d{0,4}  

ExpressMailLabelRequest / ShipDate

optional

Deprecated. See "LabelDate" tag.  

string

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

ExpressMailLabelRequest / FlatRate

optional

Deprecated. See "Container" tag.  

boolean

default=false 

ExpressMailLabelRequest / SundayHolidayDelivery

optional

Guaranteed Sunday/Holiday Delivery. When true the label contains special banners and the postage on the label and in the response includes the premium.  

 

For example: <SundayHolidayDelivery/>

boolean

default=false
 

ExpressMailLabelRequest / StandardizeAddress

optional

Delivery Address Cleansed. Enter "true" if you want the API to check the address for accuracy or "false" if you do not.  Parcels with non-standardized addresses run the risk of being undeliverable.

 

For example: <StandardizeAddress/>

boolean

default=true
 

ExpressMailLabelRequest / 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.  

 

For example: <WaiverOfSignature/>

boolean

default=true 

ExpressMailLabelRequest / CarrierRelease

optional

For future use.  

boolean

minOccurs="0"

ExpressMailLabelRequest / NoHoliday

optional

Deprecated. See "SundayHolidayDelivery" tag.  

boolean

default=false 

ExpressMailLabelRequest / NoWeekend

optional

No Saturday Delivery. Enter "true" if you do not want the package delivered on Saturday or "false" if you do.

boolean

default=false

ExpressMailLabelRequest / SeparateReceiptPage

optional

Label & Customer Online Record Printed on two separate pages. Enter "true" if you want the shipping label and online customer record printed on two separate pages or "false" if you want them printed on the same single page.

 

For example:

<SeparateReceiptPage>true</SeparateReceiptPage>

boolean

default=false
 

ExpressMailLabelRequest / POZipCode

required once

ZIP Code of Post Office or collection box where item is mailed. May be different than From ZIP Code.  

 

For example: <POZipCode/> 

string

minLength=0
pattern=\d{5}

ExpressMailLabelRequest / FacilityType

optional

Has values: "DDU", "SCF", "BMC", "ADC", "ASF". Optional, but cannot be left blank if specified.  

 

For example: <FacilityType>DDU</FacilityType>

string

enumeration=DDU
enumeration=SCF
enumeration=BMC
enumeration=ADC
enumeration=ASF  

ExpressMailLabelRequest / ImageType

required once

Label Image Type.  

 

For example: <ImageType>PDF</ImageType>

string

enumeration=PDF
enumeration=TIF
enumeration=None  

ExpressMailLabelRequest / LabelDate

optional

Date Package Will Be Mailed. Ship date may be today plus 0 to 3 days in advance. Enter the date in either format: dd-mmm-yyyy, such as 14-Feb-2011, or mm/dd/yyyy, such as 02/14/2011.  

 

For example: <LabelDate/>  

string

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

ExpressMailLabelRequest / LabelTime

optional

Time Package Will Be Mailed. Time may be midnight (00:00) to 23:59.  Enter the time in the format: HH:MM such as 13:30.


For example: <LabelTime>15:00</LabelTime>

string

minLength=0
pattern=\d{1,2}/:d{2}
pattern=\d{0}

ExpressMailLabelRequest / CustomerRefNo

optional

User-assigned Number for Internal Use.  

 

For example: <CustomerRefNo>XYZ-123</CustomerRefNo>

string

minLength=0
maxLength=30  

ExpressMailLabelRequest / SenderName

optional

Name of E-mail Sender.  

 

For example: <SenderName>C. P. Apple</SenderName>

string

minLength=0  

ExpressMailLabelRequest / SenderEMail

optional

E-mail Address of Sender. Valid e-mail addresses must be used.  

 

For example: <SenderEMail>cpapple@email.com</SenderEMail>  

string

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

ExpressMailLabelRequest / RecipientName

optional

Name of E-mail Recipient  

 

For example: <RecipientName/> 

string

minLength=0

ExpressMailLabelRequest / RecipientEMail

optional

E-mail Address of Recipient. Valid e-mail addresses must be used.  

 

For example: <RecipientEMail></RecipientEMail> 

string

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

ExpressMailLabelRequest / HoldForManifest

optional

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

string

enumeration=Y
enumeration=N

ExpressMailLabelRequest / CommercialPrice

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/.

 

For example: <CommercialPrice>False

</CommercialPrice>

boolean

default=false 

ExpressMailLabelRequest / InsuredAmount

optional

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

For example: <InsuredAmount>100.00</InsuredAmount> 

decimal

default=0
minInclusive=0
maxInclusive=9999.99
totalDigits=8
whiteSpace=collapse  

ExpressMailLabelRequest / Container

optional

Use to specify special containers or container attributes that may affect postage; otherwise leave blank.  Required when <Revision>=‘2’.

 

Note: RECTANGULAR or NONRECTANGULAR must be indicated when <Size>LARGE</Size>.


For example: <Container>FLAT RATE ENVELOPE</Container> 

string

whiteSpace=collapse

enumeration=

VARIABLE
RECTANGULAR
NONRECTANGULAR

FLAT RATE ENVELOPE

LEGAL FLAT RATE ENVELOPE 

PADDED FLAT RATE ENVELOPE 

FLAT RATE BOX 

ExpressMailLabelRequest /

Size

optional

Required when <Revision>=’2’. Defined as follows:

 

REGULAR: all package dimensions are under 12’’;

LARGE: any package dimension is greater than 12’’

 

For example: <Size>REGULAR</Size> 

string

whiteSpace=collapse
enumeration=LARGE
enumeration=REGULAR

ExpressMailLabelRequest /

Width

optional

Value must be numeric. Units are inches. Required when Size is LARGE.

For example: <Width>5.5</Width> 

decimal

minExclusive=0.0
totalDigits=10  

ExpressMailLabelRequest / Length

optional

Value must be numeric. Units are inches. Required when Size is LARGE.

For example: <Length>11</Length> 

decimal

minExclusive=0.0
totalDigits=10  

ExpressMailLabelRequest / Height

optional

Value must be numeric. Units are inches. Required when Size is LARGE.

For example: <Height>11</Height> 

decimal

minExclusive=0.0
totalDigits=10  

ExpressMailLabelRequest /

Girth

optional

Value must be numeric. Units are inches. Girth is only required when Container = ‘NONRECTANGULAR’ and Size=’LARGE’.


For example: <Girth>41</Girth> 

decimal

minExclusive=0.0
totalDigits=10  

ExpressMailLabelRequest /

NineDigitRoutingZip

optional

Indicates if an IMPB barcode format is desired.  “True” returns an IMPB barcode with a nine digit routing zip code, and “false” returns and IMPB barcode with a five digit routing zip code.

 

For example: <NineDigitRoutingZip>true</NineDigitRoutingZip> 

boolean

default=false

ExpressMailLabelRequest /

ExtraServices

optional

Groups extra services elements

(group)

 

ExpressMailLabelRequest / ExtraServices / ExtraService

optional, repeating up to unbounded times

Use to specify extra services.  Currently available services are:

 

Service Name

ServiceID

Adult Signature

119

Adult Signature Restricted Delivery

120

 

10:30 AM Delivery (PME)

161

Insurance Restricted Delivery (PME)

178

 

For example: <ExtraService>119</ExtraService>

string

enumeration=119

enumeration=120

enumeration=161

enumeration=178

 

 

ExpressMailLabelRequest / ReturnCommitments

optional

Indicates if commitment information should be returned.

For example: <ReturnCommitments>True</ReturnCommitments>

boolean

default=false 

ExpressMailLabelRequest / Content

optional

Groups Content elements when a special Content is included in the shipment.

(group)

 

ExpressMailLabelRequest / Content / ContentType

required once – if content included

Use to specify ContentType.  Available types are:

 

ContentType

HAZMAT

CrematedRemains

Lives

Perishable

Fragile

 

Required if LIVES.

 

Example: < ContentType >Lives</ ContentType >

 

Note:  USPS-produced packaging, including Flat Rate and Regional Rate, cannot be used to ship live animals.  Error response will be returned.

string

Enumeration=

HAZMAT 

CrematedRemains

Lives

Perishable

Fragile

ExpressMailLabelRequest / Content / ContentDescriptor

Optional

Description of contents. Required for ContentType of LIVES

 

For example: <ContentDescriptor>Bees</ContentDescriptor>

string

enumeration=

Bees
DayOldPoultry

AdultBirds

Other

ExpressMailLabelCertifyRequest

required once

API=ExpressMailLabelCertify  

(alias)

 

 

Sample Request

Test XML Request:

https://production.shippingapis.com/ShippingAPITest.dll?API=ExpressMailLabelRequest2&XML<ExpressMailLabelCertifyRequest  USERID="XXXXXX">

    <Option />

    <Revision>2</Revision>

    <EMCAAccount />

    <EMCAPassword />

    <ImageParameters />

    <FromFirstName>Adam</FromFirstName>

    <FromLastName>Smith</FromLastName>

    <FromFirm/>

<FromAddress1>RM 2100</FromAddress1>

<FromAddress2>475 L’Enfant Plaza SW</FromAddress2>

<FromCity>Washington</FromCity>

<FromState>DC</FromState>

<FromZip5>20260</FromZip5>

<FromZip4/>

    <FromPhone>2125551234</FromPhone>

<ToFirstName>Janice</ToFirstName>

<ToLastName>Dickens</ToLastName>

<ToFirm>XYZ Corporation</ToFirm>

<ToAddress1>Postal Square Building</ToAddress1>

<ToAddress2>2 Massachusetts Ave NE</ToAddress2>

<ToCity>Washington</ToCity>

<ToState>DC</ToState>

<ToZip5>20212</ToZip5>

<ToZip4 />

    <ToPhone>2125551234</ToPhone>

    <WeightInOunces>105</WeightInOunces>

    <FlatRate/>

    <SundayHolidayDelivery/>

    <StandardizeAddress/>

    <WaiverOfSignature/>

    <NoHoliday/>

    <NoWeekend/>

    <SeparateReceiptPage/>

    <POZipCode>20212</POZipCode>

    <FacilityType>DDU</FacilityType>

    <ImageType>PDF</ImageType>

    <LabelDate>10/19/2010</LabelDate>

    <CustomerRefNo/>

    <SenderName>Adam Smith</SenderName>

    <SenderEMail>asmith@email.com</SenderEMail>

    <RecipientName>Janice Dickens</RecipientName>

    <RecipientEMail>jdickens@email.com</RecipientEMail>

    <HoldForManifest/>

    <CommercialPrice>false</CommercialPrice>

    <InsuredAmount>425.00</InsuredAmount>

    <Container>NONRECTANGULAR</Container>

    <Size>LARGE</Size>

    <Width>7</Width>

    <Length>20.5</Length>

    <Height>15</Height>

    <Girth>60</Girth>

    <RateClientType>008</RateClientType>

    <RatePriceType>B</RatePriceType>

    <RatePaymentType>3</RatePaymentType>

  </ExpressMailLabelCertifyRequest>

 

Response Parameters

Tag Name

Occurs

Description

Type

Validation

ExpressMailLabelResponse

required once

 

(group)

 

ExpressMailLabelResponse / ToFirstName

required once

First Name of Recipient  

string

 

ExpressMailLabelResponse / ToLastName

required once

Last Name of Recipient  

string

 

ExpressMailLabelResponse / ToFirm

required once

Company Name  

string

 

ExpressMailLabelResponse / ToAddress1

required once

To Address Line 1  

string

 

ExpressMailLabelResponse / ToAddress2

required once

To Address Line 2  

string

 

ExpressMailLabelResponse / ToCity

required once

To City  

string

 

ExpressMailLabelResponse / ToState

required once

To State  

string

 

ExpressMailLabelResponse / ToZip5

required once

To ZIP Code  

string

 

ExpressMailLabelResponse / ToZip4

required once

To ZIP Code+4  

string

 

ExpressMailLabelResponse / Postage

required once

Amount of Postage Required, includes amount for fragile special handling if requested,, does not include insurance or other extra service fees.

decimal

 

ExpressMailLabelResponse / EMConfirmationNumber

required once

Priority Mail Express Tracking Number  

string

 

ExpressMailLabelResponse / EMLabel

optional

Priority Mail Express Label, if requested (where <ImageType> tag not "None") 

base64Binary

 

ExpressMailLabelResponse / EMReceipt

optional

Separate Express Mail Customer Online Record, if requested using <SeparateReceiptPage> tag 

base64Binary

 

ExpressMailLabelResponse / RDC

optional repeating up to 1 times

 

string

 

ExpressMailLabelResponse / InsuranceFee

optional

 

decimal

minExclusive=0.0
maxInclusive=5000

ExpressMailLabelResponse / ExtraServices

required once

 

(group)

 

ExpressMailLabelResponse /

Extra Services / Extra Service

optional, repeating up to unbounded times

Groups extra service information

(group)

 

ExpressMailLabelResponse /

Extra Services / Extra Service / ServiceID

required once

Extra Service ID

string

 

ExpressMailLabelResponse /

Extra Services / Extra Service / ServiceName

required once

Extra Service Name

string

 

ExpressMailLabelResponse /

Extra Services / Extra Service / ServiceFee

optional

Extra Service fee 

decimal

 

ExpressMailLabelResponse / Zone

required once

Postal Zone. Indicates the number of postal rate zones between the origin and destination ZIP codes.  

string

 

ExpressMailLabelResponse / CarrierRoute

required once

 

string

 

ExpressMailLabelResponse / Commitment

optional

Returned if <ReturnCommitments> is true in the request.

(group)

 

ExpressMailLabelResponse / Commitment / CommitmentName

optional

Commitment name such as 1-day, 2-day, 3-day, Military, DPO

String

 

ExpressMailLabelResponse / Commitment / ScheduledDeliveryDate

optional

Date in the YYYY-MM-DD format.

date

 

ExpressMailLabelResponse / 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

 

ExpressMailLabelResponse /  Package / RateClientType

optional

Echoes the RateClientType from the request.  If the RateClientType request is not populated on the request, this tag will not be returned.

string

 

ExpressMailLabelResponse / Package / RatePriceType

optional

Echoes the RatePriceType from the request.  If the RatePriceType request is not populated on the request, this tag will not be returned.

string

 

ExpressMailLabelResponse / Package / RatePaymentType

optional

Echoes the RatePaymentType from the request.  If the RatePaymentType request is not populated on the request, this tag will not be returned.

string

 

ExpressMailLabelCertifyResponse

required once

 

(alias)

 

 

Sample Response

Test XML Response:

<ExpressMailLabelCertifyResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

  <ToFirstName>Janice</ToFirstName>

  <ToLastName>Dickens</ToLastName>

  <ToFirm>XYZ CORPORATION</ToFirm>

  <ToAddress1>Ste 100</ToAddress1>

  <ToAddress2>2 MASSACHUSETTS AVE NE</ToAddress2>

  <ToCity>WASHINGTON</ToCity>

  <ToState>DC</ToState>

  <ToZip5>20212</ToZip5>

  <ToZip4>0002</ToZip4>

  <Postage>28.60</Postage>

  <EMConfirmationNumber>4202021294712XXXXXXXXXXXXXXXXX</EMConfirmationNumber>

  <EMLabel>ZGVmYXVsdA==</EMLabel>

  <EMReceipt>ZGVmYXVsdA==</EMReceipt>

  <RDC>0007</RDC>

  <InsuranceFee>2.40</InsuranceFee>

  <ExtraServices />

  <Zone>1</Zone>

  <CarrierRoute>C000</CarrierRoute>

 <RateClientType>008</RateClientType>

 <RatePriceType>B</RatePriceType>

 <RatePaymentType>3</RatePaymentType>

  </ExpressMailLabelCertifyResponse>

Error Responses

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

<Error>

<Number></Number>

<Source></Source>

<Description></Description>

<HelpFile></HelpFile>

<HelpContext></HelpContext>

</Error>

Where:

·         Number = the error number generated by the Web Tools server.

·         Source = the component and interface that generated the error on the Web Tools server.

·         Description = the error description.

·         HelpFile = [reserved for future use].

·         HelpContext = [reserved for future use].

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

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

If you need assistance with an error response, contact our Internet Customer Care Center uspstechnicalsupport@mailps.custhelp.com

 

 

Label Example

Express Doc Image