https://github.com/aligent/magento-stockists-module
https://github.com/aligent/magento-stockists-module
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aligent/magento-stockists-module
- Owner: aligent
- License: gpl-3.0
- Created: 2021-03-23T08:04:06.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2026-01-29T00:51:48.000Z (5 months ago)
- Last Synced: 2026-01-29T16:14:42.405Z (5 months ago)
- Language: PHP
- Size: 243 KB
- Stars: 2
- Watchers: 14
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Aligent Stockists
This module is designed to allow vendors to add physical store information, including addresses and coordinates, and provides functionality for:
- Store lookup by latitide/longitude
- Store lookup by URL key (for individual store pages)
- Rich text descriptions using PageBuilder
## Installation
To install via composer, simply run:
```bash
composer require aligent/magento-stockists-module
```
## Configuration
Geocoding settings can be found under `Stores -> Configuration -> Aligent -> Stockists`.
By default, Google Maps API is the service used, but any URL can be specified.
## Viewing/Adding/Editing Stockists
This module adds a new "Stockists" menu, which gives the following options:
- All Stockists: View all current stockists in a grid
- Add Stockist: Go directly to the new stockist form
When adding a new stockist, you must enter the following:
- Is Active?
- Identifier
- Name
- URL Key
- Store IDs (choose 1 or more store views)
- Country
- State/Province (If the chosen country requires it)
- Postcode
Additional information such as telephone number, street address, and trading hours can also be added.
## GraphQL
Three GraphQL queries are provided:
- stockists
- Returns a list of stockists within a given radius, ordered by distance
- Must provide customer's latitude and longitude as input
- stockist
- Returns the information for a single stockist given an identifier or URL key
- searchStockistsByAddress
- Search stockists by address fields
## CSV Import
Allow import Stockists via CSV import. `System -> Import` then select the `Stockists` as entity type.