API reference
Embedded Storefront Content API
Read published pages, templates, support, products and bundle ownership previews.
Load published content for an allowed site
Pages, templates, product detail, support, reviews and bundles use /api/embed/storefront/{storeSlug}. The embed origin must be allowed and the storefront must be published. A rejected origin can record an installation check; these calls are not guaranteed zero-write health probes.
GET pages combines published stored pages with permitted generated defaults. An explicitly unpublished page stays hidden. Page/template endpoints return structured definitions and selections, not arbitrary rendered HTML. Use the existing bootstrap/config and frame-token workflow for embedding the experience.
Treat ownership pricing as a preview
A bundle price-check can use a customer library Bearer token. Valid identity enables the supported owned-product lookup; an invalid token is treated as unauthenticated. The response separates ownedItems, missingItems, discounts and checkout hints. Subscription plans return their recurring price rather than an existing-owner discount.
customer/ownership must include a bundle slug for validated ownership pricing. Without it the compatibility response only reports whether a token string was supplied; that boolean is not authentication. Never grant access from it. Checkout recalculates pricing and eligibility, including the $9.99 paid minimum; a preview is not a charge, entitlement or guaranteed accepted offer.
Use the supported customer login
The embedded auth/request-code and auth/verify-code handlers return 501 MAGIC_CODE_LOGIN_NOT_CONFIGURED. They are not available magic-code login APIs. Use the hosted customer account login and supported library-token flow. Keep tokens out of public links and logs.
The embed checkout compatibility handler returns 409 USE_PRODUCT_CHECKOUT_ENDPOINT. Use /api/checkout/product for server-calculated checkout. Client cart display and a coupon preview do not authorize payment or access.
Popups, verified rewards and account setup
Website Builder Popups supports newsletter invitations, product giveaways, signup rewards and promotional links independently of built-in page/footer forms. Reward products are optional. A verified eligible reward is granted before account-password setup; an existing account signs in rather than creating a second identity.
A popup reward is an access grant, not a paid order, invoice or recurring charge. Private verification and account-setup proofs expire after 48 hours. A completed old link cannot erase a later unsubscribe; fresh requested newsletter confirmation is separate from automatic purchase/signup enrollment and cannot bypass hard suppressions.
SoundSync
Integration references
SoundSync
Requests and responses
/api/embed/storefront/{storeSlug}/pages
List published pages and generated system defaults
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: storefront, pages.
- Notes
- Origin denial can record an installation-check event. Explicit unpublished stored pages remain hidden; a generated default does not bypass an explicit unpublished page.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"customDomain": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pageType": {
"type": "string"
},
"pageSlug": {
"type": "string"
},
"templateKey": {
"type": "string"
},
"status": {
"type": "string"
},
"selectedTemplate": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"availableTemplates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"publishingTargets": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"content": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/templates
Read page template selections and registry
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: storefront, registry, pages.
- Notes
- Origin denial can record an installation-check event.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"customDomain": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"registry": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"pages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pageType": {
"type": "string"
},
"pageSlug": {
"type": "string"
},
"templateKey": {
"type": "string"
},
"status": {
"type": "string"
},
"selectedTemplate": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"availableTemplates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"publishingTargets": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"content": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/pages/{pageType}
Read one published page definition
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: storefront, page.
- Notes
- Origin denial can record an installation-check event. Unsupported page types return 400; explicitly unpublished pages return 404. Page definitions are structured data, not arbitrary website HTML.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"customDomain": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"page": {
"type": "object",
"properties": {
"pageType": {
"type": "string"
},
"pageSlug": {
"type": "string"
},
"templateKey": {
"type": "string"
},
"status": {
"type": "string"
},
"selectedTemplate": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"availableTemplates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"publishingTargets": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"content": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/templates/{pageType}
Read one page template selection
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: storefront, pageType, pageSlug, templateKey, status, selectedTemplate, availableTemplates, publishingTargets, content.
- Notes
- Origin denial can record an installation-check event.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"customDomain": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
},
"pageType": {
"type": "string"
},
"pageSlug": {
"type": "string"
},
"templateKey": {
"type": "string"
},
"status": {
"type": "string"
},
"selectedTemplate": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"availableTemplates": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"publishingTargets": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"content": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/products/{productSlug}
Read public product detail and reviews
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: storefront, product, reviews.
- Notes
- Origin denial can record an installation-check event.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"product": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"shortDescription": {
"type": [
"string",
"null"
]
},
"price": {
"type": "number"
},
"salePrice": {
"type": [
"number",
"null"
]
},
"regularPrice": {
"type": "number"
},
"displayPrice": {
"type": "number"
},
"priceDisplay": {
"type": "string"
},
"regularPriceDisplay": {
"type": "string"
},
"salePriceDisplay": {
"type": [
"string",
"null"
]
},
"isOnSale": {
"type": "boolean"
},
"currency": {
"type": "string"
},
"imageUrl": {
"type": [
"string",
"null"
]
},
"coverImage": {
"type": [
"string",
"null"
]
},
"developerId": {
"type": "integer",
"minimum": 1
},
"developerName": {
"type": "string"
},
"developer": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "integer",
"minimum": 1
},
"name": {
"type": "string"
},
"slug": {
"type": [
"string",
"null"
]
},
"profileUrl": {
"type": [
"string",
"null"
]
},
"verified": {
"type": "boolean"
}
},
"additionalProperties": true
},
"productType": {
"type": "string"
},
"productTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"url": {
"type": "string"
},
"subscriptionEnabled": {
"type": "boolean"
},
"billingInterval": {
"type": [
"string",
"null"
]
},
"checkoutEligible": {
"type": "boolean"
},
"capabilities": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"requiresActivation": {
"type": "boolean"
},
"supportsSerials": {
"type": "boolean"
},
"supportsDownloads": {
"type": "boolean"
},
"marketplaceAsset": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
"reviews": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/support
Read published storefront support content
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: storefront, support, articles, aiAssistant, contactForm.
- Notes
- Origin denial can record an installation-check event.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"support": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"articles": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"aiAssistant": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"contactForm": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/reviews
Read published storefront reviews
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Request fields
- query limit: integer
- query page: integer
- query search: string
- query rating: string
- Returns
- HTTP 200: storefront, reviews, summary, eligibleProducts.
- Notes
- Origin denial can record an installation-check event. page selects the paginated reviews workflow; without page, summary describes the returned limited review set. This embed handler does not resolve a token into eligibleProducts. Use the authenticated review/account flow for posting; public reviews are not proof of every purchaser being verified.
Request, response and error reference
Query and header parameters
[
{
"name": "limit",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
},
{
"name": "search",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "rating",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
},
"reviews": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"summary": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"averageRating": {
"type": "number"
}
},
"additionalProperties": true
},
"eligibleProducts": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/bundles
List active bundle offers and published subscription plans
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: storefront, bundles.
- Notes
- Origin denial can record an installation-check event.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"properties": {
"slug": {
"type": "string"
}
},
"additionalProperties": true
},
"bundles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"offerType": {
"type": "string"
},
"status": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"productIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"subscriptionProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checkoutBacked": {
"type": "boolean"
},
"recurringAmountCents": {
"type": "integer"
},
"currency": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/bundles/{bundleSlug}
Read an active storefront bundle
- Auth
- Allowed embed origin/domain; see the frame and operation notes
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: storefront, bundle.
- Notes
- Origin denial can record an installation-check event.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"properties": {
"slug": {
"type": "string"
}
},
"additionalProperties": true
},
"bundle": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"offerType": {
"type": "string"
},
"status": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"productIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"subscriptionProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checkoutBacked": {
"type": "boolean"
},
"recurringAmountCents": {
"type": "integer"
},
"currency": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/bundles/{bundleSlug}/price-check
Preview bundle ownership pricing
- Auth
- Optional authentication OR Customer library/download token
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Returns
- HTTP 200: bundle, customerAuthenticated, fullPriceCents, ownedValueCents, missingSubtotalCents, eligibleDiscountCents, upgradePriceCents, finalCheckoutTotalCents, currency, ownedItems, missingItems, checkout.
- Notes
- Origin denial can record an installation-check event. Optional Bearer library token is resolved by the server; invalid/expired tokens are treated as unauthenticated. Prefer the header, not URL query tokens. This is a price/ownership preview, not a charge or new entitlement. Checkout recalculates final eligibility/pricing. Subscription plans return recurring price with no existing-owner discount.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"bundle": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"offerType": {
"type": "string"
},
"status": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"productIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"subscriptionProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checkoutBacked": {
"type": "boolean"
},
"recurringAmountCents": {
"type": "integer"
},
"currency": {
"type": "string"
}
},
"additionalProperties": true
},
"customerAuthenticated": {
"type": "boolean"
},
"fullPriceCents": {
"type": "integer"
},
"ownedValueCents": {
"type": "integer"
},
"missingSubtotalCents": {
"type": "integer"
},
"eligibleDiscountCents": {
"type": "integer"
},
"upgradePriceCents": {
"type": "integer"
},
"finalCheckoutTotalCents": {
"type": "integer"
},
"currency": {
"type": "string"
},
"ownedItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"missingItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checkout": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 403, 404, 500.
/api/embed/storefront/{storeSlug}/customer/ownership
Preview bundle ownership for a customer
- Auth
- Optional authentication OR Customer library/download token
- Scope
- Published storefront and allowed embed origin; origin checks are not customer authentication.
- Request fields
- query bundle: string
- query bundleSlug: string
- query bundle_slug: string
- Returns
- HTTP 200: review the response schema below.
- Notes
- Origin denial can record an installation-check event. Optional Bearer library token is resolved by the server; invalid/expired tokens are treated as unauthenticated. Prefer the header, not URL query tokens. This is a price/ownership preview, not a charge or new entitlement. Checkout recalculates final eligibility/pricing. Subscription plans return recurring price with no existing-owner discount. Without a bundle slug, customerAuthenticated only indicates token presence, not validated identity; ownedItems/missingItems are empty. Never grant access based on that presence flag.
Request, response and error reference
Query and header parameters
[
{
"name": "bundle",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "bundleSlug",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
},
{
"name": "bundle_slug",
"in": "query",
"schema": {
"type": "string"
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"anyOf": [
{
"type": "object",
"properties": {
"bundle": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"offerType": {
"type": "string"
},
"status": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"productIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"subscriptionProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checkoutBacked": {
"type": "boolean"
},
"recurringAmountCents": {
"type": "integer"
},
"currency": {
"type": "string"
}
},
"additionalProperties": true
},
"customerAuthenticated": {
"type": "boolean"
},
"fullPriceCents": {
"type": "integer"
},
"ownedValueCents": {
"type": "integer"
},
"missingSubtotalCents": {
"type": "integer"
},
"eligibleDiscountCents": {
"type": "integer"
},
"upgradePriceCents": {
"type": "integer"
},
"finalCheckoutTotalCents": {
"type": "integer"
},
"currency": {
"type": "string"
},
"ownedItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"missingItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checkout": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
},
{
"type": "object",
"properties": {
"customerAuthenticated": {
"type": "boolean"
},
"ownedItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"missingItems": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"message": {
"type": "string"
}
},
"additionalProperties": true
}
]
}
Documented failures: 400, 403, 404, 500.
/api/storefronts/{slug}/bundles
List public hosted bundle offers
- Auth
- Public request; operation-specific verification still applies
- Scope
- Published storefront and public offer visibility.
- Returns
- HTTP 200: storefront, bundles.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"properties": {
"slug": {
"type": "string"
}
},
"additionalProperties": true
},
"bundles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"offerType": {
"type": "string"
},
"status": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"productIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"subscriptionProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checkoutBacked": {
"type": "boolean"
},
"recurringAmountCents": {
"type": "integer"
},
"currency": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
Documented failures: 400, 404, 500.
/api/storefronts/{slug}/bundles/{bundleSlug}
Read a hosted bundle offer
- Auth
- Public request; operation-specific verification still applies
- Scope
- Published storefront and public offer visibility.
- Returns
- HTTP 200: storefront, bundle.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"storefront": {
"type": "object",
"properties": {
"slug": {
"type": "string"
}
},
"additionalProperties": true
},
"bundle": {
"type": "object",
"properties": {
"kind": {
"type": "string"
},
"id": {
"type": "integer",
"minimum": 1
},
"slug": {
"type": "string"
},
"name": {
"type": "string"
},
"title": {
"type": "string"
},
"offerType": {
"type": "string"
},
"status": {
"type": "string"
},
"discountType": {
"type": "string"
},
"discountValue": {
"type": "number"
},
"productIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"subscriptionProductIds": {
"type": "array",
"items": {
"type": "integer",
"minimum": 1
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"checkoutBacked": {
"type": "boolean"
},
"recurringAmountCents": {
"type": "integer"
},
"currency": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
Documented failures: 400, 404, 500.
/api/storefronts/{slug}/products/{productSlug}/reviews
Read paginated reviews of included bundle products
- Auth
- Public request; operation-specific verification still applies
- Scope
- Public published bundle with visible included products.
- Request fields
- query page: integer
- Returns
- HTTP 200: reviews, summary, pagination, endpoint.
- Notes
- Bundle-only aggregate of published reviews for visible included products. A non-bundle without bundleReviews returns 404. The server clamps the requested page. verified reflects the stored entitlement association, not an independent endorsement or universal verification guarantee.
Request, response and error reference
Query and header parameters
[
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"minimum": 1
},
"required": false,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"reviews": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
]
},
"productId": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "string",
"pattern": "^[1-9][0-9]*$"
}
]
},
"productName": {
"type": "string"
},
"rating": {
"type": "number"
},
"title": {
"type": "string"
},
"body": {
"type": "string"
},
"customerName": {
"type": "string"
},
"verified": {
"type": "boolean"
},
"createdAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"additionalProperties": true
}
},
"summary": {
"type": "object",
"properties": {
"count": {
"type": "integer"
},
"averageRating": {
"type": "number"
}
},
"additionalProperties": true
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer"
},
"pageSize": {
"type": "integer"
},
"total": {
"type": "integer"
},
"totalPages": {
"type": "integer"
}
},
"additionalProperties": true
},
"endpoint": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 404, 500.
/api/storefronts/{slug}/newsletter
Request confirmation from the built-in page or footer newsletter form
- Auth
- Public request; operation-specific verification still applies
- Scope
- Public published storefront; developer ownership is resolved from the slug.
- Request fields
- email: string (required)
- firstName: string
- Returns
- HTTP 201: subscribed, pending, alreadySubscribed, verificationRequired, emailSent, contactId.
- Notes
- Built-in page/footer forms retain their existing fields, copy, submission and confirmation behavior. Popup campaigns use the separate claim endpoint. Pending contacts are not subscribed until confirmation. emailSent means provider acceptance, not inbox delivery. This endpoint does not restore an unsubscribed contact. Existing email_footer consent-source compatibility is retained. 503 preserves input for retry.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email"
},
"firstName": {
"type": "string"
}
},
"required": [
"email"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"subscribed": {
"type": "boolean"
},
"pending": {
"type": "boolean"
},
"alreadySubscribed": {
"type": "boolean"
},
"verificationRequired": {
"type": "boolean"
},
"emailSent": {
"type": "boolean"
},
"contactId": {
"type": [
"integer",
"string",
"null"
]
}
},
"additionalProperties": true
}
Documented failures: 400, 404, 500, 503.
/api/storefronts/{slug}/newsletter/status
Suppress invitations for the current authenticated newsletter identity
- Auth
- Public request; operation-specific verification still applies
- Scope
- Optional authenticated customer/library Bearer identity; no arbitrary customer lookup.
- Returns
- HTTP 200: suppress.
- Notes
- Returns only suppress:boolean, with Cache-Control:no-store. No/invalid identity returns suppress:false. Email, customer IDs and query tokens are ignored. Suppresses confirmed, recently accepted pending, and blocked identities for this developer; does not change consent or reveal contact data.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"suppress": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 404, 500.
/api/storefronts/{slug}/newsletter/verify
Confirm a newsletter subscription using the private link
- Auth
- Public request; operation-specific verification still applies
- Scope
- Private newsletter verification token; no account session required.
- Request fields
- query token: string (required)
- Returns
- HTTP 200: text/html.
- Notes
- Retains the existing built-in newsletter confirmation behavior. Do not poll, health-check, log or share this URL. Returns HTML success/error, not a customer session. This confirmation is distinct from purchase-related audience enrollment and does not override suppressions. Popup verification and resubscription use the separate popup endpoint.
Request, response and error reference
Query and header parameters
[
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"required": true,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (text/html)
{
"type": "string"
}
Documented failures: 400, 410.
/api/storefronts/{slug}/popups/{popupId}/claim
Request verification for a newsletter or automatic reward popup
- Auth
- Public request; operation-specific verification still applies
- Scope
- Public published, enabled campaign with an active date window.
- Request fields
- email: string (required)
- firstName: string
- lastName: string
- newsletterOptIn: boolean
- Returns
- HTTP 201: pending, verificationRequired, emailSent, reusedConfirmation.
- Notes
- Only published campaign fields/rewards are honored. No customer login account or reward is created before email verification. Promotional announcement popups do not collect email and cannot be claimed. Newsletter enrollment for reward popups is optional, explicitly checked, and never implied by reward collection. Six recipient and 60 IP/storefront popup requests per 15 minutes are allowed. Provider acceptance is not proof of delivery. Responses do not reveal existing accounts or rewards.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"email": {
"type": "string",
"format": "email",
"maxLength": 320
},
"firstName": {
"type": "string",
"maxLength": 90
},
"lastName": {
"type": "string",
"maxLength": 90
},
"newsletterOptIn": {
"type": "boolean"
}
},
"required": [
"email"
],
"additionalProperties": true
}
HTTP 201 response (application/json)
{
"type": "object",
"properties": {
"pending": {
"type": "boolean"
},
"verificationRequired": {
"type": "boolean"
},
"emailSent": {
"type": "boolean"
},
"reusedConfirmation": {
"type": "boolean"
}
},
"additionalProperties": true
}
Documented failures: 400, 404, 409, 429, 503.
/api/storefronts/{slug}/popups/verify
Verify email, award once, then offer account setup
- Auth
- Public request; operation-specific verification still applies
- Scope
- Private verification link scoped to a popup claim and storefront.
- Request fields
- query token: string (required)
- Returns
- HTTP 200: text/html.
- Notes
- 48-hour links award a canonical product entitlement/serial or customer-bound coupon using a Purchase Reward template, without requiring a purchase or creating a users login account. Replays do not duplicate rewards or renew later-unsubscribed consent. Account setup follows the award; existing customers sign in. Changed/unavailable rewards, store closures and disabled customers are rejected. No automatic login is issued. Treat tokens as private credentials: do not poll, log or share them.
Request, response and error reference
Query and header parameters
[
{
"name": "token",
"in": "query",
"schema": {
"type": "string"
},
"required": true,
"description": ""
}
]
No request body fields are read by this operation.
HTTP 200 response (text/html)
{
"type": "string"
}
Documented failures: 400, 403, 404, 409, 410, 503.
/api/storefronts/{slug}/popups/setup
Read verified reward identity for account setup
- Auth
- Public request; operation-specific verification still applies
- Scope
- Unexpired, verified claim token for this storefront.
- Request fields
- token: string (required)
- Returns
- HTTP 200: email, firstName, lastName.
- Notes
- Returns only the verified claim identity for prefilling account setup, with no-store caching. Does not create an account or login session. Customer registration may submit popupClaimToken with the same email and storefrontSlug; valid proof avoids a second verification email after the user explicitly supplies account details/password. Pending, expired, consumed, different-email and different-store proofs cannot verify registration. Existing accounts are never overwritten.
Request, response and error reference
Request (application/json)
{
"type": "object",
"properties": {
"token": {
"type": "string"
}
},
"required": [
"token"
],
"additionalProperties": true
}
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
}
},
"additionalProperties": true
}
Documented failures: 400, 429, 503.
Free popup product rewards count as external redemptions
Each newly granted free product from a verified storefront popup counts toward the developer allowance of 10,000 external redemptions per month. Usage above the allowance is $0.005 per external redemption. A repeated confirmation or an already-owned product does not create another count, and issuing a coupon alone is not a product redemption.
For a supported bundle reward, newly granted included products are counted individually. Usage is recorded with fulfillment, not when the popup is displayed, the email is requested or account setup is completed. A gift included in a paid SoundSync BOGO checkout remains included in that paid checkout without an external-redemption charge. This update does not retroactively bill earlier popup rewards.
