USPS Shipping Module [Support Thread]

After all these years (!), this thread will now consolidate the support-thread for the USPS shipping module, downloadable from the Zen Cart plugins: https://www.zen-cart.com/downloads.php?do=file&id=1292.

I've gathered a bunch of disparate threads previously posted, in an attempt to keep everything 'together':

• https://www.zen-cart.com/showthread.php?225017-USPS-Jan-2019-update
• https://www.zen-cart.com/showthread.php?225155-USPS-shipping-module-will-not-return-rates
• https://www.zen-cart.com/showthread.php?223794-V1-5-5D-USPS-Shipping-module-I-just-noticed-no-USPS-retail-Ground-Displaying
• https://www.zen-cart.com/showthread.php?224426-USPS-Shipping-Module-We-are-unable-to-find-a-USPS-shipping-quote-suitable
• https://www.zen-cart.com/showthread.php?220679-Restrict-USPS-shipping-options-by-product-dimensions
• https://www.zen-cart.com/showthread.php?222201-restricting-media-mail-by-master-category-USPS-2017
• https://www.zen-cart.com/showthread.php?227264-USPS-quot-retiring-quot-unsecure-(http-)-API-URL

Version 2020-09-24 K11 is now available for download: https://www.zen-cart.com/downloads.php?do=file&id=1292

Note that this version is not compatible with Zen Cart versions prior to 1.5.2 and is not supported for Zen Cart versions prior to 1.5.4.

The following changes were made:

- Restructuring to prevent PHP notices and warnings.
- Re-factored to use now-current code styling.
- Includes modifications to use stripos/strpos instead of preg_match for 'simple' string-in-string checks.
- Use foreach() instead of deprecated each()
- Use secure (https: //secure.shippingapis.com/ShippingAPI.dll) endpoint for API requests; unsecure endpoint being retired.
- Simplifies debug handling, 'Screen' and 'Email' no longer supported.
- Debug filename changed to enable sort-by-name to mimic sort-by-date on the files.
- Restores the USPS icon to this shipping-method's distribution zip-file.
- Correct missing constant warning (MODULE_SHIPPING_USPS_REGULATIONS)
- That 'soft' configuration setting is now available in the usps.php language file.
- Additional, previously undefined language constants added in support of the display.
- 'Return Receipt for Merchandise [107]' retired and USPS will return an error if requested.
- Country name changes:
- Country ('MK') changed from 'Macedonia, Republic of' to 'North Macedonia, Republic of'.
- Country ('SZ') changed from 'Swaziland' to 'Eswatini'.
- Country ('SS') added (South Sudan); note that the country is not currently registered in the countries table.
- Add 'soft' configuration settings, present in the module's language file (refer to that file for additional information):
- MODULE_SHIPPING_USPS_SHIPPING_CUTOFF ... the shipping cut-off time, used to determine the delivery date.
- MODULE_SHIPPING_USPS_GROUNDONLY ... identifies whether the database field 'products::products_groundonly' should be interrogated.
- MODULE_SHIPPING_USPS_FRAGILE ... identifies whether the database field 'products::products_fragile' should be interrogated.
- Remove fallback 'plugin_check_for_updates' function. It's now expected to be present as part of the base Zen Cart distribution (zc152+).
- Auto-disable on the storefront if no shipping services have been selected or if the store's country-of-origin isn't the US (country code 223).

Thanks lat9 for the refresh and xoxo to Ajeh for all her efforts (past, present, and future), too.

Where would the 'if clause' be inserted in this update to create a USPS Minimum Shipping Cost? Example $6 for 1st Class.
USPS_2020_09_24_K11>includes>modules>shipping>usps.php @line 779 ?

Was using this in previous versions. Thanks in advance.


$methods[] = array('id' => $type, 'title' => $this->types[$type], 'cost' => ($cost + MODULE_SHIPPING_USPS_HANDLING) * $shipping_num_boxes);

to now force the amount ...
Code:

if ($cost < 6.00) { $methods[] = array('id' => $type, 'title' => $this->types[$type], 'cost' => (6.00 + MODULE_SHIPPING_USPS_HANDLING) * $shipping_num_boxes);} else { $methods[] = array('id' => $type, 'title' => $this->types[$type], 'cost' => ($cost + MODULE_SHIPPING_USPS_HANDLING) * $shipping_num_boxes);

@webskipper, find the following code fragment, starting at line 724:

            // add handling for shipping method costs for extra services applied
            $cost_original = $cost;
            $cost = ($cost + $handling + $hiddenCost) * $shipping_num_boxes;
            // add handling fee per Box or per Order
            $cost += (MODULE_SHIPPING_USPS_HANDLING_METHOD == 'Box') ? $usps_handling_fee * $shipping_num_boxes : $usps_handling_fee;

and add the highlighted code fragments:

            // add handling for shipping method costs for extra services applied
            $cost_original = $cost;

//-bof-Force minimum cost of $6.00
            if ($cost < 6) {
                $cost = 6;
            }
//-eof-Force minimum cost

            $cost = ($cost + $handling + $hiddenCost) * $shipping_num_boxes;
            // add handling fee per Box or per Order
            $cost += (MODULE_SHIPPING_USPS_HANDLING_METHOD == 'Box') ? $usps_handling_fee * $shipping_num_boxes : $usps_handling_fee;

Worked like magic! Thanks.

Donated a Jackson.

I will periodically see

--> PHP Warning: count(): Parameter must be an array or an object that implements Countable in /SITE/includes/modules/shipping/usps.php on line 492. // line 487 in an unmodified file

where that line is

$PackageSize = count($uspsQuote['Package']['Service']);

This is the else branch of $this->is_us_shipment.

Is it possible this branch needs the same check as the other branch, where we check count($uspsQuote['Package']); (line 480).

swguy:

I will periodically see

--> PHP Warning: count(): Parameter must be an array or an object that implements Countable in /SITE/includes/modules/shipping/usps.php on line 492. // line 487 in an unmodified file

where that line is

$PackageSize = count($uspsQuote['Package']['Service']);

This is the else branch of $this->is_us_shipment.

Is it possible this branch needs the same check as the other branch, where we check count($uspsQuote['Package']); (line 480).

Quite possible!

What international methods and services does the site offer?
Do you have any insight into the ship-to country/zone/postcode used when the warning was issued?

Recently upgraded to 1.5.7 of ZC, but have not been able to import orders to stamps.com since Saturday. Should I have my web person install this module, or is it included in 1.5.7? Trying to figure out why I can't import; I have the updated php file that DrByte wrote, and it was working fine until today.

CraftCorner:

Recently upgraded to 1.5.7 of ZC, but have not been able to import orders to stamps.com since Saturday. Should I have my web person install this module, or is it included in 1.5.7? Trying to figure out why I can't import; I have the updated php file that DrByte wrote, and it was working fine until today.

The USPS shipping module must be installed separately from the 'base' Zen Cart files. Note that the shipping-module has no effect on the ShipStation import; it's only active during a site's checkout.

I'm trying to get this working on Zencart 1.5.5f and keep getting an error on the checkout page that says:

"An error occurred in obtaining USPS shipping quotes.
If you prefer to use USPS as your shipping method, please try refreshing this page, or contact the store owner."

I've turned on debugging and the log has the following (I've replaced the username):

2020-11-12 18:28:26: USPS build: 2020-09-24 K11

Server: production
Quote Request Rate Type: Retail
Quote from main_page: checkout_shipping
USPS Options (weight, time): --none--
USPS Domestic Transit Time Calculation Mode: CUSTOM
Cart Weight: 0.5
Total Quote Weight: 0.5 Pounds: 0 Ounces: 8
Maximum: 50 Tare Rates: Small/Medium: 0 Large: 0
Handling method: Box Handling fee Domestic: $0.00 Handling fee International: $0.00
Decimals: 3
Domestic Length: 8.625 Width: 5.375 Height: 1.625
International Length: 9.50 Width: 1.0 Height: 5.50
All Packages are Machinable: False
Enable USPS First-Class filter for US shipping: True
Sorts the returned quotes: Unsorted

ZipOrigination: 92065
ZipDestination: Postcode: 32570 Country: United States City: Milton State: Florida
Order SubTotal: $34.95
Order Total: $34.95
Uninsurable Portion: $0.00
Insurable Value: $34.95

2020-11-12 18:28:26: Sending request to USPS

2020-11-12 18:28:41: ==================================

SENT TO USPS:

<RateV4Request USERID="**********"><Revision>2</Revision>
<Package ID="0"><Service>First Class</Service><FirstClassMailType>FLAT</FirstClassMailType><ZipOrigination>92065</ZipOrigination><ZipDestination>32570</ZipDestination><Pounds>0</Pounds><Ounces>8</Ounces><Container>VARIABLE</Container><Size>REGULAR</Size><Value>34.95</Value><Machinable>FALSE</Machinable></Package>
<Package ID="1"><Service>First Class</Service><FirstClassMailType>PARCEL</FirstClassMailType><ZipOrigination>92065</ZipOrigination><ZipDestination>32570</ZipDestination><Pounds>0</Pounds><Ounces>8</Ounces><Container>VARIABLE</Container><Size>REGULAR</Size><Value>34.95</Value><Machinable>FALSE</Machinable></Package>
<Package ID="2"><Service>MEDIA</Service><ZipOrigination>92065</ZipOrigination><ZipDestination>32570</ZipDestination><Pounds>0</Pounds><Ounces>8</Ounces><Container>VARIABLE</Container><Size>REGULAR</Size><Value>34.95</Value><Machinable>FALSE</Machinable></Package>
<Package ID="3"><Service>PARCEL</Service><ZipOrigination>92065</ZipOrigination><ZipDestination>32570</ZipDestination><Pounds>0</Pounds><Ounces>8</Ounces><Container>VARIABLE</Container><Size>REGULAR</Size><Value>34.95</Value><Machinable>FALSE</Machinable></Package>
<Package ID="4"><Service>PRIORITY COMMERCIAL</Service><ZipOrigination>92065</ZipOrigination><ZipDestination>32570</ZipDestination><Pounds>0</Pounds><Ounces>8</Ounces><Container>VARIABLE</Container><Size>REGULAR</Size><Value>34.95</Value><Machinable>FALSE</Machinable></Package>
</RateV4Request>


RESPONSE FROM USPS:

==================================
CommErr (should be 0): 28 - connect() timed out!

==================================

USPS Country - $order->delivery[country][iso_code_2]: United States $this->usps_countries: US
Domestic Services Selected:

That's something to do with your site's server settings, as the request to USPS has (as the debug indicates) timed out.

What version of PHP is in use?

When you view the Admin Tools->Server/Version Information, what values are shown for the site's CURL settings?

I'm trying to upgrade my usps shipping module...I am not good at this. I followed the instructions..downloaded, unzipped. It said to upload the two files...I found the usps.php in shipping and languages...deeper..but you know that. Now I have no usps shipping module available in my admin page. Sigh.

GoodLifeToGo:

I'm trying to upgrade my usps shipping module...I am not good at this. I followed the instructions..downloaded, unzipped. It said to upload the two files...I found the usps.php in shipping and languages...deeper..but you know that. Now I have no usps shipping module available in my admin page. Sigh.

Chances are that an error is occurring where it "draws" the usps module details to the screen, and that error is also preventing the right-column and the page-footer from showing too. Is that what you're seeing? If so then the error should be documented in your /logs/ directory as a myDebug-adm-xxxxxxxx.log file every time you try to go to that page. What's in that error log file?

And, double-checking ... while the files have the same name, their contents are different, so ... you uploaded each to their corresponding correct directories, overwriting the prior usps.php files, right?

lat9:

That's something to do with your site's server settings, as the request to USPS has (as the debug indicates) timed out.

What version of PHP is in use?

When you view the Admin Tools->Server/Version Information, what values are shown for the site's CURL settings?

cURL support enabled
cURL Information 7.19.7
Age 3
Features
AsynchDNS No
CharConv No
Debug No
GSS-Negotiate Yes
IDN Yes
IPv6 Yes
krb4 No
Largefile Yes
libz Yes
NTLM Yes
SPNEGO No
SSL Yes
SSPI No
Protocols tftp, ftp, telnet, dict, ldap, ldaps, http, file, https, ftps, scp, sftp
Host x86_64-redhat-linux-gnu
SSL Version NSS/3.44
ZLib Version 1.2.3
libSSH Version libssh2/1.4.2

The current USPS - United States Postal Service module for Zen Cart plugin worked when i was running 1.5.7 Now I am on 1.5.7b and USPS is never an shipping option during the checkout process. No errors are displayed and no error logs created. The only customization is SBA.

What happens if you enable the USPS debug logging? That will let you (and me) know whether the shipping-method is actually requesting quotes from USPS.

There will be USPS_*.log files generated in your site's /logs sub-directory that contain the request/response information.

I should have tried the USPS Debug Log first. It gave me clues with what the problem could be and after trying a couple changes in the shipping module set up I got it working. Thanks for your reply.

Here's where you help others by letting them know what cured the problem. Nothing worse than finding a thread, following it for a few pages and finding "I fixed it.":P

I've recently upgraded to v1.5.7, and thought all was working well. Then I noticed I wasn't receiving any international orders. Maybe because of the pandemic I thought? But no, I created a new user with a known good address in Canada. Tried to place an order, and on the shipping page it says: Shipping Method:
This is currently the only shipping method available to use on this order - and it's blank. Nothing to select. I change to a US address, and it works fine. I then upgraded the USPS shipping module, and still the same. I'm only offering flat rate, based on a quantity, since I only sell 1 thing. On domestic I have selected Priority Sm. F/R Box, Priority Md. F/R Box, Priority Lg. F/R Box. For international, I have selected Priority Intl Sm. F/R Box, Priority Intl Md. F/R Box, Priority Intl Lg. F/R Box. All was working prior to upgrading to v1.5.7, and it seems as though domestic is working as it is. Anything in particular I should look at to try to fix this? I have now turned on debug, and see international customers trying to place orders, but are not able to complete them.

Thanks,
Scott

fordlove:

I've recently upgraded to v1.5.7, and thought all was working well. Then I noticed I wasn't receiving any international orders. Maybe because of the pandemic I thought? But no, I created a new user with a known good address in Canada. Tried to place an order, and on the shipping page it says: Shipping Method:
This is currently the only shipping method available to use on this order - and it's blank. Nothing to select. I change to a US address, and it works fine. I then upgraded the USPS shipping module, and still the same. I'm only offering flat rate, based on a quantity, since I only sell 1 thing. On domestic I have selected Priority Sm. F/R Box, Priority Md. F/R Box, Priority Lg. F/R Box. For international, I have selected Priority Intl Sm. F/R Box, Priority Intl Md. F/R Box, Priority Intl Lg. F/R Box. All was working prior to upgrading to v1.5.7, and it seems as though domestic is working as it is. Anything in particular I should look at to try to fix this? I have now turned on debug, and see international customers trying to place orders, but are not able to complete them.

Thanks,
Scott

I'm sorry you're having issues with the USPS shipping module. You indicated that you enabled the USPS debug, would you post the contents of one where the international orders have failed? If you do, you could post those contents within the "CODE" tags (the big # in the menu-bar when you're writing your response)?

BTW, which version of 1.5.7 is installed? 1.5.7 (no suffix), 1.5.7a or 1.5.7b?