Skip to content
SoundSyncAudio software platform

API Reference

Storefront and Embedded Storefront API

Verified hosted storefront endpoints, embedded storefront bootstrap/frame-token routes, runtime attributes, cart behavior, and checkout handoff.

Start with getting startedExplore API docs
POST /activateGET /validatePOST /deactivate
Product credentials
Activation request
Entitlement check
Device registration
Periodic validation
Deactivation when needed
Live Moonwave FX storefront product catalog showing search, featured product, product media, subscription pricing, and product detail links.

SoundSync

Verified storefront/embed endpoints

These routes are backed by storefrontRoutes.js and embedStorefrontRoutes.js.

GET /api/storefronts/:slug

Fetch hosted public storefront brand/configuration by slug.

Auth
Public storefront request.
Scope
Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields
  • store slug
Returns
Public storefront payload.
Side effects
None for GET endpoints unless noted.
GET /api/storefronts/:slug/products

List public products in a hosted storefront.

Auth
Public storefront request.
Scope
Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields
  • store slug
  • optional filters/query
Returns
Public products/catalog payload.
Side effects
None for GET endpoints unless noted.
GET /api/storefronts/:slug/products/:productSlug

Fetch a public storefront product detail.

Auth
Public storefront request.
Scope
Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields
  • store slug
  • product slug
Returns
Public product detail payload.
Side effects
None for GET endpoints unless noted.
GET /api/embed/storefront/:storeSlug/bootstrap

Fetch the embedded storefront bootstrap payload.

Auth
Public embed request from an allowed origin/domain.
Scope
Store slug, allowed parent origin, page, and product scope.
Request fields
  • store slug
  • page/pageType optional
  • product/productSlug optional
  • allowed embed origin
Returns
Storefront, pages, products, bundles, active page, reviews/support when requested, and embed metadata.
Side effects
None for GET endpoints unless noted.
Notes
Unauthorized embed domains return EMBED_DOMAIN_NOT_ALLOWED.
POST /api/embed/storefront/:storeSlug/frame-token

Issue a short-lived frame token for iframe storefront package loading.

Auth
Allowed embed origin/domain.
Scope
Store slug, parent origin, instance id, frame route, storefront mode.
Request fields
  • parentOrigin required
  • instanceId required
Returns
frameToken, expiresInSeconds 600, frameUrl, embed metadata.
Side effects
None for GET endpoints unless noted.
GET /api/embed/storefront/:storeSlug/frame-config

Validate a frame token and return iframe protocol metadata.

Auth
Frame token issued by /frame-token.
Scope
Store slug, parent origin, instance, frame route.
Request fields
  • frameToken/frame_token query
  • parentOrigin/headers
Returns
ok, storeSlug, parentOrigin, instanceId, mode, protocol soundsync-storefront-embed, version 1.
Side effects
None for GET endpoints unless noted.
POST /api/embed/storefront/:storeSlug/checkout

Compatibility response for embed checkout attempts.

Auth
Allowed embed origin/domain.
Scope
Public, customer-token, developer-user, or scoped partner API surface as noted.
Request fields
  • cart/body context
Returns
409 USE_PRODUCT_CHECKOUT_ENDPOINT with checkoutEndpoint /api/checkout/product.
Side effects
None; checkout is intentionally delegated to /api/checkout/product.

SoundSync

Runtime attributes

The canonical snippet uses only attributes verified in public/embed/storefront.js.

AttributeBehavior
data-storeRequired store slug used by the runtime to select the storefront.
data-start-pageOptional initial page; catalog is the default.
data-shellcontent or full. Full shell can hide host chrome in viewport takeover mode.
data-store-navauto or explicit embedded navigation mode.
data-widthfull or contained. The runtime mirrors this to data-soundsync-width.
data-base-pathOptional client-side route base path, defaulting to /store/.
data-templateLegacy override only. The runtime warns and ignores it because templates come from Website Builder.

SoundSync

Canonical embed snippet

This snippet contains no credentials. Product and checkout data is fetched through public storefront/embed endpoints.

HTML 
<script async src="https://www.soundsyncsolutions.biz/storefront.js" data-api-base="https://api.soundsync.example"></script>
<div
  data-soundsync-storefront
  data-store="demo-audio-labs"
  data-start-page="catalog"
  data-shell="content"
  data-store-nav="auto"
  data-width="full"
  data-base-path="/store/">
</div>

Checkout handoff

Embedded cart endpoints accept client display state, but checkout recalculates server-side through /api/checkout/product. /api/embed/storefront/:storeSlug/checkout intentionally returns USE_PRODUCT_CHECKOUT_ENDPOINT.

API reference

Endpoint groups are organized by authentication model, product scope, request shape, response shape, errors, idempotency, and integration surface.

GET/POST

Storefront and Embed API

/docs/api/storefront-embed

Hosted storefront and embedded storefront bootstrap/frame-token/cart handoff.