This module uses google maps places (autocomplete) API to find the State for a given ZIP.
The result is cached within the browser localStorage, thus limiting the usage of the API for repeat lookups.
** NOTE: This was built for (and locked down to) USA zip lookups, which was my need. The cache is already built for country based caches, however the lookup data parsing, and form fields population will need adjustment for other countries. MR's welcomed.
Peek.2022-08-27.10-10.mp4
- Hyva Theme for Magento >= 1.1.17 (Uses the SSR cart code)
- reqires changes as per MR: https://gitlab.hyva.io/hyva-themes/magento2-default-theme/-/merge_requests/503
Until these are accepted and become part of core Hyva, you will need to either patch, or extend the shipping.phtml template into your own theme with the changes.
- add
x-bind:data-code="region.code"to the region_id select element - add
<?= $this->getChildHtml(); ?>at the end of the template (allowing injection of custom blocks)
- composer config repositories.github.repo.repman.io composer https://github.repo.repman.io
- composer require proxiblue/module-state-lookup
- ./bin/magento setup:upgrade
- ./bin/magento setup:di:compile
NOTE: I use this module with ShipperHQ Address Autocomplete already installed, which already has a config value for the required google API key. Since I did not want multiple configs for the API key, this module shares the API key config value of that module.
There is no dependency on the shipperHQ module, this module will effect the same config setup in admin, if the shipperHQ module is not installed
- Once installed, go to Stores > Configuration > Sales > Shipping Settings
- Enter the Google API Key
Once install and activated, enter a Zip into the required field on cart Shipping lookup, and the State will be auto-filled