Package Pickup API

 

USPS Web Tools™

Application Programming Interface

User’s Guide

Document Version 2.0 (1/17/2016)

 

 

 

 

 

 

United States Postal Service Logo 

 

 


 


Contents       

A.  Introduction to Web Tools. 4

Before you get started: 4

B.  USPS Package Pickup API. 4

Overview.. 4

1.  Package Pickup Availability Web Tools. 6

API Signature. 6

Request Description. 6

Sample Request 7

Response Description. 8

Sample Response. 8

2.  Package Pickup Schedule Web Tools. 9

API Signature. 9

Request Description. 9

Sample Request 13

Response Description. 13

Sample Response. 14

3.  Package Pickup Cancel Web Tools. 16

API Signature. 16

Request Description. 16

Sample Request 17

Response Description. 18

Sample Response. 19

4.  Package Pickup Change Web Tools. 20

API Signature. 20

Request Description. 20

Sample Request 24

Response Description. 24

Sample Response. 25

5.  Package Pickup Inquiry Web Tools. 27

API Signature. 27

Request Description. 27

Sample Request 28

Response Description. 29

Sample Response. 30

C.  Package Pickup Messages. 31

User Interface Messages. 31

Pop-up Messages. 32

D.  Error Responses. 33

 


 

A.  Introduction to Web Tools

This document contains a Reference Guide to the Package Pickup APIs. 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 Tools will simply pass in the characters up to the maximum amount allowed and disregard the rest.  This is important since the resulting value could prevent a correct response.

 

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

 

<TrackID> EJ123456780US </TrackID>

 

In this instance, you will replace “EJ123456780US” with the tracking ID 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.

Package Pickup APIs require extra permissions; contact the Internet Customer Care Center at uspstechnicalsupport@mailps.custhelp.com to request access. Indicate “Package Pickup API Access” in the subject line.

B.  USPS Package Pickup API

Overview

Package Pickup Web Tools provide convenience to you and your customers.  Your carrier will pick up your packages on the next USPS delivery day (Monday through Saturday, excluding holidays) for free.  Package Pickup is available for sending packages using Priority Mail Express, Priority Mail, international delivery services, or for returned merchandise. 

Customers requiring pickup of their packages by the USPS currently have two pickup options available to them:  Package Pickup and Pickup On Demand.  This Web Tools guide applies to Package Pickup only.  Pickup On Demand is only available through the USPS website.  The information below is presented to illustrate the differences between these two options:

 

Package Pickup

Pickup On Demand

Free, regardless of the number of packages.

Per pickup fee, regardless of the number of packages.

Your carrier picks up the next USPS delivery day when your mail is delivered.

Packages are picked up in a specified timeframe.

Available with domestic Priority Mail Express and Priority Mail services, international delivery services, or for merchandise returns.

Available for Express Mail, Priority Mail, Global Express Guaranteed, or Standard Post services.

Requests must be received by 2:00 AM CST.

Allow a two-hour timeframe for pickups.

Maximum weight per package is 70 pounds.

Maximum weight per package is 70 pounds.

Postage must be prepaid and attached to package(s).

Apply postage to each package.

Packages must be properly sealed and ready for shipment.

Have your packages ready for pickup at the time and day specified.

Packages requiring insurance services need to be taken to a post office.

 

Full Package Pickup functionality relies on the implementation of five separate Web Tools:

·         Package Pickup Availability Web Tools

·         Package Pickup Schedule Web Tools

·         Package Pickup Cancel Web Tools

·         Package Pickup Change Web Tools

·         Package Pickup Inquiry Web Tools

The five Package Pickup Web Tools work together to provide seamless service to you and your customers.  Specifically, the functions of each are as follows:

1.       The Package Pickup Availability Web Tools checks the availability for Package Pickup at a specific address and informs the user of the first available date for pickup.  Package Pickup is not available for all addresses.

2.       The Package Pickup Schedule Web Tools schedules a Package Pickup and provides the user a confirmation number for the scheduled pickup.  Prior to making a Pickup Schedule call, it is recommended to use the Pickup Availability WebT ools to confirm that service is available.  There must be at least one Priority Mail Express package, Priority Mail package, international package, or returned merchandise package for a valid request.  Refer to the Delivery Timeline section for information regarding when pickups are made based on the time of the request.

3.       The Package Pickup Cancel Web Tools cancels a scheduled Package Pickup.  To use either the Pickup Cancel or Pickup Change Web Tools, the exact data from the original Pickup Schedule Web Tools request must be entered.  You must enter address information and the confirmation number.  The confirmation number alone cannot be used to cancel or change a scheduled pickup.  Address information must be identical to what was entered when the pickup was scheduled.  To verify the accuracy of your data, you can use the Pickup Inquiry Web Tools.  Refer to the Delivery Timeline section for information regarding deadlines for canceling pickups.

4.       The Package Pickup Change Web Tools allows users to change certain data in their original Pickup Schedule request.  To use either the Pickup Cancel or Pickup Change Web Tools, the exact data from the original Pickup Schedule Web Tools request must be entered.  You must enter address information and the confirmation number.  The confirmation number alone cannot be used to cancel or change a scheduled pickup.  The name and phone number of the sender can be changed, along with the number and types of package services, the weight of the packages, and the location of the pickup.  Address data and the confirmation number cannot be changed and must be identical to the original Schedule request.  To verify the accuracy of your data, you can use the Pickup Inquiry Web Tools.  Refer to the Delivery Timeline section for information regarding deadlines for changing pickups.

5.       The Package Pickup Inquiry Web Tools provides the data contained in your original Pickup Schedule request.  To use either the Pickup Cancel or Pickup Change Web Tools, the exact data from the original Schedule request must be entered.  By using the Pickup Inquiry Web Tools, you can obtain the data needed.

1.  Package Pickup Availability Web Tools

API Signature

Scheme

Host

Path

API

XML

https://

secure.shippingapis.com

/ShippingAPI.dll

?API=CarrierPickupAvailabilityRequest

&XML=(see below)

 

The Package Pickup Availability Web Tools checks the availability for Package Pickup at a specific address and informs the user of the first available date for pickup.  Package Pickup is not available for all addresses.

Request Description

The table below presents the XML input tags for generating Live requests and 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 Tools will simply pass in the characters up to the maximum amount allowed and disregard the rest.  This is important since the resulting value could prevent a correct response.

Tag Name

Occurs

Description

Type

Validation

CarrierPickupAvailabilityRequest

Required

Input tag exactly as presented.

(group)

 

CarrierPickupAvailabilityRequest/ @USERID

Required

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

string

 

CarrierPickupAvailabilityRequest/ FirmName

Optional

Use this tag for a firm or company name.  FirmName is optional except if needed to uniquely identify an address.  Some firms/companies that have their own ZIP codes require the use of firm name to properly identify their address.

 

Example:

<FirmName>ABC Company</FirmName>

string

minLength value=0

maxLength value=50

CarrierPickupAvailabilityRequest/ SuiteOrApt

Required

 

Use this tag for an apartment or suite number.  SuiteOrApt is optional except if needed to uniquely identify an address at a multiple dwelling address, for example, an apartment building.

 

Example:

<SuiteOrApt>Suite 777</SuiteOrApt>

string

minLength value=0

maxLength value=50

CarrierPickupAvailabilityRequest/ Address2

Required

Use this tag for a street address.

 

Example:

<Address2>1390 Market Street</Address2>

string

minLength value=0

maxLength value=50

CarrierPickupAvailabilityRequest/ Urbanization

Required

Use this tag for Urbanization (for Puerto Rico only).  ZIP Code prefixes 006 to 009, if area is so designated.

string

minLength value=0

maxLength value=28

CarrierPickupAvailabilityRequest/ City

Required

Use this tag for a city.  Either ZIP5 or City and State are required.

 

Example: <City>Houston</City>

string

minLength value=0

maxLength value=30

CarrierPickupAvailabilityRequest/ State

Required

Use this tag for a state abbreviation.  Either ZIP5 or City and State are required.

 

Example: <State>TX</State>

string

minLength value=0

maxLength value=2

CarrierPickupAvailabilityRequest/ ZIP5

Required

Use this tag for a 5 digit ZIP Code.  Input tag exactly as presented--all caps.  Either ZIP5 or City and State are required.

 

Example: <ZIP5>77058</ZIP5>

string

minLength value=0

maxLength value=5

CarrierPickupAvailabilityRequest/ ZIP4

Required

Input tag exactly as presented--all caps.  Maximum characters allowed: 4.

 

Example: <ZIP4>1234</ZIP4>

string

minLength value=0

maxLength value=4

CarrierPickupAvailabilityRequest/ Date

Optional

Use this tag to request a pickup date/time. XML datetime primitive format..

 

Example: 2006-05-04T18:13:51.0Z

string

minOccurs=0

maxOccurs=1

Sample Request

The Live XML request should be in the following form and sequence:

<CarrierPickupAvailabilityRequest UserID="XXXX">

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

</CarrierPickupAvailabilityRequest>

 

 


 

Response Description

Tag Name

Occurs

Description

Type

CarrierPickupAvailabilityResponse

Required

Type of Response

(group)

CarrierPickupAvailabilityResponse/ FirmName

Optional

Firm name sending request

string

CarrierPickupAvailabilityResponse/ SuiteOrApt

Required

Suite or apartment (only returned in response if needed to uniquely identify the address, for example, at a multiple dwelling address)

string

CarrierPickupAvailabilityResponse/ Address2

Required

Pickup address

string

CarrierPickupAvailabilityResponse/ Urbanization

Required

Urbanization

string

CarrierPickupAvailabilityResponse/ City

Required

Pickup city

string

CarrierPickupAvailabilityResponse/ State

Required

Pickup state

string

CarrierPickupAvailabilityResponse/ ZIP5

Required

Pickup ZIP Code

string

CarrierPickupAvailabilityResponse/ ZIP4

Required

Pickup ZIP Code+4

string

CarrierPickupAvailabilityResponse/ DayOfWeek

Required

Day of week for pickup

string

CarrierPickupAvailabilityResponse/ Date

Required

Scheduled date for pickup

string

CarrierPickupAvailabilityResponse/ CarrierRoute

Optional

Carrier Route (can be C for City, H for Highway, R for Rural)

string

 

Sample Response

The Package Pickup Availability WebTools returns the following information if pickup is available to the supplied address:

<CarrierPickupAvailabilityResponse>

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<DayOfWeek>Monday</DayOfWeek>

<Date>4/01/2004</Date>

<CarrierRoute>C</CarrierRoute>

</CarrierPickupAvailabilityResponse>

 


 

2.  Package Pickup Schedule Web Tools

API Signature

Scheme

Host

Path

API

XML

https://

secure.shippingapis.com

/ShippingAPI.dll

?API=CarrierPickupScheduleRequest

&XML=(see below)

 

The Package Pickup Schedule Web Tools schedules a Package Pickup and provides the user a confirmation number for the scheduled pickup.  Prior to making a Pickup Schedule call, it is recommended to use the Pickup Availability Web Tools to confirm that service is available.  There must be at least one Priority Mail Express package or one Priority Mail package or on international package or one returned merchandise package for a valid request. 

Request Description

The table below presents the XML input tags for generating Live requests and 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 Tools will simply pass in the characters up to the maximum amount allowed and disregard the rest.  This is important since the resulting value could prevent a correct response.

Tag Name

Occurs

Description

Type

Validation

CarrierPickupScheduleRequest

Required

Input tag exactly as presented.

(group)

 

CarrierPickupScheduleRequest/@USERID

Required

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

string

 

CarrierPickupScheduleRequest/FirstName

Required

Only alpha characters, apostrophes, spaces, periods and hyphens "-" may be used.

 

For example: <FirstName>John</FirstName>

string

minLength value=0

maxLength value=50

CarrierPickupScheduleRequest/ LastName

Required

Only alpha characters, apostrophes, spaces, periods and hyphens "-" may be used.

For example: <LastName>Doe</LastName>

string

minLength value=0

maxLength value=50

CarrierPickupScheduleRequest/ FirmName

Optional

Only alpha and numeric characters, apostrophes, spaces, hyphens "-" and ampersands "&" may be used.

 

Use this tag for a firm or company name.  FirmName is optional except if the First Name and Last Name tags are null.  Some firms/companies that have their own ZIP codes require the use of firm name to properly identify their address.

For example: <FirmName>ABC Company</FirmName>

string

minLength value=0

maxLength value=50

CarrierPickupScheduleRequest/ SuiteOrApt

Required

Use this tag for an apartment or suite number.  SuiteOrApt  is optional except if needed to uniquely identify an address at a multiple dwelling address, for example, an apartment building.

For example:<SuiteOrApt>Suite 777</SuiteOrApt>

string

minLength value=0

maxLength value=50

CarrierPickupScheduleRequest/ Address2

Required

Use this tag for a street address.

For example:<Address2>1390 Market Street</Address2>

string

minLength value=0

maxLength value=50

CarrierPickupScheduleRequest/ Urbanization

Required

Use this tag for Urbanization (for Puerto Rico only).  ZIP Code prefixes 006 to 009, if area is so designated.

string

minLength value=0

maxLength value=28

CarrierPickupScheduleRequest/ City

Required

Maximum characters allowed: 30.  Use this tag for a city.  Either ZIP5 or City and State are required.

For example: <City>Houston</City>

string

minLength value="0"

CarrierPickupScheduleRequest/ State

Required

Use this tag for a state abbreviation.  Either ZIP5 or City and State are required.

For example: <State>TX</State>

string

minLength value=0

maxLength value=2

CarrierPickupScheduleRequest/ ZIP5

Required

Use this tag for a 5 digit ZIP Code.  Input tag exactly as presented--all caps.  Either ZIP5 or City and State are required.

For example: <ZIP5>77058</ZIP5>

string

minLength value=0

maxLength value=5

CarrierPickupScheduleRequest/ ZIP4

Required

Use this tag for a 4 digit ZIP Code.  If a value is entered, 4 digits required

For example: <ZIP4>1234</ZIP4>

string

minLength value=0

maxLength value=4

CarrierPickupScheduleRequest/ Phone

Required

Two formats are allowed: (###) 123-4567 or ###-123-4567. 

For example: <Phone>(555) 555-1234</Phone>

or <Phone>555-555-1234</Phone>

string

minLength value=0

maxLength value=14

CarrierPickupScheduleRequest/ Extension

Optional

Optional value for Phone Extension. 

For example: <Extension>201</Extension>

string

minOccurs=0

 

minLength value=0

maxLength value=4

CarrierPickupScheduleRequest/ Package

Required

No values entered with this tag.  <ServiceType> and <Count> tags are embedded under this.  Refer to the Live XML Request Example section, below, to see how these embedded tags are formatted.  If the <Count> for a service type is zero, you do not need to encode a <Package> but you must have at least one <Package> with embedded <ServiceType> and <Count> tags.

(group)

 

CarrierPickupScheduleRequest/ Package/ServiceType

Required

This tag is embedded under the <Package> tag.  Enter one of the following values:

§  PriorityMailExpress

§  PriorityMail

§  FirstClass

§  ParcelSelect

§  Returns

§  International

§  OtherPackages

If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags.  Refer to the Live XML Request Example section, below, to see how these embedded tags are formatted.

For example: <ServiceType>PriorityMailExpress</ServiceType>

string

minLength value="0"

Enumerations=

PriorityMailExpress

PriorityMail

FirstClass

ParcelSelect

Returns

International

OtherPackages

 

CarrierPickupScheduleRequest/ Package/Count

Required

This tag is embedded under the <Package> tag.  Enter the number of packages for the accompanying <ServiceType> tag.  Maximum characters allowed: 3 or 999 packages.  If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags.  Refer to the Live XML Request Example section, below, to see how these embedded tags are formatted.

For example: <Count>2</Count>

string

minLength value=0

maxLength value=3

 

 

minInclusive value=1

maxInclusive value=999

CarrierPickupScheduleRequest/ EstimatedWeight

Required

Enter the estimated aggregate weight (in pounds) of all packages being picked up. 

For example: <EstimatedWeight>14</EstimatedWeight>

string

minLength value=0

maxLength value=5

CarrierPickupScheduleRequest/ PackageLocation

Required

Enter one of the following values:

·         Front Door

·         Back Door

·         Side Door

·         Knock on Door/Ring Bell

·         Mail Room

·         Office

·         Reception

·         In/At Mailbox

·         Other

Note: "Other" requires information in the value for the <SpecialInstructions> tag.

 

For example:

<PackageLocation>Front Door</PackageLocation>

string

Enumerations=

Front Door

Back Door

Side Door

Knock on Door/Ring Bell

Mail Room

Office

Reception

In/At Mailbox

Other

 

CarrierPickupScheduleRequest/ SpecialInstructions

Optional / Required

 

Value required when PackageLocation is “Other”.

Only alpha, numeric, commas, periods, apostrophes, _, &, -, ( ), ?, #, / +, @ and space characters may be used.

 

For example:

<SpecialInstructions>Packages are behind the screen door.</SpecialInstructions>

string

minLength value=0

maxLength value=255

CarrierPickupScheduleRequest/ EmailAddress

Optional

If provided, email notifications will be sent confirming package pickup, or request changes and cancellations. Maximum characters allowed: 50.

 

For example:

<EmailAddress>cpapple@email.com</EmailAddress>

string

minOccurs=0

 

minLength value=0

maxLength value=255

Sample Request

The Live XML request should be in the following form and sequence:

<CarrierPickupScheduleRequest UserID="XXXX">

<FirstName>John</FirstName>

<LastName>Doe</LastName>

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<Phone>(555) 555-1234</Phone>

<Extension>201</Extension>

<Package>

     <ServiceType>PriorityMailExpress</ServiceType>

     <Count>2</Count>

</Package>

<Package>

     <ServiceType>PriorityMail</ServiceType>

     <Count>1</Count>

</Package>

<EstimatedWeight>14</EstimatedWeight>

<PackageLocation>Front Door</PackageLocation>

<SpecialInstructions>Packages are behind the screen door.</SpecialInstructions>

</CarrierPickupScheduleRequest>

 

 Response Description

Tag Name

Occurs

Description

Type

CarrierPickupScheduleResponse

Required

Type of Response

(group)

CarrierPickupScheduleResponse/ FirstName

Required

First name of person sending request

string

CarrierPickupScheduleResponse/LastName

Required

Last name of person sending request

string

CarrierPickupScheduleResponse/FirmName

Optional

Firm name sending request (if supplied in request)

string

CarrierPickupScheduleResponse/SuiteOrApt

Required

 

Suite or apartment (only returned in response if needed to uniquely identify the address, for example, at a multiple dwelling address)

string

CarrierPickupScheduleResponse/Address2

Required

Pickup address

string

CarrierPickupScheduleResponse/Urbanization

Required

Urbanization (if supplied in request)

string

CarrierPickupScheduleResponse/City

Required

Pickup city

string

CarrierPickupScheduleResponse/State

Required

Pickup state

string

CarrierPickupScheduleResponse/ZIP5

Required

Pickup ZIP Code

string

CarrierPickupScheduleResponse/ZIP4

Required

Pickup ZIP Code+4

string

CarrierPickupScheduleResponse/Phone

Required

Phone number of sender

string

CarrierPickupScheduleResponse/Extension

Required

Phone extension of sender (if supplied in request)

string

CarrierPickupScheduleResponse/Package

Required

Packages to be picked up.  Can be multiple <Packages> with accompanying <ServiceType> and <Count> tags.

(group)

CarrierPickupScheduleResponse/ Package/ ServiceType

Required

Types of package services requested

string

CarrierPickupScheduleResponse/ Package/ Count

Required

Number of packages for each service type requested

string

CarrierPickupScheduleResponse/EstimatedWeight

Required

Total estimated weight of all packages to be picked up

string

CarrierPickupScheduleResponse/PackageLocation

Required

Location of pickup

string

CarrierPickupScheduleResponse/SpecialInstructions

Required

Special instructions for pickup

string

CarrierPickupScheduleResponse/ConfirmationNumber

Required

Confirmation number for pickup

string

CarrierPickupScheduleResponse/DayOfWeek

Required

Day of week for pickup

string

CarrierPickupScheduleResponse/Date

Required

Scheduled date for pickup

string

CarrierPickupScheduleResponse/CarrierRoute

Optional

Carrier Route (can be C for City, H for Highway, R for Rural)

string

CarrierPickupScheduleResponse/EmailAddress

Optional

Email Address (if supplied in request)

string

Sample Response

The Package Pickup Schedule Web Tools returns the following information to the user if the information is valid and pickup is available to the supplied address:

<CarrierPickupScheduleResponse>

<FirstName>John</FirstName>

<LastName>Doe</LastName>

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<Phone>(555) 555-1234</Phone>

<Extension>201</Extension>

<Package>

     <ServiceType>PriorityMailExpress</ServiceType>

     <Count>2</Count>

</Package>

<Package>

     <ServiceType>PriorityMail</ServiceType>

     <Count>1</Count>

</Package>

<EstimatedWeight>14</EstimatedWeight>

<PackageLocation>Front Door</PackageLocation>

<SpecialInstructions> Packages are behind the screen door.</SpecialInstructions>

<ConfirmationNumber>ABC12345</ConfirmationNumber>

<DayOfWeek>Monday</DayOfWeek>

<Date>04/01/2004</Date>

<CarrierRoute>C</CarrierRoute>

</CarrierPickupScheduleResponse>


 

3.  Package Pickup Cancel Web Tools

API Signature

Scheme

Host

Path

API

XML

https://

secure.shippingapis.com

/ShippingAPI.dll

?API=CarrierPickupCancelRequest

&XML=(see below)

 

The Package Pickup Cancel Web Tools cancels a scheduled Package Pickup.  To use either the Pickup Cancel or Pickup Change Web Tools, the exact data from the original Schedule request must be entered.  You must enter address information and the confirmation number.  Confirmation number alone cannot be used to cancel or change a scheduled pickup.  Address information must be identical to what was entered when the pickup was scheduled. 

Request Description

The table below presents the XML input tags for generating Live requests and 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 Tools will simply pass in the characters up to the maximum amount allowed and disregard the rest.  This is important since the resulting value could prevent cancellation.

Tag Name

Occurs

Description

Type

Validation

CarrierPickupCancelRequest

Required

Input tag exactly as presented.

(group)

 

CarrierPickupCancelRequest/ @USERID

Required

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

string

 

CarrierPickupCancelRequest/ FirmName

Optional

Maximum characters allowed: 50.  Only alpha and numeric characters, apostrophes, spaces, hyphens "-" and ampersands "&" may be used.

 

Use this tag for a firm or company name.  FirmName is optional except if needed to uniquely identify an address.  Some firms/companies that have their own ZIP codes require the use of firm name to properly identify their address.

 

For example: <FirmName>ABC Company</FirmName>

string

minLength value=0

maxLength value=50

CarrierPickupCancelRequest/ SuiteOrApt

Required

Use this tag for an apartment or suite number.  SuiteOrApt  is optional except if needed to uniquely identify an address at a multiple dwelling address, for example, an apartment building.

For example: <SuiteOrApt>Suite 777</SuiteOrApt>

string

minLength value=0

maxLength value=50

CarrierPickupCancelRequest/ Address2

Required

Use this tag for a street address.

For example: <Address2>1390 Market Street</Address2>

string

minLength value=0

maxLength value=50

CarrierPickupCancelRequest/ Urbanization

Required

Use this tag for an Urbanization (for Puerto Rico only).  ZIP Code prefixes 006 to 009, if area is so designated.

string

minLength value=0

maxLength value=28

CarrierPickupCancelRequest/ City

Required

Use this tag for a city.  Either ZIP5 or City and State are required

For example: <City>Houston</City>

string

minLength value=0

maxLength value=30

CarrierPickupCancelRequest/ State

Required

Use this tag for a state abbreviation.  Either ZIP5 or City and State are required.

For example: <State>TX</State>

string

minLength value=0

maxLength value=2

CarrierPickupCancelRequest/ ZIP5

Required

Use this tag for a 5 digit ZIP Code.  Input tag exactly as presented--all caps.  Maximum characters allowed: 5.  Either ZIP5 or City and State are required.

For example: <ZIP5>77058</ZIP5>

string

minLength value=0

maxLength value=5

CarrierPickupCancelRequest/ ZIP4

Required

Use this tag for a 4 digit ZIP Code.  Input tag exactly as presented--all caps.  Maximum characters allowed: 4.

For example: <ZIP4>1234</ZIP4>

string

minLength value=0

maxLength value=4

CarrierPickupCancelRequest/ ConfirmationNumber

Required

Enter exact Confirmation Number returned with Package Pickup Schedule request.

For example: <ConfirmationNumber>ABC12345</ConfirmationNumber>

string

minLength value=0

maxLength value=30

Sample Request

The Live XML request should be in the following form and sequence:

<CarrierPickupCancelRequest UserID="XXXX">

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<ConfirmationNumber>ABC12345</ConfirmationNumber>

</CarrierPickupCancelRequest>

 


 

Response Description

Tag Name

Occurs

Description

Type

CarrierPickupCancelResponse

Required

Type of Response

(group)

CarrierPickupCancelResponse/ FirmName

Required

Firm name sending request (if supplied in request)

string

CarrierPickupCancelResponse/ SuiteOrApt

Required

Suite or apartment (only returned in response if needed to uniquely identify the address, for example, at a multiple dwelling address)

string

CarrierPickupCancelResponse/ Address2

Required

Pickup address

string

CarrierPickupCancelResponse/ Urbanization

Required

Urbanization (if supplied in request)

string

CarrierPickupCancelResponse/ City

Required

Pickup city

string

CarrierPickupCancelResponse/ State

Required

Pickup state

string

CarrierPickupCancelResponse/ ZIP5

Required

Pickup ZIP Code

string

CarrierPickupCancelResponse/ ZIP4

Required

Pickup ZIP Code+4 (if supplied in request)

string

CarrierPickupCancelResponse/ ConfirmationNumber

Required

Confirmation number for pickup

string

CarrierPickupCancelResponse/ Status

Required

Status of request to cancel

string

 


 

Sample Response

The Package Pickup Cancel API returns the following information to the user if the information is valid, matches the existing record, and is within the time frames available for cancellation.

<CarrierPickupCancelResponse>

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<ConfirmationNumber>ABC12345</ConfirmationNumber>

<Status>Your pickup request was cancelled.</Status>

</CarrierPickupCancelRequest>

 


 

4.  Package Pickup Change Web Tools

API Signature

Scheme

Host

Path

API

XML

https://

secure.shippingapis.com

/ShippingAPI.dll

?API=CarrierPickupChangeRequest

&XML=(see below)

 

The Package Pickup Change Web Tools allows users to change certain data in their original Pickup Schedule request.  To use either the Pickup Cancel or Pickup Change Web Tools, the exact data from the original Pickup Schedule Web Tools request must be entered.  You must enter address information and the confirmation number.  The confirmation number alone cannot be used to cancel or change a scheduled pickup.  The number and types of package services, the weight of the packages, and the location of the pickup can be changed.  Address data and the confirmation number cannot be changed and must be identical to the original Schedule request.  To verify the accuracy of your data, you can use the Pickup Inquiry Web      Tools. 

 

Request Description

The table below presents the XML input tags for generating Live requests and 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 Tools will simply pass in the characters up to the maximum amount allowed and disregard the rest.  This is important since the resulting value could prevent the request to be changed.

Tag Name

Occurs

Description

Type

Validation

CarrierPickupChangeRequest

Required

Input tag exactly as presented.

(group)

 

CarrierPickupChangeRequest/ @USERID

Required

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

string

 

CarrierPickupChangeRequest/ FirstName

Required

Only alpha characters, apostrophes, spaces, periods and hyphens "-" may be used.

For example: <FirstName>John</FirstName>

string

minLength value=0

maxLength value=50

CarrierPickupChangeRequest/ LastName

Required

Only alpha characters, apostrophes, spaces, periods and hyphens "-" may be used.

For example: <LastName>Doe</LastName>

string

minLength value=0

maxLength value=50

CarrierPickupChangeRequest/ FirmName

Optional

Only alpha and numeric characters, apostrophes, spaces, hyphens "-" and ampersands "&" may be used.

 

Use this tag for a firm or company name.  FirmName is optional except if First Name and Last Name tags are null.  Some firms/companies that have their own ZIP codes require the use of firm name to properly identify their address.

For example: <FirmName>ABC Company</FirmName>

string

minLength value=0

maxLength value=50

CarrierPickupChangeRequest/ SuiteOrApt

Optional

Use this tag for an apartment or suite number.  SuiteOrApt is optional except if needed to uniquely identify an address at a multiple dwelling address, for example, an apartment building.

For example: <SuiteOrApt>Suite 777</SuiteOrApt>

string

minLength value=0

maxLength value=50

CarrierPickupChangeRequest/ Address2

Required

Use this tag for a street address.

For example:

<Address2>1390 Market Street</Address2>

string

minLength value=0

maxLength value=50

CarrierPickupChangeRequest/ Urbanization

Required

Use this tag for Urbanization (for Puerto Rico only).  ZIP Code prefixes 006 to 009, if area is so designated.

string

minLength value=0

maxLength value=28

CarrierPickupChangeRequest/ City

Required

Use this tag for a city.  Either ZIP5 or City and State are required.

For example: <City>Houston</City>

string

minLength value=0

maxLength value=30

CarrierPickupChangeRequest/ State

Required

Use this tag for a state abbreviation.  Either ZIP5 or City and State are required.

For example: <State>TX</State>

string

minLength value=0

maxLength value=2

CarrierPickupChangeRequest/ ZIP5

Required

Use this tag for a 5 digit ZIP Code.  Input tag exactly as presented--all caps.  Either ZIP5 or City and State are required.

For example: <ZIP5>77058</ZIP5>

string

minLength value=0

maxLength value=5

CarrierPickupChangeRequest/ ZIP4

Required

Use this tag for a 4 digit ZIP Code.  Input tag exactly as presented--all caps. 

For example: <ZIP4>1234</ZIP4>

string

minLength value=0

maxLength value=4

CarrierPickupChangeRequest/ Phone

Required

Two formats are allowed: (###) 123-4567 or ###-123-4567. 

For example: <Phone>(555) 555-1234</Phone>

or <Phone>555-555-1234</Phone>

string

minLength value=0

maxLength value=14

CarrierPickupChangeRequest/ Extension

Required

Extension related to the Phone Number

For example: <Extension>201</Extension>

string

minLength value=0

maxLength value=4

CarrierPickupChangeRequest/ Package

Required

No values entered with this tag.  <ServiceType> and <Count> tags are embedded under this.  Refer to the Live XML Request Example section, below, to see how these embedded tags are formatted.  If the <Count> for a service type is zero, you do not need to encode a <Package> but you must have at least one <Package> with embedded <ServiceType> and <Count> tags.

(group)

 

CarrierPickupChangeRequest/ Package/ ServiceType

Required

This tag is embedded under the <Package> tag.  Enter one of the following values:

§  EXPRESSMAIL

§  PRIORITYMAILEXPRESS

§  PRIORITYMAIL

§  RETURNS

§  INTERNATIONAL

§  OTHERPACKAGES

If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags.  Refer to the Live XML Request Example section, below, to see how these embedded tags are formatted.

For example: <ServiceType>PriorityMailExpress</ServiceType>

string

Enumerations:

·   EXPRESSMAIL

·   PRIORITYMAILEXPRESS

·   PRIORITYMAIL

·   RETURNS

·   INTERNATIONAL

·   OTHERPACKAGES

 

CarrierPickupChangeRequest/ Package/ Count

Required

This tag is embedded under the <Package> tag.  Enter the number of packages for the accompanying <ServiceType> tag.  Maximum characters allowed: 3 or 999 packages There must be at least one Priority Mail Express Package or one Priority Mail package or one returned merchandise package to make this a valid request.  If your pickup contains more than one Service Type, use additional <Package> tags for each service type with the accompanying <ServiceType> and <Count> tags.  Refer to the Live XML Request Example section, below, to see how these embedded tags are formatted.

For example: <Count>2</Count>

string

minLength value=0

maxLength value=3

 

 

minInclusive value=1

maxInclusive value=999

CarrierPickupChangeRequest/ EstimatedWeight

Required

Enter the estimated aggregate weight (in pounds) of all packages being picked up. 

For example: <EstimatedWeight>14</EstimatedWeight>

string

minLength value=0

maxLength value=5

 

CarrierPickupChangeRequest/ PackageLocation

Required

Enter one of the following values:

§  Front Door

§  Back Door

§  Side Door

§  Knock on Door/Ring Bell

§  Mail Room

§  Office

§  Reception

§  In/At Mailbox

§  Other

Note: "Other" requires information in the value for the <SpecialInstructions> tag.

For example: <PackageLocation>Front Door</PackageLocation>

string

Enumerations:

·   Front Door

·   Back Door

·   Side Door

·   Knock on Door/Ring Bell

·   Mail Room

·   Office

·   Reception

·   In/At Mailbox

·   Other

 

CarrierPickupChangeRequest/ SpecialInstructions

Optional / Required

Only alpha, numeric, commas, periods, apostrophes, _, &, -, ( ), ?, #, / +, @ and space characters may be used.

 

Required when Package Location tag is “Other”

For example: <SpecialInstructions>Packages are behind the screen door.</SpecialInstructions>

string

minLength value=0

maxLength value=255

 

CarrierPickupChangeRequest/ ConfirmationNumber

Required

Enter exact Confirmation Number returned with Package Pickup Schedule request.

For example: ConfirmationNumber>ABC12345</ConfirmationNumber>

string

minLength value=0

maxLength value=30

 

CarrierPickupChangeRequest/ EmailAddress

Optional

If provided, email notifications will be sent confirming package pickup, or request changes and cancellations. Maximum characters allowed: 50.

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

string

minOccurs="0"

minLength value=0

maxLength value=50

 

Sample Request

The Live XML request should be in the following form and sequence:

<CarrierPickupChangeRequest UserID="XXXX">

<FirstName>John</FirstName>

<LastName>Doe</LastName>

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<Phone>(555) 555-1234</Phone>

<Extension>201</Extension>

<Package>

     <ServiceType>PriorityMailExpress</ServiceType>

     <Count>2</Count>

</Package>

<Package>

     <ServiceType>PriorityMail</ServiceType>

     <Count>1</Count>

</Package>

<EstimatedWeight>14</EstimatedWeight>

<PackageLocation>Front Door</PackageLocation>

<SpecialInstructions> Packages are behind the screen door.</SpecialInstructions>

<ConfirmationNumber>ABC12345</ConfirmationNumber>

</CarrierPickupChangeRequest>

 

Response Description

Tag Name

Occurs

Description

Type

CarrierPickupChangeResponse

Required

Type of Response

(group)

CarrierPickupChangeResponse/ FirstName

Required

First name of person sending request

string

CarrierPickupChangeResponse/ LastName

Required

Last name of person sending request

string

CarrierPickupChangeResponse/ FirmName

Optional

Firm name sending request (if supplied in request)

string

CarrierPickupChangeResponse/ SuiteOrApt

Required

Suite or apartment (only returned in response if needed to uniquely identify the address, for example, at a multiple dwelling address)

string

CarrierPickupChangeResponse/ Address2

Required

Pickup address

string

CarrierPickupChangeResponse/ Urbanization

Required

Urbanization (if supplied in request)

string

CarrierPickupChangeResponse/ City

Required

Pickup city

string

CarrierPickupChangeResponse/ State

Required

Pickup state

string

CarrierPickupChangeResponse/ ZIP5

Required

Pickup ZIP Code

string

CarrierPickupChangeResponse/ ZIP4

Required

Pickup ZIP Code+4

string

CarrierPickupChangeResponse/ Phone

Required

Phone number of sender

string

CarrierPickupChangeResponse/ Extension

Required

Phone extension of sender (if supplied in request)

string

CarrierPickupChangeResponse/ Package

Required

Packages to be picked up (multiple <Package> tags can be returned with accompanying <ServiceType> and <Count> tags.

(group)

CarrierPickupChangeResponse/ Package/ ServiceType

Required

Types of package services requested

string

CarrierPickupChangeResponse/ Package/ Count

Required

Number of packages for each service type requested

string

CarrierPickupChangeResponse/ EstimatedWeight

Required

Total estimated weight of all packages to be picked up

string

CarrierPickupChangeResponse/ PackageLocation

Required

Location of pickup

string

CarrierPickupChangeResponse/ SpecialInstructions

Optional

Special instructions for pickup

string

CarrierPickupChangeResponse/ ConfirmationNumber

Required

Confirmation number for pickup

string

CarrierPickupChangeResponse/ DayOfWeek

Required

Day of week for pickup

string

CarrierPickupChangeResponse/ Date

Required

Scheduled date for pickup

string

CarrierPickupChangeResponse/ Status

Optional

Status of request to change

string

CarrierPickupChangeResponse/ EmailAddress

Optional

Email Address (if supplied in request)

string

 

Sample Response

The original database record with the information from the request is updated with the changes.  The Package Pickup Change Web Tools returns the following information to the user:

<CarrierPickupChangeResponse>

<FirstName>John</FirstName>

<LastName>Doe</LastName>

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<Phone>(555) 555-1234</Phone>

<Extension>201</Extension>

<Package>

     <ServiceType>PriorityMailExpress</ServiceType>

     <Count>2</Count>

</Package>

<Package>

     <ServiceType>PriorityMail</ServiceType>

     <Count>1</Count>

</Package>

<EstimatedWeight>14</EstimatedWeight>

<PackageLocation>Front Door</PackageLocation>

<SpecialInstructions>Packages are behind the screen door.</SpecialInstructions>

<ConfirmationNumber>ABC12345</ConfirmationNumber>

<DayOfWeek>Monday</DayOfWeek>

<Date>04/01/2004</Date>

<Status>Update successful</Status>

</CarrierPickupChangeResponse>

 


 

5.  Package Pickup Inquiry Web Tools

API Signature

Scheme

Host

Path

API

XML

https://

secure.shippingapis.com

/ShippingAPI.dll

?API=CarrierPickupInquiryRequest

&XML=(see below)

 

The Package Pickup Inquiry Web Tools provides the data contained in your original Pickup Schedule request.  To use either the Pickup Cancel or Pickup Change Web Tools, the exact data from the original Schedule request must be entered.  By using the Pickup Inquiry Web Tools, you can obtain the data needed.

Request Description

The table below presents the XML input tags for generating Live requests and 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 Tools will simply pass in the characters up to the maximum amount allowed and disregard the rest.  This is important since the resulting value could prevent a correct response.

Tag Name

Occurs

Description

Type

Validation

CarrierPickupInquiryRequest

Required

Input tag exactly as presented.

(group)

 

CarrierPickupInquiryRequest / @USERID

Required

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

string

 

CarrierPickupInquiryRequest / FirmName

Optional

Only alpha and numeric characters, apostrophes, spaces, hyphens "-" and ampersands "&" may be used.

Use this tag for a firm or company name.  FirmName is optional except if needed to uniquely identify an address.  Some firms/companies that have their own ZIP codes require the use of firm name to properly identify their address.

For example: <FirmName>ABC Company</FirmName>

string

minLength value=0

maxLength value=50

 

CarrierPickupInquiryRequest / SuiteOrApt

Required

Use this tag for an apartment or suite number.  SuiteOrApt is optional except if needed to uniquely identify an address at a multiple dwelling address, for example, an apartment building.

For example: <SuiteOrApt>Suite 777</SuiteOrApt>

string

minLength value=0

maxLength value=50

 

CarrierPickupInquiryRequest / Address2

Required

Use this tag for a street address.

For example:

<Address2>1390 Market Street</Address2>

string

minLength value=0

maxLength value=50

 

CarrierPickupInquiryRequest / Urbanization

Required

Use this tag for an Urbanization (for Puerto Rico only).  ZIP Code prefixes 006 to 009, if area is so designated.

string

minLength value=0

maxLength value=28

 

CarrierPickupInquiryRequest / City

Required

Use this tag for a city.  Either ZIP5 or City and State are required

For example: <City>Houston</City>

string

minLength value=0

maxLength value=30

 

CarrierPickupInquiryRequest / State

Required

Use this tag for a state abbreviation.  Either ZIP5 or City and State are required.

For example: <State>TX</State>

string

minLength value=0

maxLength value=2

 

CarrierPickupInquiryRequest / ZIP5

Required

Use this tag for a 5 digit ZIP Code.  Input tag exactly as presented--all caps.  Maximum characters allowed: 5.  Either ZIP5 or City and State are required.

For example: <ZIP5>77058</ZIP5>

string

minLength value=0

maxLength value=5

 

CarrierPickupInquiryRequest / ZIP4

Required

UInput tag exactly as presented--all caps.  Maximum characters allowed: 4.

For example: <ZIP4>1234</ZIP4>

string

minLength value=0

maxLength value=4

 

CarrierPickupInquiryRequest / ConfirmationNumber

Required

Enter exact Confirmation Number returned with Package Pickup Schedule request.

For example: <ConfirmationNumber>ABC12345</ConfirmationNumber>

string

minLength value=1

maxLength value=30

 

Sample Request

The Live XML request should be in the following form and sequence:

<CarrierPickupInquiryRequest UserID="XXXX">

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<ConfirmationNumber>ABC12345</ConfirmationNumber>

</CarrierPickupInquiryRequest>

 


 

 

Response Description

Tag Name

Occurs

Description

Type

CarrierPickupInquiryResponse/

Required

Type of Response

(group)

CarrierPickupInquiryResponse/ FirstName

Required

First name of person sending request

string

CarrierPickupInquiryResponse/ LastName

Required

Last name of person sending request

string

CarrierPickupInquiryResponse/ FirmName

Required

Firm name sending request (if supplied in request)

string

CarrierPickupInquiryResponse/ SuiteOrApt

Required

Suite or apartment (only returned in response if needed to uniquely identify the address, for example, at a multiple dwelling address)

string

CarrierPickupInquiryResponse/ Address2

Required

Pickup address

string

CarrierPickupInquiryResponse/ Urbanization

Required

Urbanization (if supplied in request)

string

CarrierPickupInquiryResponse/ City

Required

Pickup city

string

CarrierPickupInquiryResponse/ State

Required

Pickup state

string

CarrierPickupInquiryResponse/ ZIP5

Required

Pickup ZIP Code

string

CarrierPickupInquiryResponse/ ZIP4

Required

Pickup ZIP Code+4

string

CarrierPickupInquiryResponse/ Phone

Required

Phone number of sender

string

CarrierPickupInquiryResponse/ Extension

Required

Phone extension of sender (if supplied in request)

string

CarrierPickupInquiryResponse/ Package

Required

Packages to be picked up (multiple <Package> tags can be returned with accompanying <ServiceType> and <Count> tags.

(group)

CarrierPickupInquiryResponse/ Package/ ServiceType

Required

Types of package services requested

string

CarrierPickupInquiryResponse/ Package/ Count

Required

Number of packages for each service type requested

string

CarrierPickupInquiryResponse/ EstimatedWeight

Required

Total estimated weight of all packages to be picked up

string

CarrierPickupInquiryResponse/ PackageLocation

Required

Location of pickup

string

CarrierPickupInquiryResponse/ SpecialInstructions

Required

Special instructions for pickup

string

CarrierPickupInquiryResponse/ ConfirmationNumber

Required

Confirmation number for pickup

string

CarrierPickupInquiryResponse/ DayOfWeek

Required

Day of week for pickup

string

CarrierPickupInquiryResponse/ Date

Required

Scheduled date for pickup

string

CarrierPickupInquiryResponse/ EmailAddress

Optional

Email Address

string

Sample Response

The Package Pickup Inquiry Web Tools reads the database record and the following information is returned to the user:

<CarrierPickupInquiryResponse>

<FirstName>John</FirstName>

<LastName>Doe</LastName>

<FirmName>ABC Corp.</FirmName>

<SuiteOrApt>Suite 777</SuiteOrApt>

<Address2>1390 Market Street</Address2>

<Urbanization></Urbanization>

<City>Houston</City>

<State>TX</State>

<ZIP5>77058</ZIP5>

<ZIP4>1234</ZIP4>

<Phone>(555) 555-1234</Phone>

<Extension>201</Extension>

<Package>

     <ServiceType>PriorityMailExpress</ServiceType>

     <Count>2</Count>

</Package>

<Package>

     <ServiceType>PriorityMail</ServiceType>

     <Count>1</Count>

</Package>

<EstimatedWeight>14</EstimatedWeight>

<PackageLocation>Front Door</PackageLocation>

<SpecialInstructions> Packages are behind the screen door.</SpecialInstructions>

<ConfirmationNumber>ABC12345</ConfirmationNumber>

<DayOfWeek>Monday</DayOfWeek>

<Date>04/01/2004</Date>

</CarrierPickupInquiryResponse>

 


 

C.  Package Pickup Messages

This section provides specific USPS guidelines, recommendations, and requirements for the user interfaces that gathers and displays pickup information.

User Interface Messages

The following table identifies language that must be incorporated into the user interface that you create for your end users.  The messages are organized according to the appropriate Web Tools.

 

Web Tools(s)

Language to be incorporated

Pickup Availability

Pickup Schedule

What You Should Know

Package Pickup is available for the following services:

o    Priority Mail Express

o    Priority Mail

o    Returned merchandise

o    International

·         Pickup occurs the next USPS delivery day.

·         Requests must be received by 2:00 AM CST.

·         Packages must have correct postage affixed.

·         If stamps are used, a face-to-face transaction with your carrier is required.

·         Packages must be properly sealed and ready for shipment.

·         Maximum weight per package is 70 pounds.

·         Packages requiring Postal insurance services need to be taken to a post office.

Pickup Availability

Pickup Schedule

Pickup Cancel

Pickup Change

Change or Cancel Your Request