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 selected developer workspace. GET /api/developer/storefront/readiness focuses on that workspace brand website. GET /api/developer/products/{productId}/readiness inspects an owned product within the teammate assigned-product scope.
Use the current authenticated workspace context. Workspace readiness requires products.view and all-products scope; storefront readiness requires storefront.view and all-products scope. A teammate with products.view can inspect an assigned product through its single-product endpoint. Billing, settlement, email and partner details require their corresponding view permissions and are not queried when restricted.
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
SoundSync
Requests and responses
/api/developer/readiness
Inspect the selected developer workspace readiness
- Auth
- Account Bearer session token
- Scope
- products.view and all-products scope in the selected developer workspace; restricted billing, settlement, email and partner categories require their matching view permissions.
- Returns
- HTTP 200: scope, status, goLiveReady, completionPercent, developer_id, product_id, storefront_id, generated_at, blockers, warnings, categories, blockingCount, warningCount, requiredIncompleteCount, nextAction, nextActionCode, nextActionCategory, launchChecklist, categorySummary.
- Notes
- Diagnostic output, not publication or checkout activation. Read blockers, warnings, categories, evidence and action links; a percentage alone is not approval. Developer checks include billing, settlement and email configuration and can initialize/read settlement or sender state. Do not use these as a zero-write uptime probe, a provider-verification certificate or a promise of live native-host runtime verification. Workspace readiness requires products.view and all-products scope; storefront readiness requires storefront.view and all-products scope. Product readiness requires products.view, assignment and active-workspace ownership. Workspace billing, settlement, email and partner categories follow their existing view permissions and are not queried for unauthorized roles.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"scope": {
"enum": [
"developer",
"product",
"storefront"
]
},
"status": {
"type": "string"
},
"goLiveReady": {
"type": "boolean"
},
"completionPercent": {
"type": "number"
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"product_id": {
"type": "integer",
"minimum": 1
},
"storefront_id": {
"type": [
"integer",
"null"
]
},
"generated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"weight": {
"type": "number"
},
"completionPercent": {
"type": "number"
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"label": {
"type": "string"
},
"href": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"blockingCount": {
"type": "integer"
},
"warningCount": {
"type": "integer"
},
"requiredIncompleteCount": {
"type": "integer"
},
"nextAction": {
"type": [
"string",
"null"
]
},
"nextActionCode": {
"type": [
"string",
"null"
]
},
"nextActionCategory": {
"type": [
"string",
"null"
]
},
"launchChecklist": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"categorySummary": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/products/{productId}/readiness
Inspect one product readiness
- Auth
- Account Bearer session token
- Scope
- products.view, assigned-product scope and active-workspace product ownership.
- Returns
- HTTP 200: scope, status, goLiveReady, completionPercent, developer_id, product_id, storefront_id, generated_at, blockers, warnings, categories, blockingCount, warningCount, requiredIncompleteCount, nextAction, nextActionCode, nextActionCategory, launchChecklist, categorySummary.
- Notes
- Diagnostic output, not publication or checkout activation. Read blockers, warnings, categories, evidence and action links; a percentage alone is not approval. Developer checks include billing, settlement and email configuration and can initialize/read settlement or sender state. Do not use these as a zero-write uptime probe, a provider-verification certificate or a promise of live native-host runtime verification. Workspace readiness requires products.view and all-products scope; storefront readiness requires storefront.view and all-products scope. Product readiness requires products.view, assignment and active-workspace ownership. Workspace billing, settlement, email and partner categories follow their existing view permissions and are not queried for unauthorized roles.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"scope": {
"enum": [
"developer",
"product",
"storefront"
]
},
"status": {
"type": "string"
},
"goLiveReady": {
"type": "boolean"
},
"completionPercent": {
"type": "number"
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"product_id": {
"type": "integer",
"minimum": 1
},
"storefront_id": {
"type": [
"integer",
"null"
]
},
"generated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"weight": {
"type": "number"
},
"completionPercent": {
"type": "number"
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"label": {
"type": "string"
},
"href": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"blockingCount": {
"type": "integer"
},
"warningCount": {
"type": "integer"
},
"requiredIncompleteCount": {
"type": "integer"
},
"nextAction": {
"type": [
"string",
"null"
]
},
"nextActionCode": {
"type": [
"string",
"null"
]
},
"nextActionCategory": {
"type": [
"string",
"null"
]
},
"launchChecklist": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"categorySummary": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
/api/developer/storefront/readiness
Inspect the selected developer website readiness
- Auth
- Account Bearer session token
- Scope
- storefront.view and all-products scope in the selected developer workspace.
- Returns
- HTTP 200: scope, status, goLiveReady, completionPercent, developer_id, product_id, storefront_id, generated_at, blockers, warnings, categories, blockingCount, warningCount, requiredIncompleteCount, nextAction, nextActionCode, nextActionCategory, launchChecklist, categorySummary.
- Notes
- Diagnostic output, not publication or checkout activation. Read blockers, warnings, categories, evidence and action links; a percentage alone is not approval. Developer checks include billing, settlement and email configuration and can initialize/read settlement or sender state. Do not use these as a zero-write uptime probe, a provider-verification certificate or a promise of live native-host runtime verification. Workspace readiness requires products.view and all-products scope; storefront readiness requires storefront.view and all-products scope. Product readiness requires products.view, assignment and active-workspace ownership. Workspace billing, settlement, email and partner categories follow their existing view permissions and are not queried for unauthorized roles.
Request, response and error reference
No request body fields are read by this operation.
HTTP 200 response (application/json)
{
"type": "object",
"properties": {
"scope": {
"enum": [
"developer",
"product",
"storefront"
]
},
"status": {
"type": "string"
},
"goLiveReady": {
"type": "boolean"
},
"completionPercent": {
"type": "number"
},
"developer_id": {
"type": "integer",
"minimum": 1
},
"product_id": {
"type": "integer",
"minimum": 1
},
"storefront_id": {
"type": [
"integer",
"null"
]
},
"generated_at": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"categories": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"weight": {
"type": "number"
},
"completionPercent": {
"type": "number"
},
"blockers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"severity": {
"type": "string"
},
"category": {
"type": "string"
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"label": {
"type": "string"
},
"href": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": true
}
},
"evidence": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
},
"blockingCount": {
"type": "integer"
},
"warningCount": {
"type": "integer"
},
"requiredIncompleteCount": {
"type": "integer"
},
"nextAction": {
"type": [
"string",
"null"
]
},
"nextActionCode": {
"type": [
"string",
"null"
]
},
"nextActionCategory": {
"type": [
"string",
"null"
]
},
"launchChecklist": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"categorySummary": {
"type": "object",
"additionalProperties": true,
"description": "Operation-specific extension data; do not put credentials or unnecessary personal information here."
}
},
"additionalProperties": true
}
Documented failures: 400, 401, 403, 404, 409, 500, 503.
Read only the readiness details your role can view
Workspace readiness requires product-view permission and all-products scope. Storefront readiness requires storefront-view permission and all-products scope. Assigned-product teammates can use the single-product readiness endpoint for an owned, assigned product.
Billing, settlement, marketing-email and partner categories follow their existing view permissions. Restricted categories are omitted before their queries run. Readiness uses the selected workspace, not a teammate personal account, and does not enable checkout, payout or transfer execution.
