API

Your locations are available via API. By default, it powers the Store Locator widget on Stencil storefronts.

Get All Locations

We provide a single endpoint to fetch all locations.

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

Store Hash (required)
- The BigCommerce Store Hash
Channel ID (required)
- The ID of the BigCommerce Channel, e.g. 1.
Group ID (optional)
- The ID of the location group, useful for filtering locations for specific store locator widgets.

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

Field	Type	Description
`active`	boolean	Indicates if the data feed is active.
`locations`	array of `Location` objects	List of available locations.
`allTags`	array of strings	All distinct tags used across locations.

Field	Type	Description
`id`	integer	Unique identifier for the location.
`enabled`	boolean	Whether the location is currently enabled.
`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	Internal country ID.
`country_name`	string	Full name of the country.
`country_iso`	string	ISO country code (e.g., "GB", "US").
`latitude`	number	Latitude coordinate.
`longitude`	number	Longitude coordinate.
`phone`	string	Contact phone number.
`email`	string or null	Contact email address.
`url`	string or null	Website URL.
`opening_times`	object	Object keyed by weekday names.
`images`	array of strings	List of image URLs.
`tags`	array of strings	Tags assigned to the location.
`map_pin_color`	string or null	Custom pin color (e.g., hex code).
`map_pin_image_url`	string or null	Custom pin image URL.
`is_pinned`	boolean	Whether this location is featured/pinned.
`groups`	array of integers	IDs of groups this location belongs to.
`notes`	string (HTML) or null	Optional rich-text notes for the location.

Each key under opening_times corresponds to a weekday (e.g., Monday , Tuesday , etc.):

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.