# mageworx/module-storelocator-graphql

`composer require mageworx/module-storelocator-graphql`

Canonical URL: https://packagento.com/mageworx/module-storelocator-graphql

## At a glance

- **Vendor**: mageworx (https://packagento.com/mageworx.md)
- **Latest version**: 1.0.0 — released 2026-03-23
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/mageworx/module-storelocator-graphql and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require mageworx/module-storelocator-graphql:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## README

GraphQL API for [Store Locator & In-Store Pickup](https://www.mageworx.com/magento-2-store-locator-and-pickup.html) for Magento 2.

### Requirements

| Package | Version |
|---------|---------|
| `mageworx/module-locations` | >= 1.8.5 |
| `mageworx/module-storelocator` | >= 1.7.4 |
| `mageworx/module-locationpages` | >= 1.3.4 |
| `mageworx/module-pickup` | >= 1.6.5 |
| Magento | 2.4.x (Open Source / Adobe Commerce) |

MSI (Multi-Source Inventory) is supported but not required.

### Installation

```bash
composer require mageworx/module-storelocator-graphql
bin/magento setup:upgrade
bin/magento cache:flush
```

Or copy the module to `app/code/MageWorx/StoreLocatorGraphQl/` and run `setup:upgrade`.

### Queries

#### Single location

Fetch by `id` or `code`:

```graphql
{
  mageworxLocation(code: "nyc-downtown") {
    entity_id
    name
    address
    city
    country_id
    latitude
    longitude
    is_pickup_available
    working_hours {
      is_open_now
      schedule { day from to is_day_off }
    }
    social { facebook instagram whatsapp }
    amenities { parking atm pharmacy }
    meta { meta_title meta_description }
  }
}
```

#### Search locations

Supports geo-radius search, text search, and filtering by country, region, city, or amenities:

```graphql
{
  mageworxLocations(
    filter: { latitude: 40.7, longitude: -74.0, radius: 50 }
    pageSize: 10
    currentPage: 1
  ) {
    items { name city distance }
    total_count
    page_info { current_page total_pages }
  }
}
```

Available amenity codes for filtering: `gas_station`, `atm`, `pharmacy`, `tire_center`, `food_court`,
`curbside_pickup`, `parking`, `amazon_returns`, `delivery_pickup`, `optical_department`.

#### Locations for a product

Returns locations carrying the product with MSI stock data when available:

```graphql
{
  mageworxLocationsByProduct(product_id: 42, pageSize: 5, currentPage: 1) {
    items {
      location { name city }
      in_stock
      qty
    }
    total_count
    page_info { current_page total_pages }
  }
}
```

#### Location count for a product

```graphql
{ mageworxLocationCountForProduct(product_id: 42) }
```

#### Location pages

Hierarchical location pages for SEO landing pages (country > region > city):

```graphql
{
  mageworxLocationPages(type: COUNTRY) {
    id
    name
    url
    type
    parent_id
  }
}
```

Use `parent_id` to drill down: `COUNTRY` -> `REGION` -> `CITY`.

### Mutations

#### Set pickup location

```graphql
mutation {
  setPickupLocationOnCart(input: { cart_id: "abc123", location_id: 1 }) {
    cart {
      mageworx_pickup_location { name address city }
    }
  }
}
```

#### Remove pickup location

```graphql
mutation {
  removePickupLocationFromCart(cart_id: "abc123") {
    cart { mageworx_pickup_location { name } }
  }
}
```

### Store Configuration

Store Locator settings are exposed via the standard `storeConfig` query:

```graphql
{
  storeConfig {
    mageworx_locations_show_on_product
    mageworx_locations_show_map
    mageworx_locations_radius_unit
    mageworx_locations_default_radius
    mageworx_locations_default_latitude
    mageworx_locations_default_longitude
    mageworx_locations_page_layout
    mageworx_locations_link_title
    mageworx_locations_link_url
    mageworx_pickup_active
    mageworx_locations_pickup_method_name
    mageworx_locations_pickup_price
    mageworx_locations_enable_working_hours
    mageworx_locations_pages_base_path
  }
}
```

See [README_DEV.md](README_DEV.md) for the full list of exposed config fields.

### License

Copyright (c) MageWorx. All rights reserved.
See [LICENSE.txt](LICENSE.txt) for license details.

## Recent Versions

| Version | Released |
|---|---|
| 1.0.0 | 2026-03-23 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/module-graph-ql | * |
| magento/module-quote-graph-ql | * |
| mageworx/module-locationpages | >= 1.3.4 |
| mageworx/module-locations | >= 1.8.5 |
| mageworx/module-pickup | >= 1.6.5 |
| mageworx/module-storelocator | >= 1.7.4 |

## Quality

Latest release (1.0.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | not tested | 1 |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 20 | 20 warnings (ruleset: Magento2) |
| PHPMD | Pass | 0 |  |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 7 | valid; 7 advisory notes (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Error | Error | – | – |
| 2.4.8 | – | Error | Error | – |
| 2.4.9 | – | – | Error | Error |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | N/A | 0 | no resolvable dependency tree to audit — Your requirements could not be resolved to an installable set of packages. Problem 1 |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["mageworx/module-storelocator-graphql"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

mageworx is a Magento 2 vendor on Packagento. See https://packagento.com/mageworx.md for their full catalogue.