Skip to content
SoundSyncAudio software platform

API reference

Readiness API

Read setup blockers, warnings and next actions for accounts, products and storefronts.

Use readiness as a checklist

GET /api/developer/readiness summarizes the signed-in developer account. GET /api/developer/storefront/readiness focuses on its brand website. GET /api/developer/products/{productId}/readiness inspects a product for its actual owner or a platform administrator.

These handlers use the signed-in account identity, not an arbitrary effective workspace owner. A team invitation or selected-product assignment does not make a teammate the product owner. A product check can return FORBIDDEN even when another product-management endpoint permits that teammate.

Read the reasons, not only the score

The response includes scope, status, goLiveReady, completionPercent, generated_at, categories, blockers and warnings, plus derived checklist/next-action information. Each category includes its status, weight, evidence and suggested actions. Common areas include product/delivery setup, Brand Manager and Website Builder, marketplace placement, billing, settlements, commerce and email readiness.

A ready response is not publication, provider activation, a guaranteed live checkout, or a native plugin runtime certification. Warnings can concern optional marketplace participation. Review the individual category and product capabilities rather than treating every warning as a universal launch requirement.

Do not poll these as a zero-write health check

Some diagnostic paths can initialize or refresh supporting settlement/sender records. They are private account diagnostics, not a public uptime probe. Do not publish raw evidence, account configuration or private product results. For provider readiness, use the relevant setup workflow and confirm its current state.

SoundSync

Follow the next action

Getting started

Product and storefront setup sequence.

Domain Setup API

DNS records and verification.

Billing and Settlements API

Saved payout status and setup restrictions.

SoundSync

Requests and responses

GET /api/developer/readiness

Inspect the signed-in developer account readiness

Auth
Account Bearer JWT
Scope
Signed-in account identity, not the selected effective workspace owner.
GET /api/developer/products/{productId}/readiness

Inspect one product readiness

Auth
Account Bearer JWT
Scope
Actual product owner or platform admin; a selected-product team assignment is not sufficient.
GET /api/developer/storefront/readiness

Inspect the signed-in developer website readiness

Auth
Account Bearer JWT
Scope
Signed-in account identity, not the selected effective workspace owner.