Rate Calculator APIs

 

USPS Web Tools™

Application Programming Interface

User’s Guide

                          Document Version 2.4 (05/31/2015)

 

 

 

 

 

 

United States Postal Service Logo 

 

 

 


 


Contents

Introduction to Web Tools. 3

Before you get started: 3

Domestic Rates API - RateV4. 3

Overview.. 3

API Signature. 3

Request Tag Descriptions. 4

Sample Requests. 11

Response Tag Descriptions. 13

Sample Response. 20

Error Responses. 24

International Rates API – IntlRateV2. 26

Overview.. 26

API Signature. 26

Request Tag Descriptions. 26

Sample Requests. 31

Response Tag Descriptions. 32

Sample Response. 37

Error Responses. 40

Appendix A - RateV4 Service Request Matrix. 42

 


Introduction to Web Tools

This document contains a Reference Guide to the Rate Calculator APIs, RateV4 and IntlRateV2. See the Developer’s Guide to learn the administrative process for gaining access to the Web Tools APIs as well as the basic mechanism for calling the APIs and processing the results. The Developer’s Guide also contains information on testing and 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:

 

<Pounds>2</Pounds>

 

In this instance, you will replace “2” with the weight in pounds for the 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.

Domestic Rates API - RateV4

Overview

The RateV4 API lets customers calculate the rate for domestic packages and envelopes given the weight and dimensions of the item.  The RateV4 API limits the data requested to twenty five (25) packages per transaction.

API Signature                

Scheme

Host

Path

API

XML

http://

production.shippingapis.com

/ShippingAPI.dll

?API=RateV4

&XML=(see Tag Descriptions below)


Request Tag Descriptions

Tag Name

Occurs

Description

Type

Validation

RateV4Request

required once

API=RateV4

This API returns the current USPS postage corresponding to the parameters given such as destination, weight of package, class of mail service, and so on.

(group)

 

RateV4Request / @USERID

required

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

NMTOKEN

 

RateV4Request / Revision

optional

Optional for “Base” RateV4 functionality.

 

For full RateV4 functionality use Revision=“2”

string

 

RateV4Request / Package

required once repeating up to 25 times

See the RateV4 Service Request chart for valid combinations of the following tags.

(group)

 

RateV4Request / Package / @ID

required

No restrictions on number or type of characters provided valid XML syntax and unique to request. 

For example: <Package ID="0"/>

NMTOKEN

 

RateV4Request / Package / Service

required once

Web Tool validates the entry to one of the service types.

For example:

<Service>PRIORITY MAIL EXPRESS</Service>

 

Please see Appendix A for detailed business rules regarding combinations of Service, Container, dimensions and other request values.

 

Note:  When all available prices are requested (e.g. <Service>=”PRIORITY”, “PRIORITY MAIL EXPRESS”): Flat Rate and Regional Rate prices will not be included in the response when <ContentType>=”LIVES”

 

Note: Mailable matter not required to be mailed as First-Class Mail is permitted with Standard Post to Zones 5-8. Zones 1-4 items are limited to mailable hazardous materials, live animals, and other “surface-only” items. For more details, see: http://pe.usps.com/businessmail101/classes/packageServices.htm.

 

 

string

whiteSpace=collapse
enumeration=

·         First Class

·         First Class Commercial

·         First Class  HFP Commercial

·         Priority

·         Priority Commercial

·         Priority Cpp

·         Priority HFP Commercial

·         Priority HFP Cpp

·         Priority Mail Express

·         Priority Mail Express Commercial

·         Priority Mail Express Cpp

·         Priority Mail Express Sh

·         Priority Mail Express Sh Commercial

·         Priority Mail Express HFP

·         Priority Mail Express HFP Commercial

·         Priority Mail Express

·         HFP CPP

·         Standard Post

·         Media

·         Library

·         All

·         Online

·         Plus

RateV4Request / Package / FirstClassMailType

optional

Required when:

 

RateV4Request[Service='FIRST CLASS'] or RateV4Request[Service='FIRST CLASS COMMERCIAL’],

or RateV4Request[Service='FIRST CLASS HFP COMMERCIAL’]

 

For example: <FirstClassMailType>LETTER</FirstClassMailType>

 

Note:  The <FirstClassMailType> tag is returned only if the <ServiceType> submitted is “First Class”.  If any other <ServiceType> is returned (Including “First Class Commercial”) the <Container> tag is used.

 

string

whiteSpace=collapse
enumeration=

LETTER
FLAT
PARCEL

POSTCARD

PACKAGE SERVICE

RateV4Request / Package / ZipOrigination

required once

ZIP code must be valid.

For example: <ZipOrigination>20770</ZipOrigination>

string

whiteSpace=collapse
length=5
pattern=\d{5}

RateV4Request / Package / ZipDestination

required once

ZIP code must be valid.

For example: <ZipDestination>54324</ZipDestination>

string

length=5
whiteSpace=collapse
pattern=\d{5}

RateV4Request / Package / Pounds

required once

Value must be numeric. Package weight in ounces is computed by 16*RateV4Request/Package/Pounds + RateV4Request/Package/Ounces. Package weight cannot exceed 70 pounds.


For example: <Pounds>2</Pounds>

string

maxInclusive=70
minInclusive=0

RateV4Request / Package / Ounces

required once

Value must be numeric. Package weight in ounces is computed by 16*RateV4Request/Package/Pounds + RateV4Request/Package/Ounces. Package weight cannot exceed 70 pounds (1120 ounces).

For example: <Ounces>0</Ounces>

string

maxInclusive=1120.0
minInclusive=0.0
totalDigits=10

RateV4Request / Package / Container

required once

Use to specify special containers or container attributes that may affect postage; otherwise, leave blank.

 

Note:

 

1.  RECTANGULAR or NONRECTANGULAR must be indicated when <Size>LARGE</Size>.
For example: <Container>LEGAL FLAT RATE ENVELOPE</Container>

 

2.  The <FirstClassMailType> tag is returned only if the <ServiceType> submitted is “First Class”.  If any other <ServiceType> is returned (Including “First Class Commercial”) the <Container> tag is used.

 

string

default=VARIABLE
whiteSpace=collapse
enumeration=

·      Variable
Flat Rate Envelope

·      Padded Flat Rate Envelope

·      Legal Flat Rate Envelope

·      Sm Flat Rate Envelope

·      Window Flat Rate Envelope

·      Gift Card Flat Rate Envelope

·      Flat Rate Box
Sm Flat Rate Box

·      Md Flat Rate Box
Lg Flat Rate Box

·      REGIONALRATEBOXA

·      REGIONALRATEBOXB

·      REGIONALRATEBOXC

·      Rectangular
Nonrectangular

RateV4Request / Package / Size

required once

Defined as follows:

 

REGULAR: Package dimensions are 12’’ or less;

LARGE: Any package dimension is larger than 12’’.

 

For example: <Size>REGULAR</Size>

string

whiteSpace=collapse
enumeration=LARGE
enumeration=REGULAR

RateV4Request / Package / Width

optional

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


For example: <Width>5.5</Width>

string

minExclusive=0.0
totalDigits=10

RateV4Request / Package / Length

optional

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


For example: <Length>11</Length>

string

minExclusive=0.0
totalDigits=10

RateV4Request / Package / Height

optional

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


For example: <Height>11</Height>

string

minExclusive=0.0
totalDigits=10

RateV4Request / Package / Girth

optional

Value must be numeric. Units are inches. Required when RateV4Request/Size is LARGE, and RateV4Request/Container is NONRECTANGULAR or VARIABLE/NULL.

 

For example: <Girth>11</Girth>

string

minExclusive=0.0
totalDigits=10

RateV4Request / Package / Value

optional

Available when RateV4Request[Revision='2'].

 

Package value.  Used to determine availability and cost of extra services.

 

For example: <Value>150.00</Value>

string

minExclusive=0.0
totalDigits=10

RateV4Request / Package / AmountToCollect

optional

Available when RateV4Request[Revision='2'].

 

Collect on delivery amount.  Used to determine availability and cost of extra services.

 

For example: <AmountToCollect>150.00</AmountToCollect>

string

minExclusive=0.0
totalDigits=10

RateV4Request / Package / SpecialServices

optional

Available when RateV4Request[Revision='2'].

 

Groups the SpecialServices elements.

 

Special Services prices and availability will not be returned when Service = “ALL” or “ONLINE”

(group)

 

RateV4Request / Package / SpecialServices / SpecialService

optional, repeating up to 10 times

Available when RateV4Request[Revision='2'].

 

Defines extra services desired in order to determine cost of desired services and availability of other, additional services.

 

An initial rate call without the SpecialService tag specified is recommended to determine base availability of special services for each mail service.

The extra service definitions are as follows:

Special Service Name

ServiceID

Insurance

100

Insurance – Priority Mail

101

Return Receipt

102

Collect on Delivery

103

Certificate of Mailing (Form 3665)

104

Certified Mail

105

USPS Tracking

106

Return Receipt for Merchandise

107

Signature Confirmation

108

Registered Mail

109

Return Receipt Electronic

110

Registered mail COD collection Charge

112

Return Receipt – Priority Mail Express

118

Adult Signature Required

119

Adult Signature Restricted Delivery

120

Insurance – Priority Mail Express

125

Signature Confirmation Electronic

156

Certificate of Mailing (Form 3817)

160

Priority Mail Express 1030 AM Delivery

161

Certified Mail Restricted Delivery

170

Certified Mail Adult Signature Required

171

Certified Mail Adult Signature Restricted Delivery

172

Signature Confirm. Restrict. Delivery

173

Signature Confirmation Electronic Restricted Delivery

174

Collect on Delivery Restricted Delivery

175

Registered Mail Restricted Delivery

176

Insurance Restricted Delivery

177

Insurance Restrict.  Delivery – Priority Mail

178

Insurance Restrict. Delivery – Priority Mail Express

179

Insurance Restrict. Delivery (Bulk Only)

180

 

For example:

<SpecialServices>

<SpecialService>1<SpecialService>

<SpecialService>13<SpecialService>

</SpecialServices>

string

Enumerations=

100

101

102

103

104

105

106

107

108

109

110

112

118

119

120

125

156

160

161

170

171

172

173

174

175

176

177

178

179

180

RateV4Request / Package / Content

optional

Available when RateV4Request[Revision='2'].

 

Groups the ContentType and ContentDescription elements.

group

 

RateV4Request / Package / Content / ContentType

optional

Available when RateV4Request[Revision=’2’].

 

Defines the type of content of the package.

string

enumeration=

HAZMAT

CREMATEDREMAINS

LIVES

RateV4Request / Package / Content / ContentDescription

optional

Available when RateV4Request[Revision=’2’].

 

Describes the content of the package. Optional but required for ContentType ‘LIVES’.

string

enumeration=

BEES

DAYOLDPOULTRY

ADULTBIRDS

OTHER

RateV4Request / Package / GroundOnly

optional

Available when RateV4Request[Revision=’2’].

 

RateV4Request[Service=’STANDARD POST’]

 

Use “true” when shipment contains mailable hazardous materials, live animals and other “surface-only” items. Please see Standard Post section at http://pe.usps.com/businessmail101/classes/packageServices.htm.

string

Default=false

enumeration=false

enumeration=true

RateV4Request / Package / SortBy

optional

Available when RateV4Request[Revision='2'].

 

Returns all mailing services available based on item shape.  When specified, value in <Container> is ignored.

 

Available when:

RateV4Request[Service='ALL'] RateV4Request[Service='ONLINE']

 

For example: <SortBy>PACKAGE</SortBy>

 

default=CONTAINER

enumeration=

LETTER

LARGEENVELOPE

PACKAGE

FLATRATE

RateV4Request / Package / Machinable

optional

RateV4Request/Machinable is required when:

 

RateV4Request[Service='FIRST CLASS' and (FirstClassMailType='LETTER' or FirstClassMailType='FLAT')] RateV4Request[Service='STANDARD POST'] RateV4Request[Service='ALL'] RateV4Request[Service='ONLINE']


For example: <Machinable>true</Machinable>

string

whiteSpace=collapse

enumeration=true

enumeration=false

RateV4Request / Package / ReturnLocations

optional

Include Dropoff Locations in Response if available. Requires "ShipDate" tag.

string

default=true

enumeration=true

enumeration=false

RateV4Request / Package / ReturnServiceInfo

optional

Include mail service specific information in Response if available.

string

enumeration=false

enumeration=true

RateV4Request /

Package /

DropOffTime

optional

Time Package Will Be Mailed. Enter drop off time in format: HH:mm, such as 13:45.

 

Inclusion of Drop Off Time will result increased accuracy of <CommitmentName> and <CommitmentDate> in the response for Priority Mail and Priority Mail Express variants.

 

Example:

<DropOffTime>13:45</DropOffTime>

string

 

RateV4Request / Package / ShipDate

optional

Date Package Will Be Mailed. Ship date may be today plus 0 to 3 days in advance. Enter the date in format: yyyy-mm-dd, such as 2013-07-28.

 

Inclusion of Ship Date will result in <CommitmentName> and <CommitmentDate> in the response for Priority Mail and Priority Mail Express variants


Example:

<ShipDate Option="HFP">2013-07-28</ShipDate>

string

pattern=\d{2}-[a-zA-z]{3}-\d{4}

RateV4Request / Package / ShipDate / @Option

optional

The value of this attribute specifies how the RateV4Response will structure the Priority Express Mail Commitment data elements.

string

default=PEMSH
enumeration=PEMSH
enumeration=HFP

 

Sample Requests

All requests should hit the http://production.shippingapis.com/ShippingAPI.dll end point with the API=RateV4 and XML=<the sample XML request below> key value pairs using either a HTTP POST or a HTTP GET.

Request with Revision Tag:

<RateV4Request USERID="xxx">

<Revision>2</Revision>

<Package ID="1ST">

<Service>FIRST CLASS</Service>

<FirstClassMailType>LETTER</FirstClassMailType>

<ZipOrigination>44106</ZipOrigination>

<ZipDestination>20770</ZipDestination>

<Pounds>0</Pounds>

<Ounces>3.5</Ounces>

<Container/>

<Size>REGULAR</Size>

<Machinable>true</Machinable>

</Package>

<Package ID="2ND">

<Service>PRIORITY</Service>

<ZipOrigination>44106</ZipOrigination>

<ZipDestination>20770</ZipDestination>

<Pounds>1</Pounds>

<Ounces>8</Ounces>

<Container>NONRECTANGULAR</Container>

<Size>LARGE</Size>

<Width>15</Width>

<Length>30</Length>

<Height>15</Height>

<Girth>55</Girth>

<Value>1000</Value>

<SpecialServices>

<SpecialService>1</SpecialService>

</SpecialServices>

</Package>

<Package ID="3RD">

<Service>ALL</Service>

<ZipOrigination>90210</ZipOrigination>

<ZipDestination>96698</ZipDestination>

<Pounds>8</Pounds>

<Ounces>32</Ounces>

<Container/>

<Size>REGULAR</Size>

<Machinable>true</Machinable>

<DropOffTime>23:59</DropOffTime>

<ShipDate>2013-07-28</ShipDate>

</Package>

</RateV4Request>

 

Request - Live Animal Sample:

<RateV4Request USERID="XXXXX">

<Revision>2</Revision>     

<Package ID="0">   

  <Service>priority</Service>

  <FirstClassMailType></FirstClassMailType>  

  <ZipOrigination>22201</ZipOrigination>   

  <ZipDestination>26301</ZipDestination>   

  <Pounds>8</Pounds>   

  <Ounces>2</Ounces>   

  <Container>Flat Rate Envelope</Container>   

  <Size>Regular</Size>

  <Width>0</Width>

  <Length>0</Length>

  <Height>0</Height>

  <Girth>0</Girth>

  <Content>

    <ContentType>LIVES</ContentType>

    <ContentDescription>OTHER</ContentDescription>

  </Content>   

  <Machinable>TRUE</Machinable>   

</Package>

</RateV4Request>

 


 

 

Response Tag Descriptions

Tag Name

Occurs

Description

Type

Validation

RateV4Response

required once

 

(group)

 

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

 

RateV4Response / Package

required once repeating up to 25 times

 

(group)

 

RateV4Response / Package / @ID

Required

Corresponds to ID attribute in request. 
For example: <Package ID="0"/>

NMTOKEN

 

RateV4Response / Package / ZipOrigination

required once

Origination ZIP Code from request  

string

whiteSpace=collapse
length=5
pattern=\d{5}  

RateV4Response / Package / ZipDestination

required once

Destination ZIP Code from request  

string

whiteSpace=collapse
length=5
pattern=\d{5}  

RateV4Response / Package / Pounds

required once

Package Weight (Pounds) from request  

integer

maxInclusive=70
minInclusive=0  

RateV4Response / Package / Ounces

required once

Package Weight (Ounces) from request  

decimal

maxInclusive=1120.0
minInclusive=0.0
totalDigits=10  

RateV4Response / Package / FirstClassMailType

optional

Appears when RateV4Request[Service='FIRST CLASS'].
For example: <FirstClassMailType>LETTER</FirstClassMailType> 

string

whiteSpace=collapse
enumeration=

LETTER
FLAT
PARCEL

POSTCARD  

PACKAGE SERVICE

RateV4Response / Package / Container

optional

Shipping Container (appears where applicable: RateV4Request[Service='ALL' or Service='PRIORITY EXPRESS*' or Service='PRIORITY*'])  

string

whiteSpace=collapse
enumeration=

Variable
Flat Rate Envelope

Padded Flat Rate Envelope

Legal Flat Rate Envelope
Sm Flat Rate Envelope
Window Flat Rate Envelope
Gift Card Flat Rate Envelope

Flat Rate Box
Sm Flat Rate Box

Md Flat Rate Box
Lg Flat Rate Box

REGIONALRATEBOXA

REGIONALRATEBOXB

REGIONALRATEBOXC

Rectangular
Nonrectangular    

RateV4Response / Package / Size

required once

Package Size from request  

string

whiteSpace=collapse
enumeration=

LARGE
REGULAR 

RateV4Response / Package / Width

optional

Package Width from request  

decimal

minExclusive=0.0
totalDigits=10  

RateV4Response / Package / Length

optional

Package Length from request  

decimal

minExclusive=0.0
totalDigits=10  

RateV4Response / Package / Height

optional

Package Height from request  

decimal

minExclusive=0.0
totalDigits=10  

RateV4Response / Package / Girth

optional

Package Girth from request  

decimal

minExclusive=0.0
totalDigits=10  

RateV4Response / Package / Machinable

optional

Machinable (appears where applicable: RateV4Request[Service='ALL' or Service='FIRST CLASS' or Service=’STANDARD POST'])  

string

enumeration=TRUE
enumeration=FALSE  

RateV4Response / Package / Zone

required once

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

string

 

RateV4Response / Package / Postage

required once repeating up to unbounded times

Postage tag contains a nested postal rate and service description.  

(group)

 

RateV4Response / Package / Postage / @CLASSID

required

A mail class identifier for the postage returned. Not necessarily unique within a <Package/>.                

integer

 

RateV4Response / Package / Postage / MailService

required once

Service Type name  

string

 

RateV4Response / Package / Postage / Rate

required once

Retail Rate  

decimal

 

RateV4Response / Package / Postage / CommercialRate

optional

Commercial Rate. Appears only where applicable and only when requested via RateV4Request[Service='ONLINE' or

Service='FIRST CLASS COMMERCIAL'

Service='FIRST CLASS HFP COMMERCIAL' Service='PRIORITY COMMERCIAL' or

Service='PRIORITY HFP COMMERCIAL' or Service='PRIORITY MAIL EXPRESS COMMERCIAL' or Service='PRIORITY MAIL EXPRESS SH COMMERCIAL' or

Service='PRIORITY MAIL EXPRESS HFP COMMERCIAL'].  

decimal

 

RateV4Response / Package / Postage / CommercialPlusRate

optional

Commercial Rate. Appears only where applicable and only when requested via RateV4Request[Service=’PLUS’ or

Service='PRIORITY CPP’ or

Service='PRIORITY HFP CPP’ or

Service='PRIORITY MAIL EXPRESS CPP’ or

Service='PRIORITY MAIL EXPRESS HFP CPP’].  

decimal

 

RateV4Response / Package / Postage / ServiceInformation

optional

Mail Service Information.  Appears where applicable: RateV4Request[ReturnServiceInfo=’true’] 

string

 

RateV4Response / Package / Postage / MaxDimensions

optional

Maximum dimensions for a USPS produced product. Appears where applicable: RateV4Request[SortBy<>’CONTAINER’]

string

 

RateV4Response / Package / Postage / (choice)

optional

This choice depends on the RateV4Request / ShipDate / @Option attribute. If the attribute is missing or has the enumeration value of PEMSH then the original Express Mail Sunday/Holiday structure is used. Otherwise, if the attribute has the enumeration value of HFP, then the Hold For Pickup structure is used. If RateV4Request / ShipDate is not present, then neither choice is returned.

(choice)

 

RateV4Response / Package / Postage / (choice) / (sequence)

if used:
required once

This sequence consisting of CommitmentDate and Location nodes is mutually exclusive with RateV4Response / Package / Postage / Commitment.

(group)

 

RateV4Response / Package / Postage / (choice) / (sequence) / CommitmentDate

required once

Calculated Date Package Will Be Delivered: yyyy-mm-dd, such as 2013-07-28. Only returned for Priority Mail Express Mail variants when "ShipDate" tag is present in the request.  

string

 

RateV4Response / Package / Postage / (choice) / (sequence) / Location

optional repeating up to 200 times

Collection of Dropoff Locations with Cutoff times. Only returned with Express Mail variants, when "ShipDate" tag is present in the request, and the "ReturnLocations" tag is not false. Example: <Location>
<CutOff>8:00 PM</CutOff>
<Facility>EXPRESS MAIL COLLECTION BOX</Facility>
<Street>9201 EDGEWORTH DR</Street>
<City>CAPITOL HEIGHTS</City>
<State>MD</State>
<Zip>20790</Zip>
</Location> 

(group)

 

RateV4Response / Package / Postage / (choice) / (sequence) / Location / CutOff

required once

Local cutoff time for drop-off  

string

 

RateV4Response / Package / Postage / (choice) / (sequence) / Location / Facility

required once

Facility Name  

string

 

RateV4Response / Package / Postage / (choice) / (sequence) / Location / Street

required once

Facility Address  

string

 

RateV4Response / Package / Postage / (choice) / (sequence) / Location / City

required once

Facility City  

string

 

RateV4Response / Package / Postage / (choice) / (sequence) / Location / State

required once

Facility State  

string

 

RateV4Response / Package / Postage / (choice) / (sequence) / Location / Zip

required once

Facility Zip  

string

 

RateV4Response / Package / Postage / (choice) / Commitment

if used:
required once repeating up to 5 times

This node is mutually exclusive with RateV4Response / Package / Postage / CommitmentDate and RateV4Response / Package / Postage / Location.  

(group)

 

RateV4Response / Package / Postage / (choice) / Commitment / CommitmentDate

required once

Calculated Date Package Will Be Delivered: yyyy-mm-dd, such as 2013-07-28. Only returned for Priority Mail Express Mail variants when "ShipDate" tag is present in the request.  

string

 

RateV4Response / Package / Postage / (choice) / Commitment / CommitmentTime

required once

Commitment time of day. Only returned for Priority Mail Express Mail variants when "ShipDate" tag is present in the request.  

string

enumeration=10:30 AM
enumeration=12:00 PM
enumeration=3:00 PM

RateV4Response / Package / Postage / (choice) / Commitment / Location

optional repeating up to 200 times

Collection of Dropoff Locations with Cutoff times. Only returned with Priority Mail Express Mail variants, when "ShipDate" tag is present in the request, and the "ReturnLocations" tag is not false. Example: <Location>
<CutOff>8:00 PM</CutOff>
<Facility>EXPRESS MAIL COLLECTION BOX</Facility>
<Street>9201 EDGEWORTH DR</Street>
<City>CAPITOL HEIGHTS</City>
<State>MD</State>
<Zip>20790</Zip>
</Location> 

(group)

 

RateV4Response / Package / Postage / (choice) / Commitment / Location / CutOff

required once

Local cutoff time for drop-off  

string

 

RateV4Response / Package / Postage / (choice) / Commitment / Location / Facility

required once

Facility Name  

string

 

RateV4Response / Package / Postage / (choice) / Commitment / Location / Street

required once

Facility Address  

string

 

RateV4Response / Package / Postage / (choice) / Commitment / Location / City

required once

Facility City  

string

 

RateV4Response / Package / Postage / (choice) / Commitment / Location / State

required once

Facility State  

string

 

RateV4Response / Package / Postage / (choice) / Commitment / Location / Zip

required once

Facility Zip  

string

 

RateV4Response / Package / Postage / SpecialServices

optional

Returned when RateV4Request[Revision='2'].

 

Groups the Special Service elements.

(group)

 

RateV4Response / Package / Postage / SpecialServices / SpecialService

required once, repeating up to unbounded times

Returned when RateV4Request[Revision='2'].

 

“SpecialService” contains nested service name, availability, and pricing.

(group)

 

RateV4Response / Package / Postage / SpecialServices / SpecialService / ServiceID

required once

Returned when RateV4Request[Revision='2'].

 

Special service ID

Integer

 

RateV4Response / Package / Postage / SpecialServices / SpecialService / ServiceName

requifred once

Returned when RateV4Request[Revision='2'].

 

Special service name

string

 

RateV4Response / Package / Postage / SpecialServices / SpecialService / Available

required once

Returned when RateV4Request[Revision='2'].

 

Availability of special service.  Availability may change depending on special services passed (selected) in request.

boolean

 

RateV4Response / Package / Postage / SpecialServices / SpecialService / AvailableOnline

required once

Returned when RateV4Request[Revision='2'].

 

Availability of special service for online only rates.  Not all special services have online rates.

boolean

 

RateV4Response / Package / Postage / SpecialServices / SpecialService / Price

required once

Returned when RateV4Request[Revision='2'].

 

Special service pricing. Pricing may change depending on special services passed (selected) in request.

decimal

 

RateV4Response / Package / Postage / SpecialServices / SpecialService / PriceOnline

required once

Returned when RateV4Request[Revision='2'].

 

Special service pricing. Pricing may change depending on special services passed (selected) in request. Not all special services have online rates.

decimal

 

RateV4Response / Package / Postage / SpecialServices / SpecialService / DeclaredValueRequired

optional

Returned if applicable when RateV4Request[Revision='2'].

 

Indicates if special service requires a declared package value (specified in RateV4Request[Value])to determine correct pricing.

boolean

 

RateV4Response / Package / Postage / SpecialServices / SpecialService / DueSenderRequired

optional

Returned if applicable when RateV4Request[Revision='2'].

 

Indicates if special service requires a due sender amount (specified in RateV4Request[AmountToCollect]) to determine correct pricing.

boolean

 

RateV4Response / Package / Restrictions

optional

APO/FPO Restrictions provided if the Destination ZIP Code is an APO/FPO ZIP Code.  

string

 

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

 

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

 

RateV4Response / Package / Error

if used:
required once

Error document (indicates request could not be completed).  

See "Error" Responses below

 See the Error Responses section below.

 

Sample Response

All requests should hit the http://production.shippingapis.com/ShippingAPI.dll end point with the API=RateV4 and XML=<the sample XML request below> key value pairs using either a HTTP POST or a HTTP GET.

Revision ‘2’ Response:

<RateV4Response>

      <Package ID="1ST">

            <ZipOrigination>44106</ZipOrigination>

            <ZipDestination>20770</ZipDestination>

            <Pounds>0</Pounds>

            <Ounces>3.5</Ounces>

            <FirstClassMailType>LETTER</FirstClassMailType>

            <Size>REGULAR</Size>

            <Machinable>TRUE</Machinable>

            <Zone>3</Zone>

            <Postage CLASSID="0">

                 <MailService>First-Class Mail</MailService>

                 <Rate>1.06</Rate>

                 <SpecialServices>

                      <SpecialService>

                           <ServiceID>9</ServiceID>

                           <ServiceName>Certificate of Mailing</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>1.20</Price>

                           <PriceOnline>0</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>1</ServiceID>

                           <ServiceName>Insurance</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>1.95</Price>

                           <PriceOnline>0</PriceOnline>

                           <DeclaredValueRequired>true</DeclaredValueRequired>

                           <DueSenderRequired>false</DueSenderRequired>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>5</ServiceID>

                           <ServiceName>Registered Mail&lt;sup&gt;&#8482;&lt;/sup&gt;</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>11.20</Price>

                           <PriceOnline>0</PriceOnline>

                           <DeclaredValueRequired>true</DeclaredValueRequired>

                           <DueSenderRequired>false</DueSenderRequired>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>4</ServiceID>

                           <ServiceName>Registered without Insurance</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>11.20</Price>

                           <PriceOnline>0</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>0</ServiceID>

                           <ServiceName>Certified Mail&lt;sup&gt;&#174;&lt;/sup&gt;</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>3.10</Price>

                            <PriceOnline>0</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>6</ServiceID>

                           <ServiceName>Collect on Delivery</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>6.45</Price>

                           <PriceOnline>0</PriceOnline>

                           <DeclaredValueRequired>true</DeclaredValueRequired>

                           <DueSenderRequired>true</DueSenderRequired>

                      </SpecialService>

                 </SpecialServices>

            </Postage>

            <Restrictions />

       </Package>

       <Package ID="2ND">

            <ZipOrigination>44106</ZipOrigination>

            <ZipDestination>20770</ZipDestination>

            <Pounds>1</Pounds>

            <Ounces>8</Ounces>

            <Container>NONRECTANGULAR</Container>

            <Size>LARGE</Size>

            <Width>15</Width>

            <Length>30</Length>

            <Height>15</Height>

            <Girth>55</Girth>

            <Zone>3</Zone>

            <Postage CLASSID="1">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt;</MailService>

                 <Rate>24.85</Rate>

                 <SpecialServices>

                      <SpecialService>

                           <ServiceID>1</ServiceID>

                           <ServiceName>Insurance</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>true</AvailableOnline>

                           <Price>13.15</Price>

                           <PriceOnline>13.15</PriceOnline>

                           <DeclaredValueRequired>true</DeclaredValueRequired>

                           <DueSenderRequired>false</DueSenderRequired>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>13</ServiceID>

                           <ServiceName>Delivery Confirmation&lt;sup&gt;&#8482;&lt;/sup&gt;;</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>true</AvailableOnline>

                           <Price>0.00</Price>

                           <PriceOnline>0.00</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>4</ServiceID>

                           <ServiceName>Restricted Delivery</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>4.75</Price>

                           <PriceOnline>0</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>8</ServiceID>

                           <ServiceName>Return Receipt</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>2.55</Price>

                            <PriceOnline>0</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>16</ServiceID>

                           <ServiceName>Return Receipt Electronic</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>false</AvailableOnline>

                           <Price>1.25</Price>

                            <PriceOnline>0</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>15</ServiceID>

                           <ServiceName>Signature Confirmation&lt;sup&gt;&#8482;&lt;/sup&gt;</ServiceName>

                           <Available>true</Available>

                           <AvailableOnline>true</AvailableOnline>

                           <Price>2.70</Price>

                           <PriceOnline>2.20</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>19</ServiceID>

                           <ServiceName>Adult Signature Required</ServiceName>

                           <Available>false</Available>

                           <AvailableOnline>true</AvailableOnline>

                           <Price>0</Price>

                           <PriceOnline>4.95</PriceOnline>

                      </SpecialService>

                      <SpecialService>

                           <ServiceID>20</ServiceID>

                           <ServiceName> Adult Signature Restricted Delivery</ServiceName>

                           <Available>false</Available>

                           <AvailableOnline>true</AvailableOnline>

                           <Price>0</Price>

                           <PriceOnline>5.15</PriceOnline>

                      </SpecialService>

                 </SpecialServices>

            </Postage>

            <Restrictions />

       </Package>

       <Package ID="3RD">

            <ZipOrigination>90210</ZipOrigination>

            <ZipDestination>96698</ZipDestination>

            <Pounds>8</Pounds>

            <Ounces>32</Ounces>

            <Container>VARIABLE</Container>

            <Size>REGULAR</Size>

            <Machinable>TRUE</Machinable>

            <Zone>4</Zone>

            <Postage CLASSID="1">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt;</MailService>

                 <Rate>18.35</Rate>

            </Postage>

            <Postage CLASSID="22">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Large Flat Rate Box</MailService>

                 <Rate>14.85</Rate>

            </Postage>

            <Postage CLASSID="17">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Medium Flat Rate Box</MailService>

                 <Rate>12.35</Rate>

            </Postage>

            <Postage CLASSID="28">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Small Flat Rate Box</MailService>

                 <Rate>5.80</Rate>

            </Postage>

            <Postage CLASSID="16">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Flat Rate Envelope</MailService>

                 <Rate>5.60</Rate>

            </Postage>

            <Postage CLASSID="44">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Legal Flat Rate Envelope</MailService>

                 <Rate>5.75</Rate>

            </Postage>

            <Postage CLASSID="29">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Padded Flat Rate Envelope</MailService>

                 <Rate>5.95</Rate>

            </Postage>

            <Postage CLASSID="38">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Gift Card Flat Rate Envelope</MailService>

                 <Rate>5.60</Rate>

            </Postage>

            <Postage CLASSID="42">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Small Flat Rate Envelope</MailService>

                 <Rate>5.60</Rate>

            </Postage>

            <Postage CLASSID="40">

                 <MailService>Priority Mail&lt;sup&gt;&#174;&lt;/sup&gt; Window Flat Rate Envelope</MailService>

                 <Rate>5.60</Rate>

            </Postage>

http://stg-production.shippingapis.com/ShippingAPI.dll - #            <Postage CLASSID="4">

                 <MailService>Standard Post&lt;sup&gt;&#174;&lt;/sup&gt;</MailService>

                 <Rate>18.35</Rate>

            </Postage>

            <Postage CLASSID="6">

                 <MailService>Media Mail&lt;sup&gt;&#174;&lt;/sup&gt;</MailService>

                 <Rate>6.52</Rate>

            </Postage>

            <Postage CLASSID="7">

                 <MailService>Library Mail</MailService>

                 <Rate>6.21</Rate>

            </Postage>

            <Restrictions>A1. Mail addressed to “Any Servicemember” or similar <!--1772 skipped-->.</Restrictions>

 

       </Package>

  </RateV4Response>          

Error Responses

Error conditions are handled at the main XML document level and Package node 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.  But if there is a problem with a specific Package within the request, an <Error> element will be returned within the <Package> element that pertains to the specific package ID.  Since the RateV4 API allows you to submit multiple packages within a single request document, the response may contain a mix of domestic rate information and errors.  For requests containing multiple package IDs, you need to check if there is an <Error> within a given <Package> element, as well as checking for an error at the top level for example:

<?xml version="1.0"?>

<RateV4Response>

  <Package ID="0">

    <ZipOrigination>07747</ZipOrigination>

    <ZipDestination>90210</ZipDestination>

    <Pounds>11</Pounds>

    <Ounces>4</Ounces>

    <Container>VARIABLE</Container>

    <Size>REGULAR</Size>

    <Zone>8</Zone>

    <Postage CLASSID="3">

      <MailService>Priority Mail Express&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt;</MailService>

      <Rate>92.85</Rate>

    </Postage>

  </Package>

  <Package ID="1">

    <Error>

      <Number>-2147219498</Number>

      <Source>DomesticRatesV4;RateEngineV4.ProcessRequest</Source>

      <Description>Please enter a valid ZIP Code for the sender.  </Description>

      <HelpFile></HelpFile>

      <HelpContext>1000440</HelpContext>

    </Error>

  </Package>

</RateV4Response>

 

If you need assistance with an error response, contact the USPS Internet Customer Care Center (ICCC) uspstechnicalsupport@mailps.custhelp.com


 

 

International Rates API – IntlRateV2

Overview

The IntlRateV2 API lets customers calculate the rate for international packages and envelopes given the weight and dimensions of the item.  The IntlRateV2 API limits the data requested to twenty five (25) packages per transaction.

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

API Signature

Scheme

Host

Path

API

XML

http://

production.shippingapis.com

/ShippingAPI.dll

?API=IntlRateV2

&XML=(see Tag Descriptions below)

Request Tag Descriptions

Tag Name

Occurs

Description

Type

Validation

IntlRateV2Request

required once

Opening document tag.  

(group)

 

IntlRateV2Request / @USERID

required

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

NMTOKEN

 

IntlRateV2Request / Revision

optional

Optional for base IntlRateV2 functionality. 

 

For full IntlRateV2 functionality use Revision=“2”

string

 

IntlRateV2Request / Package

required once repeating up to 25 times

Opening Package tag.  

(group)

 

IntlRateV2Request / Package / @ID

required

No restriction on number or type of characters provided valid XML syntax and unique to request. 
For example: <Package ID="0">...</Package>

NMTOKEN

 

IntlRateV2Request / Package / Pounds

required once

Value must be numeric. Package weight generally cannot exceed 70 pounds. Refer to the International Mail Manual (IMM) for weight requirements per country and mail service. The IMM can be found at the Postal Explorer web site.

For example: <Pounds>2</Pounds>  

integer

minInclusive=0  

IntlRateV2Request / Package / Ounces

required once

Value must be numeric. Package weight generally cannot exceed 70 pounds. Refer to the International Mail Manual (IMM) for weight requirements per country and mail service. The IMM can be found at the Postal Explorer web site

For example: <Ounces>4</Ounces>

decimal

minInclusive=0.0  

IntlRateV2Request / Package / 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.217 for more information. 

For example: <Machinable>True</Machinable>

boolean

default=true
 

IntlRateV2Request / Package / MailType

required once

Package type being shipped. One of:
Package
Postcards

Envelope

Letter

LargeEnvelope

FlatRate

FlatRateBox

 

For example: <MailType>Package</MailType>

string

enumeration=All
enumeration=Package

enumeration=Postcards
enumeration=Envelope

enumeration=Letter

enumeration=LargeEnvelope

enumeration=FlatRate

enumeration=FlatRateBox

IntlRateV2Request / Package / GXG

optional

If GXG rate is desired, then this group must be specified. Note that if this data precludes delivery, due to size or availability of service at the destination, then GXG rates simply will not be returned (not an error condition.)  

(group)

 

IntlRateV2Request / Package / GXG / POBoxFlag

required once

Specify as "Y" if the destination is a post office box.  

For example <POBoxFlag>Y</POBoxFlag>

string

enumeration=Y
enumeration=N

IntlRateV2Request / Package / GXG / GiftFlag

required once

Specify as "Y" if the package contains a gift.  

For example <GiftFlag>Y</GiftFlag>

string

enumeration=Y
enumeration=N

IntlRateV2Request / Package / ValueOfContents

required once

If specified, used to compute Insurance fee (if insurance is available for service and destination) and indemnity coverage.


For example: <ValueOfContents>103.00</ValueOfContents> 

decimal

minExclusive=0.0  

IntlRateV2Request / Package / Country

required once

Entries must be from the USPS list of valid countries from the International Country Listings. To access the International Country Listings, go to the Index of Countries and Localities.

For example: <Country>Albania</Country>  

string

 

IntlRateV2Request / Package / Container

required once

Use to specify special containers or container attributes that may affect postage.  Required when Size=”LARGE”.

 

For example: <Container>RECTANGULAR</Container> 

string

enumeration=RECTANGULAR
enumeration=NONRECTANGULAR

IntlRateV2Request / Package / Size

required once

Defined as follows:

 

REGULAR: Package dimensions are 12’’ or less;

LARGE: Any package dimension is larger than 12’’.

 

For example: <Size>REGULAR</Size> 

string

enumeration=REGULAR
enumeration=LARGE

IntlRateV2Request / Package / Width

required once

Typically, the "thickness" of the package as measured in inches rounded to the nearest whole inch.  Required to obtain GXG pricing and when Size=”LARGE”.

For example: <Width>15</Width>

integer

minExclusive=0  

IntlRateV2Request / Package / Length

required once

The longest side of the package as measured in inches rounded to the nearest whole inch.  Required to obtain GXG pricing and when Size=”LARGE”.

For example: <Length>15</Length>

integer

minExclusive=0  

IntlRateV2Request / Package / Height

required once

The "height" of the package as measured in inches rounded to the nearest whole inch.  Required to obtain GXG pricing and when Size=”LARGE”.

For example: <Height>15</ Height >

integer

minExclusive=0  

IntlRateV2Request / Package / Girth

required once

The "girth" of the package as measured in inches rounded to the nearest whole inch.  Required to obtain GXG pricing when pricing and when Size=”LARGE” and Container=”NONRECTANGULAR”.

For example: <Girth>15</Girth>

Integer

minExclusive=0  

IntlRateV2Request / Package / OriginZip

optional

Available when IntlRateV2Request[Revision='2'].

 

Origin ZIP Code is required to determine Priority Mail International price to Canadian destinations and is used to determine mailability of Global Express Guaranteed. When provided, the response will return a list of Post Office locations where GXG is accepted. The Origin ZIP Code must be valid.

For example: <OriginZip>20770</OriginZip> 

string

length=5
pattern=\d{5}  

IntlRateV2Request / Package / CommercialFlag

optional

Returns commercial base postage.

For example: <CommercialFlag>Y<CommercialFlag>

string

enumeration=Y
enumeration=N

IntlRateV2Request / Package / CommercialPlusFlag

optional

Returns commercial plus postage.

For example: <CommercialPlusFlag>Y<CommercialPlusFlag>

string

enumeration=Y
enumeration=N

IntlRateV2Request / Package / ExtraServices

optional

Available when IntlRateV2Request[Revision='2'].

 

Groups the ExtraService elements.  

(group)

 

IntlRateV2Request / Package / ExtraServices / ExtraService

required once, repeating up to 6 times

Available when IntlRateV2Request[Revision='2'].

 

Defines extra services desired by user in order to determine cost of desired services and availability of other, additional services. 

 

An initial rate call without the ExtraService tag specified is recommended to determine base availability of extra services for each mail service.

 

The extra service definitions are as follows:

Extra Service Name

ServiceID

Registered Mail

0

Insurance

1

Return Receipt

2

Certificate of Mailing

6

Electronic USPS Delivery Confirmation International

9

 

For example:

<ExtraServices>

     <ExtraService>1<ExtraService>

     <ExtraService>5<ExtraService>

</ExtraServices>

integer

 

IntlRateV2Request/Package/ AcceptanceDateTime

optional

Available when IntlRateV2Request[Revision='2'].

 

Date and Time the package is accepted by USPS.  The AcceptanceDateTime tag along with the DestinationPostalCode is used to calculate the GuaranteeAvailability response tag for PMEI services in Kahala countries.

DateTime

ISO 8601 formatted date. 

YYYY-MM-DDThh:mm:ss+/-hh:mm

For example, 2014-01-22T14:30:51-06:00

IntlRateV2Request/Package/ DestinationPostalCode

optional

Available when IntlRateV2Request[Revision='2'].

 

Destination Postal Code

 

The AcceptanceDateTime tag along with the DestinationPostalCode is used to calculate the GuaranteeAvailability response tag for PMEI services in Kahala countries.

String

 

IntlRateV2Request/Package/ Content

optional

Used to describe the contents of the package.

(group)

 

IntlRateV2Request/Package/ Content/ContentType

Required if Content supplied.

Contains the enumerated description of the items in the package. 

 

CrematedRemains

 

Populate with CrematedRemains if any item in the package is cremated remains.

string

Enumeration=CrematedRemains

IntlRateV2Request/Package/ Content/ContentDescription

optional

For future use

string

 

 

Sample Requests

All requests should hit the http://production.shippingapis.com/ShippingAPI.dll end point with the API=IntlRateV2 and XML=<the sample XML request below> key value pairs using either a HTTP POST or a HTTP GET.

 

Request with Revision Tag:

<IntlRateV2Request USERID="prodsolclient">

  <Revision>2</Revision>

  <Package ID="1ST">

    <Pounds>15</Pounds>

    <Ounces>0</Ounces>

    <Machinable>True</Machinable>

    <MailType>Package</MailType>

    <GXG>

      <POBoxFlag>Y</POBoxFlag>

      <GiftFlag>Y</GiftFlag>

    </GXG>

    <ValueOfContents>200</ValueOfContents>

    <Country>Australia</Country>

    <Container>RECTANGULAR</Container>

    <Size>LARGE</Size>

    <Width>10</Width>

    <Length>15</Length>

    <Height>10</Height>

    <Girth>0</Girth>

    <OriginZip>18701</OriginZip>

    <CommercialFlag>N</CommercialFlag>

    <AcceptanceDateTime>2014-01-22T13:15:00-06:00</AcceptanceDateTime>

    <DestinationPostalCode>2046</DestinationPostalCode>

  </Package>

  <Package ID="2ND">

    <Pounds>0</Pounds>

    <Ounces>3</Ounces>

    <MailType>Envelope</MailType>

    <ValueOfContents>75</ValueOfContents>

    <Country>Algeria</Country>

    <Container> </Container>

    <Size>REGULAR</Size>

    <Width></Width>

    <Length></Length>

    <Height></Height>

    <Girth></Girth>

    <OriginZip/>

    <CommercialFlag>N</CommercialFlag>

    <ExtraServices>

      <ExtraService>6</ExtraService>

    </ExtraServices>

  </Package>

</IntlRateV2Request>

 

Response Tag Descriptions

Tag Name

Occurs

Description

Type

Validation

IntlRateV2Response

required once

Opening document tag.  

(group)

 

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

 

IntlRateV2Response / Package

required once repeating up to 25 times

Corresponds to each "Package" node in the request. Each "Package" node will contain either an "Error" node or the rate results.  

(group)

 

IntlRateV2Response / Package / @ID

required

Package Identification Number (matches IntlRateV2Request/Package/@ID) 

NMTOKEN

 

IntlRateV2Response / Package / Prohibitions

required once

Prohibitions  

string

 

IntlRateV2Response / Package / Restrictions

required once

Restrictions  

string

 

IntlRateV2Response / Package / Observations

required once

Observations  

string

 

IntlRateV2Response / Package / CustomsForms

required once

Customs Forms  

string

 

IntlRateV2Response / Package / ExpressMail

required once

Express Mail  

string

 

IntlRateV2Response / Package / AreasServed

required once

Areas Served  

string

 

IntlRateV2Response / Package / AdditionalRestrictions

required once

Additional restrictions on items being shipped to destination country  

string

 

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

 

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

 

IntlRateV2Response /  Package / Content

optional

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

(group)

 

IntlRateV2Response / Package / Content /

ContentType

optional

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

string

 

IntlRateV2Response / Package / Content /

ContentDescription

optional

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

string

 

IntlRateV2Response / Package / Service

required once repeating up to unbounded times

"Service" tag contains a nested rate and service name.  

(group)

 

IntlRateV2Response / Package / Service / @ID

required

An integer reflective of the <SvcDescription/>.

integer

minInclusive=0 

IntlRateV2Response / Package / Service / Pounds

required once

Weight of package (pounds)  

integer

 

IntlRateV2Response / Package / Service / Ounces

required once

Weight of package (ounces)  

decimal

 

IntlRateV2Response / Package / Service / Machinable

optional

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / MailType

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / GXG

optional

If specified in request this is echoed back if relevant to computed postage.  

(group)

 

IntlRateV2Response / Package / Service / GXG / POBoxFlag

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / GXG / GiftFlag

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / Container

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / Size

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / Width

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / Length

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / Height

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / Girth

required once

If specified in request this is echoed back if relevant to computed postage.  

string

 

IntlRateV2Response / Package / Service / Country

required once

Destination Country  

string

 

IntlRateV2Response / Package / Service / Postage

required once

Postage Rate Charged  

decimal

 

IntlRateV2Response / Package / Service / CommercialPostage

optional

Commercial Base Rate.  Returned if specified in request.

decimal

 

IntlRateV2Response / Package / Service / CommercialPlusPostage

optional

Commercial Plus Rate.  Returned if specified in request.

decimal

 

IntlRateV2Response / Package / Service / ExtraServices

required once

Groups the Extra Service elements.

(group)

 

IntlRateV2Response / Package / Service / ExtraServices / ExtraService

optional, repeating up to unbounded times

“ExtraService” contains nested service name, availability, and pricing.

 

When IntlRateV2Request[Revision<'2'], the only service returned is Insurance.

 

(group)

 

IntlRateV2Response / Package / Service / ExtraServices / ExtraService / ServiceID

required once

Extra service ID

integer

 

IntlRateV2Response / Package / Service / ExtraServices / ExtraService / ServiceName

required once

Extra service name

string

 

IntlRateV2Response / Package / Service / ExtraServices / ExtraService / Available

required once

Availability of extra service.  Availability may change depending on extra services passed (selected) in request.

boolean

 

IntlRateV2Response / Package / Service / ExtraServices / ExtraService / OnlineAvailable

optional

Availability of online pricing for extra service.  Availability may change depending on extra services passed (selected) in request.

 

Returns when IntlRateV2Request[Revision='2'] and IntlRateV2Request[CommercialPrice=’Y'].

 

boolean

 

IntlRateV2Response / Package / Service / ExtraServices / ExtraService / Price

required once

Extra service pricing. Pricing may change depending on extra services passed in request.

 

When IntlRateV2Request[Revision<'2'], the insurance fee is fully calculated.

 

decimal

 

IntlRateV2Response / Package / Service / ExtraServices / ExtraService OnlinePrice

optional

Online extra service pricing. Pricing may change depending on extra services passed in request.

 

Returns when IntlRateV2Request[Revision='2'] and IntlRateV2Request[CommercialPrice=’Y'].

 

decimal

 

IntlRateV2Response / Package / Service / ExtraServices / ExtraService DeclaredValueRequired

optional

Indicates if package value is required to calculate extra service rate.

 

Returns when IntlRateV2Request[Revision='2'].

 

boolean

 

IntlRateV2Response / Package / Service / ValueOfContents

optional

This echoes back the value provided in the request. This value is used to calculate the insurance fee (ServiceID=1 under Extra Services) or the Insurance Comment explaining why Insurance Fee is not given.

decimal

pattern=\d+\.\d\d  

IntlRateV2Response / Package / Service / InsComment

optional

Returned when IntlRateV2Request[Revision<'2'] only.

 

Explains why no insurance fee is returned, one of three reasons: SERVICE means insurance is not available for this service; DESTINATION means that insurance is not available to the given country via this service; INSURED VALUE means insurance is available for the country and service, but not for the given value.  

string

enumeration=SERVICE
enumeration=DESTINATION
enumeration=INSURED VALUE  

IntlRateV2Response / Package / Service / ParcelIndemnityCoverage

optional

Contains lesser of Maximum Parcel Indemnity Coverage per given weight and ValueOfContents, if applicable; otherwise, it is omitted.  

decimal

pattern=\d+\.\d\d  

IntlRateV2Response / Package / Service / SvcCommitments

required once

Service Commitments  

string

 

IntlRateV2Response / Package / Service / SvcDescription

required once

Service Description  

string

 

IntlRateV2Response / Package / Service / MaxDimensions

required once

Maximum Dimensions of Package Allowed  

string

 

IntlRateV2Response / Package / Service / MaxWeight

required once

Maximum Weight of Package Allowed  

integer

 

IntlRateV2Response / Package / Service / GuaranteeAvailability

Optional once

If the Revision tag >= 2 in the request, the service  type is one of the following:  Priority Express Mail International, PMEI Flat Rate Envelope, PMEI Flat Rate Box, PMEI Legal Flat Reate Envelope, and PMEI Padded Flat Rate Envelope, and the country is a Kahala country, the GuaranteeAvailability tag will display the estimated scheduled delivery date.  If not, the tag will contain the estimated scheduled delivery days.

string

If an estimated scheduled delivery date is available, the format will be

MM/DD/YYYY

 

, e.g,

 

01/29/2014. 

 

If an estimated scheduled delivery date is not available, the formate will be a string, e.g.,

 

3 - 5 business days to many major markets

 

IntlRateV2Response / Package / Service / GXGLocations

optional

Mailing locations for GXG packages.  Based on OriginZip sent in request.

(group)

 

IntlRateV2Response / Package / Service / GXGLocations / PostOffice

optional

Individual Post Office information for mailing GXG packages.

(group)

 

IntlRateV2Response / Package / Service / GXGLocations / PostOffice / Name

required once

Name of Post Office.

string

 

IntlRateV2Response / Package / Service / GXGLocations / PostOffice / Address

required once

Street Address of Post Office.

string

 

IntlRateV2Response / Package / Service / GXGLocations / PostOffice / City

required once

City in which Post Office is located.

string

 

IntlRateV2Response / Package / Service / GXGLocations / PostOffice / State

required once

State in which Post Office is located.

string

 

IntlRateV2Response / Package / Service / GXGLocations / PostOffice / ZipCode

required once

Zip Code of Post Office.

string

 

IntlRateV2Response / Package / Service / GXGLocations / PostOffice / RetailGXGCutOffTime

required once

Retail/GXG cut off time at location.

string

 

IntlRateV2Response / Package / Service / GXGLocations / PostOffice / SaturdayCutOffTime

required once

Saturday cut off time at location.

string

 

IntlRateV2Response / Package / Error

if used:
required once

 

See "Error" Responses Section below

 

 

Sample Response

All requests should hit the http://production.shippingapis.com/ShippingAPI.dll end point with the API=IntlRateV2 and XML=<the sample XML request below> key value pairs using either a HTTP POST or a HTTP GET.

 

Response with  Revision Tag:

 

<?xml version="1.0"?>

<IntlRateV2Response>

 

  <Package ID="1ST">

    <Prohibitions>Coins; bank notes; <!--Suppressed for example.--></Prohibitions>

    <Restrictions>Jewelry is permitt <!--Suppressed for example.--></Restrictions>

    <Observations>Duty may be levied <!--Suppressed for example.--></Observations>

    <CustomsForms>First-Class Mail I <!--Suppressed for example.--></CustomsForms>

    <ExpressMail>Country Code: AU Re <!--Suppressed for example.--></ExpressMail>

    <AreasServed>Please reference Express Mail for Areas Served.</AreasServed>

    <AdditionalRestrictions>No Additional Restrictions Data found.</AdditionalRestrictions>

    <Service ID="12">

      <Pounds>15</Pounds>

      <Ounces>0</Ounces>

      <Machinable>True</Machinable>

      <MailType>Package</MailType>

      <Container>RECTANGULAR</Container>

      <Size>LARGE</Size>

      <Width>10</Width>

      <Length>15</Length>

      <Height>10</Height>

      <Girth>0</Girth>

      <Country>AUSTRALIA</Country>

      <Postage>176.85</Postage>

      <ExtraServices>

        <ExtraService>

          <ServiceID>1</ServiceID>

          <ServiceName>Insurance</ServiceName>

          <Available>True</Available>

          <Price>1.00</Price>

          <DeclaredValueRequired>True</DeclaredValueRequired>

        </ExtraService>

      </ExtraServices>

      <ValueOfContents>200.00</ValueOfContents>

      <SvcCommitments>1 - 3 business days to many major markets</SvcCommitments>

      <SvcDescription>USPS GXG&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt; Envelopes**</SvcDescription>

      <MaxDimensions>USPS-Produced regular size cardboard envelope (12-1/2" x 9-1/2"), the legal-sized cardboard envelope (15" x 9-1/2") and the GXG Tyvek envelope (15-1/2" x 12-1/2")</MaxDimensions>

      <MaxWeight>70</MaxWeight>

     

      <GXGLocations>

        <PostOffice>

          <Name>WILKES BARRE P&amp;DC</Name>

          <Address>300 S MAIN ST</Address>

          <City>WILKES BARRE</City>

          <State>PA</State>

          <ZipCode></ZipCode>

          <RetailGXGCutOffTime>5:00 PM</RetailGXGCutOffTime>

          <SaturDayCutOffTime>2:00 PM</SaturDayCutOffTime>

        </PostOffice>

      </GXGLocations>

    </Service>

    <Service ID="1">

      <Pounds>15</Pounds>

      <Ounces>0</Ounces>

      <Machinable>True</Machinable>

      <MailType>Package</MailType>

      <Container>RECTANGULAR</Container>

      <Size>LARGE</Size>

      <Width>10</Width>

      <Length>15</Length>

      <Height>10</Height>

      <Girth>0</Girth>

      <Country>AUSTRALIA</Country>

      <Postage>134.45</Postage>

      <ExtraServices>

        <ExtraService>

          <ServiceID>1</ServiceID>

          <ServiceName>Insurance</ServiceName>

          <Available>True</Available>

          <Price>2.35</Price>

          <DeclaredValueRequired>True</DeclaredValueRequired>

        </ExtraService>

      </ExtraServices>

      <ValueOfContents>200.00</ValueOfContents>

      <SvcCommitments>3 - 5 business days to many major markets</SvcCommitments>

      <SvcDescription>Priority Mail Express International&amp;lt;sup&amp;gt;&amp;#8482;&amp;lt;/sup&amp;gt;</SvcDescription>

      <MaxDimensions>Max. length 36", max. length plus girth 79"</MaxDimensions>

      <MaxWeight>44</MaxWeight>

      <GuaranteeAvailability>01/29/2014</GuaranteeAvailability>

    </Service>

    <Service ID="2">

      <Pounds>15</Pounds>

      <Ounces>0</Ounces>

      <Machinable>True</Machinable>

      <MailType>Package</MailType>

      <Container>RECTANGULAR</Container>

      <Size>LARGE</Size>

      <Width>10</Width>

      <Length>15</Length>

      <Height>10</Height>

      <Girth>0</Girth>

      <Country>AUSTRALIA</Country>

      <Postage>103.50</Postage>

      <ExtraServices>

        <ExtraService>

          <ServiceID>1</ServiceID>

          <ServiceName>Insurance</ServiceName>

          <Available>True</Available>

          <Price>2.45</Price>

          <DeclaredValueRequired>True</DeclaredValueRequired>

        </ExtraService>

        <ExtraService>

          <ServiceID>6</ServiceID>

          <ServiceName>Certificate of Mailing</ServiceName>

          <Available>True</Available>

          <Price>1.30</Price>

        </ExtraService>

      </ExtraServices>

      <ValueOfContents>200.00</ValueOfContents>

      <ParcelIndemnityCoverage>107.29</ParcelIndemnityCoverage>

      <SvcCommitments>6 - 10 business days to many major markets</SvcCommitments>

      <SvcDescription>Priority Mail International&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt;</SvcDescription>

      <MaxDimensions>Max. length 42", max. length plus girth combined 79"</MaxDimensions>

      <MaxWeight>66</MaxWeight>

    </Service>

  </Package>

  <Package ID="2ND">

    <Prohibitions>Articles made of t <!--Suppressed for example.--></Prohibitions>

    <Restrictions>Articles of gold o <!--Suppressed for example.--></Restrictions>

    <Observations>Import permits or  <!--Suppressed for example.--></Observations>

    <CustomsForms>First-Class Mail I <!--Suppressed for example.--></CustomsForms>

    <ExpressMail>Country Code: DZ Re <!--Suppressed for example.--></ExpressMail>

    <AreasServed>Please reference Express Mail for Areas Served.</AreasServed>

    <AdditionalRestrictions>No Additional Restrictions Data found.</AdditionalRestrictions>

    <Service ID="13">

      <Pounds>0</Pounds>

      <Ounces>3</Ounces>

      <MailType>Envelope</MailType>

      <Container></Container>

      <Size>REGULAR</Size>

      <Width>0</Width>

      <Length>0</Length>

      <Height>0</Height>

      <Girth>0</Girth>

      <Country>ALGERIA</Country>

      <Postage>2.81</Postage>

      <ExtraServices>

        <ExtraService>

          <ServiceID>6</ServiceID>

          <ServiceName>Certificate of Mailing</ServiceName>

          <Available>True</Available>

          <Price>1.30</Price>

        </ExtraService>

      </ExtraServices>

      <ValueOfContents>75.00</ValueOfContents>

      <InsComment>SERVICE</InsComment>

      <SvcCommitments>Varies by destination</SvcCommitments>

      <SvcDescription>First-Class Mail&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt; International Letter**</SvcDescription>

      <MaxDimensions>Max. length 11-1/2", height 6-1/8" or thickness 1/4"</MaxDimensions>

      <MaxWeight>0.21875</MaxWeight>

    </Service>

  </Package>

</IntlRateV2Response>              

Error Responses

Error conditions are handled at the main XML document level, Package node level, and ExtraService node 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.  But if there is a problem with a specific Package or ExtraService within the request, an <Error> element will be returned within the <Package> or <ExtraService> element that pertains to the specific package ID.  Since the IntlRateV2 API allows you to submit multiple packages within a single request document, the response may contain a mix of international rate information and errors.  For requests containing multiple package IDs, you need to check if there is an <Error> within a given <Package> or <ExtraService> element, as well as checking for an error at the top level for example:

<?xml version="1.0"?>

<IntlRateV2Response>

  <Package ID="0">

    <Prohibitions>Sample</Prohibitions>

    <Restrictions>Sample</Restrictions>

    <Observations>Sample</Observations>

    <CustomsForms>Sample</CustomsForms>

    <ExpressMail>Sample</ExpressMail>

    <AreasServed>Sample</AreasServed>

    <AdditionalRestrictions>Sample</AdditionalRestrictions>

    <Service ID="21">

      <Pounds>0</Pounds>

      <Ounces>2</Ounces>

      <MailType>Postcard</MailType>

      <Container>RECTANGULAR</Container>

      <Size>REGULAR</Size>

      <Width>5</Width>

      <Length>10</Length>

      <Height>3</Height>

      <Girth>0</Girth>

      <Country>ALBANIA</Country>

      <Postage>1.15</Postage>

      <ExtraServices></ExtraServices>

      <ValueOfContents>95.75</ValueOfContents>

      <InsComment>SERVICE</InsComment>

      <SvcCommitments>Varies by destination</SvcCommitments>

      <SvcDescription>First-Class Mail&amp;lt;sup&amp;gt;&amp;#174;&amp;lt;/sup&amp;gt; International Postcard</SvcDescription>

      <MaxDimensions>Maximum size 6" length x 4-1/4" height</MaxDimensions>

      <MaxWeight>0.21875</MaxWeight>

    </Service>

  </Package>

  <Package ID="2">

    <Error>

      <Number>-2147218040</Number>

      <Source>IntlPostage;clsIntlPostage.CalcAllPostageDimensionsXML;IntlRateV2.ProcessRequest</Source>

      <Description>Invalid International Mail Type</Description>

      <HelpFile></HelpFile>

      <HelpContext>1000440</HelpContext>

    </Error>

  </Package>

</IntlRateV2Response>

 

 

If you need assistance with an error response, contact the USPS Internet Customer Care Center (ICCC) uspstechnicalsupport@mailps.custhelp.com


 

 

Appendix A - RateV4 Service Request Matrix 

<Service/>

<FirstCl.../>

<Size/>

<Container/>

<Machinable/>

Dimensions

<Girth/>

<ShipDate/>

Max. Weight

All & Online

Ignored

Regular

Variable/Null

Required

Ignored

Ignored

Optional

70 lbs.

All & Online

Ignored

Large

Rectangular

Required

Required

Ignored

Optional

70 lbs.

All & Online

Ignored

Large

Nonrectangular

Required

Required

Required

Optional

70 lbs.

All & Online

Ignored

Large

Variable/Null

Required

Required

Ignored

Optional

70 lbs.

First Class

Letter

Ignored

Ignored

Required

Ignored

Ignored

Ignored

3.5 oz.

First Class

Flat

Ignored

Ignored

Required

Ignored

Ignored

Ignored

13 oz.

First Class

Parcel

Regular

Variable/Null

Ignored

Ignored

Ignored

Ignored

13 oz.

First Class

Parcel

Large

Rectangular

Ignored

Required

Ignored

Ignored

13 oz.

First Class

Parcel

Large

Nonrectangular

Ignored

Required

Required

Ignored

13 oz.

First Class

Parcel

Large

Variable/Null

Ignored

Required

Ignored

Ignored

13 oz.

First Class

Postcard

Regular

Ignored

Ignored

Ignored

Ignored

Ignored

3.5 oz.

First Class

Postcard

Large

Ignored

Ignored

Ignored

Ignored

Ignored

3.5 oz.

First Class Commercial

Package Service

Regular

Variable/Null

Ignored

Ignored

Ignored

Ignored

13 oz.

First Class Commercial

Package Service

Large

Rectangular

Ignored

Required

Ignored

Ignored

13 oz.

First Class Commercial

Package Service

Large

Nonrectangular

Ignored

Required

Required

Ignored

13 oz.

First Class Commercial

Package Service

Large

Variable/Null

Ignored

Required

Required

Ignored

13 oz.

First Class HFP Commercial

Package Service

Regular

Variable/Null

Ignored

Ignored

Ignored

Ignored

13 oz.

First Class HFP Commercial

Package Service

Large

Rectangular

Ignored

Required

Ignored

Ignored

13 oz.

First Class HFP Commercial

Package Service

Large

Nonrectangular

Ignored

Required

Required

Ignored

13 oz.

First Class HFP Commercial

Package Service

Large

Variable/Null

Ignored

Required

Required

Ignored

13 oz.

Priority

Ignored

Regular

Lg Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Md Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Sm Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Regular Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Gift Card Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Window Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Sm Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority

Ignored

Large

Rectangular

Ignored

Required

Ignored

Ignored

70 lbs.

Priority

Ignored

Large

Nonrectangular

Ignored

Required

Required

Ignored

70 lbs.

Priority

Ignored

Large

Variable/Null

Ignored

Required

Required

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Lg Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Sm Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Regular Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Md Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Gift Card Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Window Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Sm Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Regular

Regional Rate Box A

Ignored

Ignored

Ignored

Ignored

15 lbs.

Priority Commercial

Ignored

Regular

Regional Rate Box B

Ignored

Ignored

Ignored

Ignored

20 lbs.

Priority Commercial

Ignored

Regular

Regional Rate Box C

Ignored

Ignored

Ignored

Ignored

25 lbs.

Priority Commercial

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Large

Rectangular

Ignored

Required

Ignored

Ignored

70 lbs.

Priority Commercial

Ignored

Large

Nonrectangular

Ignored

Required

Required

Ignored

70 lbs.

Priority Commercial

Ignored

Large

Variable/Null

Ignored

Required

Required

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Lg Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Sm Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Regular Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Md Flat Rate Box

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Gift Card Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Window Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Sm Flat Rate Env.

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Regular

Regional Rate Box A

Ignored

Ignored

Ignored

Ignored

15 lbs.

Priority CPP

Ignored

Regular

Regional Rate Box B

Ignored

Ignored

Ignored

Ignored

20 lbs.

Priority CPP

Ignored

Regular

Regional Rate Box C

Ignored

Ignored

Ignored

Ignored

25 lbs.

Priority CPP

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Large

Rectangular

Ignored

Required

Ignored

Ignored

70 lbs.

Priority CPP

Ignored

Large

Nonrectangular

Ignored

Required

Required

Ignored

70 lbs.

Priority CPP

Ignored

Large

Variable/Null

Ignored

Required

Required

Ignored

70 lbs.

Priority HFP Commercial

Ignored

Regular

Lg Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Sm Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Regular Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Md Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Gift Card Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Window Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Sm Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Regular

Regional Rate Box A

Ignored

Ignored

Ignored

Optional

15 lbs.

Priority HFP Commercial

Ignored

Regular

Regional Rate Box B

Ignored

Ignored

Ignored

Optional

20 lbs.

Priority HFP Commercial

Ignored

Regular

Regional Rate Box C

Ignored

Ignored

Ignored

Optional

25 lbs.

Priority HFP Commercial

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Large

Rectangular

Ignored

Required

Ignored

Optional

70 lbs.

Priority HFP Commercial

Ignored

Large

Nonrectangular

Ignored

Required

Required

Optional

70 lbs.

Priority HFP Commercial

Ignored

Large

Variable/Null

Ignored

Required

Required

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Lg Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Sm Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Regular Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Md Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Gift Card Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Window Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Sm Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Regular

Regional Rate Box A

Ignored

Ignored

Ignored

Optional

15 lbs.

Priority HFP CPP

Ignored

Regular

Regional Rate Box B

Ignored

Ignored

Ignored

Optional

20 lbs.

Priority HFP CPP

Ignored

Regular

Regional Rate Box C

Ignored

Ignored

Ignored

Optional

25 lbs.

Priority HFP CPP

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Large

Rectangular

Ignored

Required

Ignored

Optional

70 lbs.

Priority HFP CPP

Ignored

Large

Nonrectangular

Ignored

Required

Required

Optional

70 lbs.

Priority HFP CPP

Ignored

Large

Variable/Null

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express

Ignored

Large

Rectangular

Ignored

Required

Ignored

Optional

70 lbs.

Priority Mail Express

Ignored

Large

Nonrectangular

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express

Ignored

Large

Variable/Null

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express SH

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express SH

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express SH

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express SH

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express SH

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express SH

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express SH

Ignored

Large

Rectangular

Ignored

Required

Ignored

Optional

70 lbs.

Priority Mail Express SH

Ignored

Large

Nonrectangular

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express SH

Ignored

Large

Variable/Null

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Large

Rectangular

Ignored

Required

Ignored

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Large

Nonrectangular

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express HFP

Ignored

Large

Variable/Null

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Large

Rectangular

Ignored

Required

Ignored

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Large

Nonrectangular

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express Commercial

Ignored

Large

Variable/Null

Ignored

Required

Required

Optional

70 lbs.

Priority Mail Express CPP

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express CPP

Ignored

Regular

Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express CPP

Ignored

Regular

Legal Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express CPP

Ignored

Regular

Padded Flat Rate Env.

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express CPP

Ignored

Regular

Flat Rate Box

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express CPP

Ignored

Regular

Variable/Null

Ignored

Ignored

Ignored

Optional

70 lbs.

Priority Mail Express CPP

Ignored

Large

Rectangular

Ignored

Required