USPS Shipping User Guide
NB There is a separate popup with the Installation Guide
Settings Overview
The new USPS API needs mail item dimensions to return a rate so the module has settings for typical packages and letters, with separate settings for domestic and international orders.
The module offers custom weight filtering which lets you offer different services depending on order weight e.g. smallest orders at letter rates, larger orders only package even if less than USPS limit for letters.
Additional services which are configured will always be included in the quotes returned - they too are configured separately for packages & letters, domestic and international.
For each you decide whether it's shown to the customer or not.
There are several ways of defining additional (handling) fees; choose an approach or combination that suits your business.
- You can define a flat fee against each individual service, in the service settings
In addition, or instead
- You can add a flat fee per order, or per package
- Or you can add a fee calculated as a percentage markup of the USPS quote
Settings - Selected Details
Weight Units
The USPS REST API always needs weight in lb. The weight limits in the module are also interpreted as lb.
If the weight values on your products are not in lb, change this setting to match and order weight is converted automatically in the module.
NB the weights in your shipping/packaging settings need to be in the same units as your products.
Dimension Units
USPS always wants sizes in inches, but if you can only think in metric you can change this to cm and the dimension settings will be presented in cm and converted automatically.
Letter Type
If you use letter rates, set the typical type here; it will be used for each letter quote.
Domestic and International Price Types
If you don't want to offer international services, set the International Price Type to None.
Retail are the prices at the counter, Commercial are the online prices for labels, with Contract or NSA you also need to provide Contract Type and Account Number
Shipping Zone
This uses the zone-based filtering from core. You could use it to adjust the filtering built into the module.
Shipping Services
Check the box to offer a service (if the destination, weight and dimensions are within USPS limits for the service). If you want to set different min and max weights for offering it or want to add a fee, use the fields on the right. Blank is interpreted as 0.
Set Extras (four sets)
Check the addon services that will be included in the rates. On the right, choose whether to display the service in checkout and on the order.
Show Full Service Names
I suggest you set this True while configuring the module so that you can check exactly which services from the choice list are offered, but then set to False for ongoing use to avoid disputes e.g. if a differently sized container was actually used.
Display Timescales
Initially, this adds the USPS product description to the displayed quote which includes the typical delivery timeframes for the service. A future release may use the USPS Standards API instead.
Alert Email Address
Set an email address here so that you get alerted when the module hits problems as defined in the next settings.
Alert Return Codes
Setting 429 here tells you when USPS is rate-limiting your requests. If this is happening, you need to request a higher rate than the default (60 per hour) from them. Be aware it takes them a long time to do this (a month or more).
Alert No Quotes
Set this True so you get an email when the module doesn't return any quotes - either because USPS didn't return any for the data it was given, or because it did return them but they were all filtered out by the module either because the service wasn't selected at all or because the parcel was outside the weight range in the settings.
Rating Parameters Hook
The module includes a hook which will let you manipulate the parameters used in the rates request if your site has extensions that process information that could affect the rate e.g. product-based requirements for Hazardous Materials, a checkout request for Sunday delivery. The hook is at the end of the method quote_check_order. If you need help implementing it, please ask.
