Knowledgebase:
U.S.P.S. Shipping API Update
Posted by Nick Rodney, Last modified by Wayne Smith on 03 November 2014 07:07 AM

U.S.P.S recently sent out the following e-mail to all of their Web Tools customers notifying them about an update to their Shipping API that will take place on 1/27/2013:

 

Subject: Web Tools Integrator Notice: January 27, 2013 USPS Price Change

Web Tools customer;

On January 27, 2013, the Postal Service will update domestic pricing and mailing standards and international prices and product features. For detailed information on prices, mailing standards and new product features, please reference the Federal Register Notices and Pricing Files viewable at
http://pe.usps.com/.

Price Change updates will be available in the Web Tools testing environment for integrator access on or around January 14, 2013. The test environment can be accessed, using your production UserID, via the following URL scheme, host and path:

- Secure APIs: https://stg-secure.shippingapis.com/ShippingApi.dll

- Non-secure APIs: http://stg-production.shippingapis.com/ShippingApi.dll

Below is a summary of changes to each affected API. Please note that the changes below are intended to be backwards compatible, however, may not be depending on how individual programs and applications are integrated with the APIs. If you rely upon a third party developer (e.g. software or ecommerce/cart provider) for USPS products and services on your website or in your application, please direct any questions to them.

Domestic Rate Calculator APIs

- RateV4

o Updated product and extra service prices

o Parcel Post renamed Standard Post

• When <Service>= “ALL,” ”ONLINE,” or “PARCEL POST”, WebTools ClientServiceID="4" (MailService=“Parcel Post®”) will return as MailService=“Standard Post®”

• New <Service> enumeration “STANDARD POST” will be available and return Standard Post single-piece postage and extra services pricing and availability

o Delivery Confirmation renamed USPS Tracking/Delivery Confirmation

• When <Revision>=”2” and <Service> is not “ALL,” ”ONLINE,” “PLUS”, WebTools SpecialService ServiceID="13" (ServiceName=“Delivery Confirmation™”) will return as ServiceName=“USPS Tracking/Delivery Confirmation™”

- RateV3

o Updated product and extra service prices

o Parcel Post renamed Standard Post

• When <Service>= “ALL,” ”ONLINE,” or “PARCEL POST”, WebTools ClientServiceID="4" (MailService=“Parcel Post®”) will return as MailService=“Standard Post®”

Domestic Label APIs

- Express Mail Label (ExpressMailLabel) and Hold For Pickup Express (HoldForPickupExpress)

o Intelligent Mail® Package Barcode (IMpb)

• Presence of optional NineDigitRoutingZip tag as the final tag of the request will trigger the return of the IMpb barcode on January 27, 2013

• The IMpb barcode will be returned in all responses effective February 24, 2013

• For more information on the IMpb, please reference https://ribbs.usps.gov/index.cfm?page=intellmailpackage

- Delivery/Signature Confirmation (DeliveryConfirmationV2, V3, V4; SignatureConfirmationV3, V4)

o Parcel Post renamed Standard Post

• New <ServiceType> enumeration “STANDARD POST” will be available

o Label Image Changes:

• Product banner text updates for rebranding of “Parcel Post” to “Standard Post”

• Service banner text updates for rebranding of “Delivery Confirmation™” service to “USPS TRACKING #”

- Merchandise Return Service (MerchandiseReturnV2, V3, V4)

o Intelligent Mail® Package Barcode (IMpb)

• Response will return 30 digit IMpb barcode format as default

• <NineDigitRoutingZip> tag (optional tag, optional value) added as the last request tag to indicate five or nine digit routing zip code (30 and 34-digit IMpb barcode).

• New <ServiceType> enumeration “STANDARD POST” will be available

o Label Image Changes:

• Product banner text updates for rebranding of “Parcel Post” to “Standard Post”

International Rate Calculator APIs

- IntlRateV2 and IntlRate

o Updated product and extra service prices

o USPS e-Delivery Confirmation International

• New USPS e-Delivery Confirmation International extra service available for Priority Mail International Flat Rate Envelope and Small Flat Rate Box and First Class Mail International (ServiceID=”9”)

o First-Class Mail® International Parcel name change:

• When <MailType>= “ALL” or ”PACKAGE” , WebTools Service ID="15" (SvcDescription=“First-Class Mail® International Parcel**”) will now return as SvcDescription=“First-Class Package International Service™”

o Extra service Restricted Delivery (ServiceID=’3’) will no longer be available for international products

o Express Mail International Flat Rate Envelopes will have a four pound maximum weight

International Label APIs

- Express Mail International (ExpressMailIntl)

o <ImageParameter> tag (optional tag, optional value) added to <ImageParameters> group

• “4BY6LABEL” added as enumeration to <ImageParameter> tag; returns 4x6 label image when used

o Image changes:

• 4x6 label image added as an option

• “Total Qty” field added to the label image

• <FromPhone> value returned in From Address section of label image (Format: 555-555-5555)

• General label image text and instructions updates.

• “Detailed description of contents” now “Detailed Description of Contents”

• “Contents” now “Contents: (Check All That Apply)”

• “Postage and Fees” now “Total Postage/Fees”

• “0” defaulted in weight column when no value provided in NetPounds or NetOunces tag

• Date update to September 2012

- Priority Mail International (PriorityMailIntl)

o <ImageParameter> tag (optional tag, optional value) added to <ImageParameters> group

• “4BY6LABEL” added as enumeration to <ImageParameter> tag; returns 4x6 label image when used

• “4BY6LABEL” valid for all labels except the Flat Rate Envelope and Small Flat Rate Box

o Extra services

• <ExtraServices> group (optional tags, optional values) added to the end of the request schema, with repeating <ExtraService> tags as children

• "9" added as enumeration to <ExtraService> to indicate Electronic USPS Delivery Confirmation International is desired

• Valid only for requests for the Flat Rate Envelope and Small Flat Rate Box

• <ExtraServices> group (optional tags, optional values) added to response schema, with <ExtraService> tag grouping <ServiceID>, <ServiceName> and <Price> tags as children

o Image changes:

• 4x6 label image added as an option

• “Total Qty” field added to the label image

• <FromPhone> value returned in From Address section of label image (Format: 555-555-5555)

• General label image text and instructions updates:

• “Detailed description of contents” now “Detailed Description of Contents”

• “Contents” now “Contents: (Check All That Apply)”

• “Postage and Fees” now “Total Postage/Fees”

• “0” defaulted in weight column when no value provided in NetPounds or NetOunces tag

• Date update to September 2012

o Image changes (Flat Rate Envelope and Small Flat Rate Box)

• Country of Origin and HS Tariff Number fields added

• <FromPhone> value returned in From Address section of label image (Format: 555-555-5555)

• General label image text and instructions updates:

• “Detailed description of contents” now “Detailed Description of Contents”

• “Contents” now “Contents: (Check All That Apply)”

• “AES/ITN/Exemption” now “AES Exemption”

• “0” defaulted in weight column when no value provided in NetPounds or NetOunces tag

• Date update to September 2012

- First Class Mail International (FirstClassMailIntl)

o Extra services

• <ExtraServices> group (optional tags, optional values) added to the end of the request schema (just before new PriceOptions tag), with repeating <ExtraService> tags as children

• "9" added as enumeration to <ExtraService> to indicate Electronic USPS Delivery Confirmation International is desired

• <ExtraServices> group (optional tags, optional values) added to response schema, with <ExtraService> tag grouping <ServiceID>, <ServiceName> and <Price> tags as children

o <PriceOptions> tag (optional tag, optional value) added to the end of the request schema

• Valid enumerations are “RETAIL” (default), “COMMERCIAL BASE” and “COMMERCIAL PLUS”

o Image changes:

• Rebranding of “First-Class Mail International” to “First-Class Package International Service™” in banner and receipt text

• Country of Origin and HS Tariff Number fields added

• <FromPhone> value returned in From Address section of label image (Format: 555-555-5555)

• General label image text and instructions updates:

• “Detailed description of contents” now “Detailed Description of Contents”

• “Contents” now “Contents: (Check All That Apply)”

• “AES/ITN/Exemption” now “AES Exemption”

• “0” defaulted in weight column when no value provided in NetPounds or NetOunces tag

• Date update to September 2012

- 2976A Customs Form (CP72V3)

o <ImageParameter> tag (optional tag, optional value) added to <ImageParameters> group

• “4BY6LABEL” added as enumeration to <ImageParameter> tag; returns 4x6 label image when used

o Image changes:

• 4x6 label image added as an option

• “Total Qty” field added to the label image

• <FromPhone> value returned in From Address section of label image (Format: 555-555-5555)

• General label image text and instructions updates:

• “Detailed description of contents” now “Detailed Description of Contents”

• “HS tariff number” now “HS Tariff Number”

• “Country of origin of goods” now “Country of Origin”

• “Contents” now “Contents: (Check All That Apply)”

• “Postage and Fees” now “Total Postage/Fees”

• “Commercial sample” now “Commercial Sample”

• “Returned goods” now “Returned Goods”

• “0” defaulted in weight column when no value provided in NetPounds or NetOunces tag

• Date update to September 2012

- 2976 Customs Form (CN22V2)

o <CountryOfOrigin> tag (optional tag, optional value) added to the end of each <ItemDetail> group

o Image changes:

• “Country of Origin” field added

• <FromPhone> value returned in From Address section of label image (Format: 555-555-5555)

• Mailing Office Date Stamp added to top copy

• General text and instructions updates:

• “IMPORTANT: …” text on label face now “IMPORTANT: The item/parcel may be opened officially. See Privacy Notice on next printed page.”

• “Detailed description of contents” now “Detailed Description of Contents”

• “Contents” now “Contents: (Check All That Apply)”

• “AES/ITN/Exemption” now “AES Exemption”

• “Commercial sample” now “Commercial Sample”

• “Country of Origin of Goods _______” text removed

• Total sum of item quantities displayed.

• “0” defaulted in weight column when no value provided in NetPounds or NetOunces tag

• Date update to September 2012

For questions and concerns, please contact our customer support at 1-800-344-7779 or uspstechsupport@esecurecare.net
<mailto:uspstechsupport@esecurecare.net>.
______________

Web Tools Program Office
USPS Digital Access

 

ISSUE:

Currently, the module has not been updated to reflect the new shipping method names (i.e. Parcel Post® has been changed to Standard Post®), which may cause some slight confusion when selecting shipping methods that people are accustomed to seeing. However, the rates will still be accurate since they are being generated directly from the U.S.P.S. Web Server.

 

RESOLUTION:

Until we release a patch for the module in a future update (TBA), merchants using stores that are running on Production Release 8 Update 4 or newer can use the Shipping Rules "Display As" feature to change the shipping method display names to reflect the new naming conventions by logging in to their admin and performing the following steps:

1.) Click on the "+" next to "Shipping Settings".

2.) Click on "Shipping Rules".

3.) Click on the "Shipping Method Rules" tab.

4.) Click on the Shipping Method Name you wish to edit (i.e. U.S.P.S. Parcel Post®).

5.) Enter in the name of the shipping method you want your customers to see when presented with the selected shipping method (i.e. U.S.P.S. Standard Post®) in the "Display As" field and click "Save".

*Hint: You can display the ® character by holding down the alt key and entering in 0174

 

RESULTS:

The shipping method will now show the method name you entered in the "Display As" field on both the "Shipping Method Rules" menu and in the "Ship Via" drop-down menu on the site.

 

*NOTE: If the merchant is using a 3rd Party Shipping Management module, such as Shipping Supermod, the method name will have to be updated in the module configuration menu in order for the changes to take effect.

 

(0 vote(s))
This article was helpful
This article was not helpful

Help Desk Software by Kayako support.miva.com/supportsuite/index.php?