API

The public Store Locator API provides the location data used by the Stencil widget. Use it for a custom storefront or integration that needs the same enabled locations.

Public endpoint

The endpoint is intentionally unauthenticated for storefront use. Do not put private information in location fields, and validate or sanitise rich-text notes before rendering them.

Get locations

Send a GET request to:

https://storelocator.space48apps.com/store-locator/{storeHash}/{channelId}/{groupId}

The storelocator.space48apps.com hostname is a legacy technical service endpoint retained by the current implementation. It is not a support or marketing URL.

Path parameters

Parameter	Required	Description
storeHash	Yes	BigCommerce store hash.
channelId	Yes	Numeric BigCommerce channel ID, often 1 for the original storefront.
groupId	No	Numeric Store Locator group ID. When supplied, only locations in that group are returned.

Omit the final path segment when you do not need a group filter. See Filter locations by group for how groups are managed.

Response

The response envelope contains:

Field	Type	Description
data	object	The main payload of the response.
meta	array	Reserved for response metadata. Currently empty.

The data object contains:

Field	Type	Description
active	boolean	Whether the store's Store Locator subscription is active.
locations	array of Location objects	Enabled locations assigned to the requested channel and, when supplied, group. The array is sorted by name.
allTags	array of strings	Distinct tags in use by the store.

Location object

Field	Type	Description
id	integer	Unique identifier for the location.
enabled	boolean	Whether the location is enabled. Returned locations are enabled for the requested channel.
channels	array of integers	Channel IDs where this location appears.
name	string	Name of the location.
address	string	Full address, line-separated.
postcode	string or null	Postal code of the location.
country_id	integer or null	Internal BigCommerce country ID.
country_name	string or null	Full country name.
country_iso	string or null	Two-letter country code, such as GB or US.
latitude	number or null	Latitude coordinate.
longitude	number or null	Longitude coordinate.
phone	string or null	Contact phone number.
email	string or null	Contact email address.
url	string or null	Website URL.
opening_times	object	Object keyed by capitalised weekday names, or an empty object.
images	array of strings	Zero or one absolute image URL.
tags	array of strings	Tag names assigned to the location.
map_pin_color	string or null	Custom pin color (e.g., hex code).
map_pin_image_url	string or null	Absolute URL for a custom pin image.
is_pinned	boolean	Whether this location is featured/pinned.
groups	array of integers	Store Locator group IDs assigned to the location.
notes	string (HTML) or null	Optional rich-text notes for the location.

Opening-times object

Each weekday value contains:

Field	Type	Description
from	string	Opening time in HH:MM format.
to	string	Closing time in HH:MM format.
closed	boolean	Whether the location is closed on this day.
openTwentyFourHours	boolean	Whether the location is open 24 hours.