API Reference
Storefront API (Public)
Store & Menus

Store & Menus

Visibility

  • GET /storePublic
  • GET /store/menusPublic
  • GET /store/menus/{handle}Public

Authentication

All endpoints in this page require:

x-api-key: sk_eco_...

GET /store

Returns public store identity and storefront configuration.

Response Fields (core)

FieldTypeDescription
idstringStore UUID
namestringStore display name
slugstringStore slug
descriptionstring?Public description
logo_urlstring?Public logo URL
custom_domainstring?Connected custom domain
contact_infoobject?Email/phone/contact metadata
social_linksobject?Social profile links
theme_settingsobject?Theme configuration
settingsobject?Additional storefront settings

cURL

curl -X GET "https://api.ecommaps.com/api/v1/storefront/store" \
  -H "x-api-key: sk_eco_YOUR_KEY"

GET /store/menus

Returns all menu definitions available for the store.

Response Fields (menu)

FieldTypeDescription
idstringMenu UUID
titlestringMenu display title
handlestringStable menu key
itemsMenuItem[]Hierarchical menu items

MenuItem fields include: title, url, type, position, children.

GET /store/menus/{handle}

Returns one menu by handle. Use this for deterministic menu placement (for example main-menu, footer).

Error Matrix

StatusScenario
401Missing or invalid API key
404Menu handle not found
500Upstream datastore failure

SDK Example

import { ecommapsClient } from "@ecommaps/client";
 
const store = await ecommapsClient.store.retrieve();
const menus = await ecommapsClient.store.menus.list();
const mainMenu = await ecommapsClient.store.menus.retrieve("main-menu");