http://

secure.shippingapis.com

/ShippingAPI.dll

API=GetLockerInfo

&XML=

(see Tag Descriptions below)

GetLockerInfoRequest

Required

API=GetLockerInfo

Alias

GetLockerInfoRequest / USERID

Required

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

For example: USERID="XXXXXXX"

NMTOKEN

GetLockerInfoRequest / PASSWORD

Optional

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

For Example: PASSWORD="XXXXXXX"

NMTOKEN

GetLockerInfoRequest / Revision

Optional

Set this value to “1” to return the response tag “LockerType”

For example: 1

String

GetLockerInfoRequest / City

Required

City of the Post Office where the Locker is located. To search by City, State must also be included. To return all lockers, do not populate.

For example: Miami

Note: tag must always be included in the request; a value is not required.

String

GetLockerInfoRequest / State

Required

State of the Post Office where the Locker is located. Value should be passed as two-letter state abbreviation. To search by State, City must also be included. To return all lockers, do not populate.

For example: FL

Note: tag must always be included in the request; a value is not required.

String

minLength=2

maxLength=2

GetLockerInfoRequest /Zip5

Required

5-digit ZIP code of the Post Office where the Locker is located. To return all lockers, do not populate.

For example: 33125

Note: tag must always be included in the request; a value is not required.

String

pattern=\d{5}

GetLockerInfoRequest / AdditionalLocationsContextValue

Optional

Pagination feature used to return remaining lockers when more than 100 lockers satisfy search criteria.

Note: When results exceed 100 lockers, the <AdditionalLocationsContextValue> tag is returned. A subsequent request with this value will return the next 100 lockers until all data is returned indicated when this tag no longer returns in the XML response.

String

GetLockerInfoRequest

Required

Alias

GetLockerInfoResponse

Required

Alias

GetLockerInfoResponse /Location

Required

String

minOccurs="1" maxOccurs="100"

GetLockerInfoResponse /Location/FacilityID

Required

Unique identifier of the Post Office where the Locker is located.

Note: This value is required when generating a Locker label in the Web Tools eVS Domestic Label API.

String

GetLockerInfoResponse /Location/LocationAddress

Required

Post Office (where the Locker is located) Address group.

Address Type

GetLockerInfoResponse /Location/LocationAddress/Address1

Required

Primary Street Address of the Post Office where the Locker is located.

String

GetLockerInfoResponse /Location/LocationAddress/Address2

Optional

Secondary Address (if available) of the Post Office where the Locker is located.

String

GetLockerInfoResponse /Location/LocationAddress/City

Required

City of the Post Office where the Locker is located.

City Type

maxLength ="28"

minLength ="0"

GetLockerInfoResponse /Location/LocationAddress/State

Required

State of the Post Office where the Locker is located. Returned as two-letter state abbreviation.

State Type

[a-z or A-Z]{2}

GetLockerInfoResponse /Location/LocationAddress/Zip5

Required

5-digit ZIP code of the Post Office where the Locker is located.

Zip5 Type

[0-9]{5}

GetLockerInfoResponse /Location/LocationAddress/Zip4

Required

4-digit ZIP code of the Post Office where the Locker is located.

Zip4 Type

[0-9]{4}

GetLockerInfoResponse /Location/LocationLatitude

Required

Latitude of the Post Office where the Locker is located.

String

GetLockerInfoResponse /Location/LocationLongitude

Required

Longitude of the Post Office where the Locker is located.

String

GetLockerInfoResponse /Location/DeliveryAddress

Required

Locker Delivery Address group.

Group

GetLockerInfoResponse /Location/DeliveryAddress/Address1

Required

Primary Street Delivery Address of the Locker. Smart Lockers and PO Box Lockers function the exact same but have different delivery addresses (i.e., “USPS SMART LOCKER” or “PO BOX LOCKER”).

String

GetLockerInfoResponse /Location/DeliveryAddress/Address2

Required

Secondary Delivery Address of the Locker (if available).

String

GetLockerInfoResponse /Location/DeliveryAddress/City

Required

Delivery City of the Locker.

String

maxLength ="28"

minLength ="0"

GetLockerInfoResponse /Location/DeliveryAddress/State

Required

Delivery State of the Locker.

Returned as two-letter state abbreviation.

String

[a-z or A-Z]{2}

GetLockerInfoResponse /Location/DeliveryAddress/Zip5

Required

5-digit Delivery ZIP code of the Locker.

String

[0-9]{5}

GetLockerInfoResponse /Location/DeliveryAddress/Zip4

Required

4-digit Delivery ZIP code of the Locker.

String

[0-9]{4}

GetLockerInfoResponse /Location/DeliveryAddress/DeliveryPoint

Required

2-digit Delivery Point Code (DPC) of the Locker.

String

[0-9]{2}

GetLockerInfoResponse /Location/LockerType

Required Revision 1

Locker Type. Indicates if Locker is a USPS Smart Locker or a PO Box.

String

Enumeration=

·        POBoxLocker

·        SmartLocker

GetLockerInfoResponse /Location/LockerStatus

Required

Defaults to Operational.

Note: This API will only return lockers in “Operational” status.

String

GetLockerInfoResponse /Location/LockerOnline

Required

Status of an operational locker.

Boolean

True or False

GetLockerInfoResponse /Location/LockerSizeMaximumLength

Required

Length of the biggest locker compartment for the locker unit.

Decimal

GetLockerInfoResponse /Location/LockerSizeMaximumWidth

Required

Width of the biggest locker compartment for the locker.

Decimal

GetLockerInfoResponse /Location/LockerSizeMaximumHeight

Required

Height of the biggest locker compartment for the locker unit.

Decimal

GetLockerInfoResponse /Location/ServiceDirectShip

Required

Indicates whether the locker can accept direct-to-locker shipments.

Boolean

True or False

GetLockerInfoResponse /Location/ServiceRedelivery

Required

Indicates whether the locker can support redelivery.

Boolean

True or False

GetLockerInfoResponse /Location/ServicePOBoxOverflow

Required

Indicates whether the locker can accept packages that cannot fit into a PO Box.

Boolean

True or False

GetLockerInfoResponse /Location/PrepaidReturns

Required

Indicates whether the locker can accept prepaid returns.

Boolean

True or False

GetLockerInfoResponse /Location/ServiceLabelPrinting

Required

Indicates whether the locker has printing capability.

Boolean

True or False

GetLockerInfoResponse /AdditionalContextValue

Optional

Returns the 7-digit context value so integrators can obtain additional locations.

Context Type

[0-9]{7}

GetLockerInfoResponse

Required

Alias