USPS Integration – WHY2 Extensions Manual

Overview

USPS Integration: an enhanced USPS extension that supports all rates, including Dimensional Weight, Balloon, and Oversize Package Surcharges.

Plus these added features:
1. Additional Weight field to easily add standard packaging weight, rather than having to do it on each item.
2. Additional Fee field to add upcharge – can be fixed dollar amount or percentage of shipping rate.
3. If enabling Ship Product Individually but without having fixed price rates are calculated separately for that item based on weight or dimensions. If item is ordered with other items is it correctly added to total shipping fees, but not included in calculation of other items.
4. Works well with the default free shipping, default per item shipping, default flat rate shipping.
5. Ability to select Zip/Postal code(s) to offer local delivery service only. Local delivery service may be offered as free service or with a flat charge. Admin can show additional message in the checkout cart page to inform the customers about the local delivery service. Admin may choose to show just the local delivery service or all the shipping services offered for the selected Zip/Postal code(s).

AbanteCart v1.2.16 use USPS Integration v1.2.16.2. Tested up to PHP 7.4.
AbanteCart V1.2.0 – v1.2.15 use USPS Integration v1.2.15.4.

Important Notes:
1. Starting with extension v1.2.15 we have adopted a license key for all our extensions. Your extension will only work if you have a validated license key entered for the location where your extension is installed. Refer to here for more details on how license keys work.
2. AbanteCart v1.2.14 is extremely problematic. Install Patch files or better to update to 1.2.15.

Important Note:

Weight and length class must be set correctly within the System > Settings > Details page.
In Metric locations use: Kilogram in Weight Class fields and Centimeter in Length Class.
In US or other non-metric locations use: Pound in Weight Class and Inch in Length Class.
Using AbanteCart prior to v1.2.2: If you Edit Order Details as Admin within Sales > Orders the ReCalculation of a changed order is not supported. You need to change the shipping rate manually. If using AbanteCart v1.2.2 or later, it will update upon ReCalculation.
Check Changelog for upgrading notes.

Setup

1. Turn ON to use the extension.
2. Enter your license code. Refer to How to obtain license code section for more information.
3. Select your desired USPS icon that will be displayed to customer during checkout.
4. Turn ON if you want to set this extension as the default shipping one.
5. Select payment methods that will be only available for this extension.
6. You can leave it blank if you don’t want to set the extension run order.

Additional Setup

1. Quick How-to.
2. Extension Manual URL Link Button.
You need USPS Web Tools user ID. This is NOT your USPS shipping account information.
Get the Web Tools User ID here: register.

Notes for number 3:
1. You don’t have to set Show Debug Info in System > Settings > System in order to get the API response.
2. The API response is shown in System > Logs > Error Logs.
3. Please send us the API response via our support system so we can look into it to trace the issue. You will need to turn OFF the Debug API Response once the issue is fixed, otherwise the error log will grow large.

3. Debug API response: Turn ON if you want to get the API response for debugging purpose.

4. User ID: Insert your USPS Web Tools User ID here.

5. Password: Insert your USPS Web Tools Password here.

6. Zip Code: Insert your Store ZIP Code here.

7. Test Your Connection: You can test if API credentials that you’ve entered are correct after you saved the credentials.

8. Domestic Services: Select your desired Domestic USPS Shipping Services.

Notes for number 9-11: If you are offering Local Delivery Services AND using more than one shipper you must enable Local Delivery Services on only ONE shipper. e.g. you offer FedEx, UPS and USPS, and also Local Delivery – you must enable Local Delivery on only ONE shipper: FedEx, UPS or USPS.

Notes for AbanteCart v1.2.16: If you are using Default Local Delivery extension, then do not use USPS Integration Local Delivery as it will show double Local Delivery services. You can choose to use USPS Integration Local Delivery but do not use Default Local Delivery. Use only ONE Local Delivery service.

9. Enter Zip/Postal Code(s) eligible to use Local Delivery Service: Use commas(,) without space as the multi Zip/Postal code(s) separator, and no spaces within the Zip/Postal code(s). To define areas use asterisk (*) replacement – eg 351*.

10. Local delivery fee: Enter the local delivery fee if you want to charge customer or leave blank if it is a free delivery.

11. Turn ON to show ONLY Local Delivery Services: Turn OFF if you want to show all shipping options including Local Delivery services.

12. Insert your desired text to be shown on cart page to let customers know about local delivery schedule or services: Insert your desired message.

Notes for number 13 and number 15: If you are using more than ONE shipper and are offering any Free Shipping service, you must choose only ONE shipper for the Free Shipping. e.g. if using USPS , UPS and FedEx, Free Shipping can only be offered from one.

13. If using a Free Shipping option within your cart select which service you are using for the Free Shipping.
This is only for individual product that you set to have a free Domestic Shipping Service.
It works with our Special Shipping Image, default_free_shipping, default_flat_rate shipping and default_per_item_shipping

14. International Services: Select your desired International USPS Shipping Service if you are shipping worldwide.

15. Option for free shipping: Select your desired International USPS Shipping Services for the free shipping.
This is only for individual product that you set to have a free International Shipping Service.

16. Machinable: Choose if your package is machinable.
Click here to read more about it.

Notes for number 17-19: We set a Default of 5 x 5 x 5 which works for most businesses. You can input your normal size if different.
Also, input on a product page will be used for that individual product rate look up. (You need to input individual product size and turn on the Ship Product Individually flag on product page.)

17. Dimensions Length (Optional): Insert your Box Length here.

18. Dimensions Width (Optional): Insert your Box Width here.

19. Dimensions Height (Optional): Insert your Box Height here.

20. Max Box Weight (Optional): Specifies the maximum box size. Once the maximum weight is met, the system will calculate shipping for 2(or more) boxes.

21. Display Delivery Time: Do you want to display the shipping time? This is only used for International Shipment (e.g. 6 – 10 business days)

22. Display Weight: Do you want to display the shipping weight? (e.g. (Weight : 0.11lb))

23. Tax Class: Choose your Tax Class.

24. Location: Choose your Zone. Please refer to our F.A.Q about how to manage the shipping location.

Notes: You can use additional fee or additional weight or you can use both if desired.

25. Additional Fee Type: Choose the type that you want to use for the additional Fee. Fixed amount or Rate Percentage based.

26. Additional Fee: Insert your desired Additional Fee value that you want to charge to your customer.
e.g. The rate is $5.00, your fixed additional fee is $3.00, the rate shown to customer is $8. Or if you’re using the percentage instead of fixed rate, and it is 10% from the rate, the rate will be $5.5. To use either fixed or percentage based additional fee, just enter the digits without the % or currency symbol.

27. Additional Weight: Insert your desired additional weight that you want to charge to your customer.
e.g. The weight is 0.26 lb and your additional weight is 0.50 lb, the weight rate will be 0.76 lb. And if showing shipping wt. in cart 0.26 lb is shown to customer.

Finally Click the Save button and Turn On the extension.

Changelog

v1.2.16.2

2020 – 07 – 16

featureAdd Stamped Letter service. This is added via API rate lookup response, not in the extension settings page.

v1.2.16.1

2020 – 06 – 01

bug-fixFix incorrect shipping rate currency conversion.

v1.2.16

2020 – 05 – 26

featureAdd enable to Debug API response

bug-fixFix when admin update order via Admin Panel, the total cart weight within the shipping title was not updated.

Support AbanteCart v1.2.16.

v1.2.15.4

2020 – 07 – 16

featureAdd Stamped Letter service. This is added via API rate lookup response, not in the extension settings page.

v1.2.15.3

2020 – 06 – 01

bug-fix1. Fix incorrect shipping rate currency conversion.
2. Fix customer currency was not retained when admin update an order via Admin Panel Sales Order page.

v1.2.15.2

2020 – 05 – 26

featureAdd enable to Debug API response

bug-fixFix when admin update order via Admin Panel, the total cart weight within the shipping title was not updated.

v1.2.15.1

2019 – 09 – 03

featureSupport our options calculator.

v1.2.15

2019 – 06 – 15

Initial release for AbanteCart v1.2.15

v1.2.1.11

2018 – 11 – 07

bug-fixNotes: This is only available in AbanteCart v1.2.2+
Fix shipping cost not being calculated correctly if admin add products to existing order via the admin sale order page.

v1.2.1.10

2018 – 10 – 16

bug-fixFix missing First Class Service.

v1.2.1.9

2018 – 08 – 20

bug-fixFix SQL error while upgrading the extension.

v1.2.1.8

2018 – 08 – 20

featureAdd Parcel Select Ground service.

bug-fixFix wrong html entities decoding.

Support PHP v5.3 – v7.2.
Support AbanteCart v1.2.13

v1.2.1.7

2017 – 12 – 22

bug-fixRemove unnecessary quick checkout template files.

Support AbanteCart v1.2.12

v1.2.1.6

2017 – 12 – 04

bug-fix1. Fix wrong language definition for USPS title.
2. Fix missing UPS Plus Locator if used with UPS Plus Integration extension.
3. Fix PHP7 A non-numeric value encountered warning message.
4. Fix wrong sort order.
5. Fix missing other shippers multiple local delivery(UPS integration and FedEx integration) on checkout/cart if used together.
6. Remove USPS services if UPS integration, FedEx integration and show only local delivery option are turned ON.

featureSeparate Local Delivery into a new block for selection.

v1.2.1.5

2017 – 07 – 29

bug-fixFixed multi box wrong calculation.

v1.2.1.4

2017 – 07 – 27

feature1. Exclude certain Zip/Postal code(s) for using USPS service and use local delivery service.
2. Admin may choose if want to show just the local delivery service or all of the shipping services for the excluded Zip/Postal code(s).
3. Admin may charge a fee for the local delivery service or set it as free service.
4. Admin can show additional message in the checkout cart page to inform the customers about the local delivery service.
5. Admins able to use both complete and partial Postal/Zip Code(s) by adding an asterisk(*) behind the code or one of them. It is useful if admins want to define an area instead of fill in the codes one by one. e.g. 351*,35005.

v1.2.1.3

2017 – 04 – 05

bug-fixFixed the wrong individual shipping multiplication.

Support AbanteCart v1.2.10

v1.2.1.2

2016 – 12 – 26

Upgrade Notes:
1. You can directly install without the need to uninstall and delete.
2. Please save the changes by click on the save button and not the quick save button.

bug-fixFixed cart page for v1.2.1+.

featureImplement the test connection and credential in admin additional setting page.

Support AbanteCart v1.2.8 – v1.2.9

v1.2.1.1

2016 – 01 – 14

Changed toUpdated for the USPS production release date January 17, 2016. This release includes the following changes: Standard Post is now Retail Ground.

v1.2.1

2015 – 09 – 19

Initial Release.