Locally
Connect your products to local retailers and show nearby product availability
Overview
The Locally plugin connects your CMS Max website to Locally, a platform that helps customers find your products at nearby retail locations. When configured, visitors can see which local stores carry your products and check availability.
Setup
- Navigate to Settings > Plugins
- Find Locally and click to open the settings page
- Click Save and Install
Entering Your Credentials
- Log in to your Locally dashboard
- Copy your API Key and Report ID
- Paste them into the corresponding fields in the plugin settings
- Click Get Split ID to automatically retrieve your Split ID (requires the API Key and Report ID to be entered first)
- Click Save
Configuration
| Field | Required | Description |
|---|---|---|
| API Key | Yes | Your Locally API key from the Locally dashboard |
| Report ID | Yes | The report identifier from your Locally account |
| Split ID | Yes | Retrieved automatically using the Get Split ID button, or entered manually |
| Product Name Format | No | Customize how product names appear in Locally (e.g., {brand_name} - {name}) |
| Display Locally widget on product page | No | Toggle to show a store locator widget on individual product pages |
Product Page Widget
When you enable Display Locally widget on product page, two additional fields appear:
| Field | Required | Description |
|---|---|---|
| Company ID | Yes (when widget enabled) | Your Locally Company ID |
| Base Address | Yes (when widget enabled) | The base URL for your Locally integration (e.g., yourcompany.locally.com) |
Product Name Format
You can customize how your product names appear in Locally using placeholders:
{brand_name}— replaced with the product's brand name{name}— replaced with the product name
For example, {brand_name} - {name} would display as "Acme - Widget Pro".