curl --request GET \
--url https://api.interchange.io/api/v2/storefront/readiness \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/storefront/readiness"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/storefront/readiness', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"platformId": "<string>",
"isPaused": true,
"canTransact": true,
"checks": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"isBlocker": true,
"method": "<string>",
"details": "<string>",
"actionLabel": "<string>",
"actionUrl": "<string>",
"actionValue": "<string>",
"compliance": [
{
"agentId": "<string>",
"agentUrl": "<string>",
"passed": true,
"tracks": [
{
"track": "<string>",
"label": "<string>",
"durationMs": 123,
"failureReason": "<string>"
}
],
"summary": "<string>",
"observations": [
{
"category": "<string>",
"message": "<string>"
}
],
"durationMs": 123,
"error": "<string>"
}
],
"appliedDefault": "<string>",
"guidance": {
"stage": "before_source_dispatch",
"why": "<string>",
"effect": "<string>",
"fix": "<string>",
"subjects": [
{
"kind": "inventory_source",
"id": "<string>",
"name": "<string>"
}
],
"evidence": {
"kind": "billing_compatibility",
"requiredSupportedBilling": "agent",
"incompatibleSources": [
{
"sourceId": "<string>",
"sourceName": "<string>",
"advertisedSupportedBillings": [
"<string>"
]
}
]
}
}
}
],
"publisherDomains": [
{
"publisherDomain": "<string>",
"resolvedPropertyCount": 4503599627370495,
"lastSyncedAt": "<string>",
"lastPushedAt": "<string>"
}
],
"demandCoverage": {
"eligibleCombinations": 4503599627370495,
"coveredCombinations": 4503599627370495,
"categories": [
"<string>"
],
"markets": [
"<string>"
],
"channels": [
"<string>"
],
"missingDimensions": [],
"sampleBriefs": [
{
"category": "<string>",
"market": "<string>",
"channel": "<string>",
"rationale": "<string>"
}
]
},
"sourceDiagnostics": [
{
"id": "<string>",
"sourceId": "<string>",
"name": "<string>",
"cardPosture": {
"state": "connected",
"reasonCode": "connected",
"explanation": "<string>"
},
"agentId": "<string>",
"endpointUrl": "<string>",
"auth": {
"required": true,
"configured": true,
"type": "<string>"
},
"capabilities": {},
"productBuilder": {
"wholesaleProductCount": 123,
"buyerVisibleProductCount": 123,
"currencyMismatchProductCount": 123,
"reportingStaleProductCount": 123,
"signalCount": 123,
"catalogCacheCold": true,
"declaredUnsupportedIngredients": true
},
"compliance": {
"passed": true,
"summary": "<string>",
"checkedAt": "<string>",
"trackCounts": {
"total": 123,
"passing": 123,
"partial": 123,
"failing": 123
}
},
"debug": {
"version": "<string>",
"syntheticCapabilities": true,
"tools": [
"<string>"
],
"supportedBillings": [
"<string>"
],
"channels": [
"<string>"
],
"countries": [
"<string>"
],
"publisherDomains": [
"<string>"
],
"requireOperatorAuth": true
},
"lastActivity": {
"action": "<string>",
"resourceType": "<string>",
"resourceId": "<string>",
"resourceName": "<string>",
"description": "<string>",
"timestamp": "<string>"
},
"health": {
"lastError": "<string>",
"lastErrorCode": "<string>",
"lastErrorAt": "<string>",
"lastSuccessAt": "<string>",
"lastCheckedAt": "<string>"
},
"capabilityHealth": {
"inventory": {
"observations": [
{
"observer": "<string>",
"cause": "<string>",
"detail": "<string>",
"owner": "<string>",
"observedAt": "<string>",
"lastOkAt": "<string>"
}
]
},
"reporting": {
"observations": [
{
"observer": "<string>",
"cause": "<string>",
"detail": "<string>",
"owner": "<string>",
"observedAt": "<string>",
"lastOkAt": "<string>"
}
]
}
},
"detailAction": {
"operation": "list_ad_server_sources",
"arguments": {
"esaId": "<string>"
}
},
"catalogMappingReadiness": {
"progress": {
"ready": 4503599627370495,
"applicable": 4503599627370495,
"percent": 50
},
"nextAction": {
"operation": "open_modular_avails_commit",
"arguments": {
"sourceId": "<string>"
}
}
}
}
],
"diagnoses": [
{
"diagnosisId": "<string>",
"sourceId": "<string>",
"sourceName": "<string>",
"summary": "<string>",
"detail": "<string>",
"action": {
"kind": "recheck",
"label": "<string>",
"operation": "refresh_esa",
"pathParams": {
"esaId": "<string>"
},
"method": "POST",
"path": "<string>"
},
"docsAnchor": "<string>",
"observedAt": "<string>"
}
],
"availabilityGuidance": {
"stage": "before_source_dispatch",
"why": "<string>",
"effect": "<string>",
"fix": "<string>",
"subjects": [
{
"kind": "inventory_source",
"id": "<string>",
"name": "<string>"
}
],
"evidence": {
"kind": "billing_compatibility",
"requiredSupportedBilling": "agent",
"incompatibleSources": [
{
"sourceId": "<string>",
"sourceName": "<string>",
"advertisedSupportedBillings": [
"<string>"
]
}
]
}
},
"onboardingPlan": {
"version": 0,
"target": [
{
"value": "<string>",
"sourceRef": "<string>",
"confidence": 0.5,
"evidenceRefs": [
"<string>"
]
}
],
"steps": {},
"phaseTransitions": [
{
"at": "<string>"
}
],
"lastUpdatedBy": "<string>",
"lastUpdatedAt": "<string>"
},
"liveness": {
"reason": "<string>",
"remainingSteps": 4503599627370495,
"actionPath": "<string>"
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Get storefront readiness
Check if the storefront is ready to go live. Returns blocking checks for inventory sources, agent status, and agent auth.
curl --request GET \
--url https://api.interchange.io/api/v2/storefront/readiness \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.interchange.io/api/v2/storefront/readiness"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.interchange.io/api/v2/storefront/readiness', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"platformId": "<string>",
"isPaused": true,
"canTransact": true,
"checks": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"category": "<string>",
"isBlocker": true,
"method": "<string>",
"details": "<string>",
"actionLabel": "<string>",
"actionUrl": "<string>",
"actionValue": "<string>",
"compliance": [
{
"agentId": "<string>",
"agentUrl": "<string>",
"passed": true,
"tracks": [
{
"track": "<string>",
"label": "<string>",
"durationMs": 123,
"failureReason": "<string>"
}
],
"summary": "<string>",
"observations": [
{
"category": "<string>",
"message": "<string>"
}
],
"durationMs": 123,
"error": "<string>"
}
],
"appliedDefault": "<string>",
"guidance": {
"stage": "before_source_dispatch",
"why": "<string>",
"effect": "<string>",
"fix": "<string>",
"subjects": [
{
"kind": "inventory_source",
"id": "<string>",
"name": "<string>"
}
],
"evidence": {
"kind": "billing_compatibility",
"requiredSupportedBilling": "agent",
"incompatibleSources": [
{
"sourceId": "<string>",
"sourceName": "<string>",
"advertisedSupportedBillings": [
"<string>"
]
}
]
}
}
}
],
"publisherDomains": [
{
"publisherDomain": "<string>",
"resolvedPropertyCount": 4503599627370495,
"lastSyncedAt": "<string>",
"lastPushedAt": "<string>"
}
],
"demandCoverage": {
"eligibleCombinations": 4503599627370495,
"coveredCombinations": 4503599627370495,
"categories": [
"<string>"
],
"markets": [
"<string>"
],
"channels": [
"<string>"
],
"missingDimensions": [],
"sampleBriefs": [
{
"category": "<string>",
"market": "<string>",
"channel": "<string>",
"rationale": "<string>"
}
]
},
"sourceDiagnostics": [
{
"id": "<string>",
"sourceId": "<string>",
"name": "<string>",
"cardPosture": {
"state": "connected",
"reasonCode": "connected",
"explanation": "<string>"
},
"agentId": "<string>",
"endpointUrl": "<string>",
"auth": {
"required": true,
"configured": true,
"type": "<string>"
},
"capabilities": {},
"productBuilder": {
"wholesaleProductCount": 123,
"buyerVisibleProductCount": 123,
"currencyMismatchProductCount": 123,
"reportingStaleProductCount": 123,
"signalCount": 123,
"catalogCacheCold": true,
"declaredUnsupportedIngredients": true
},
"compliance": {
"passed": true,
"summary": "<string>",
"checkedAt": "<string>",
"trackCounts": {
"total": 123,
"passing": 123,
"partial": 123,
"failing": 123
}
},
"debug": {
"version": "<string>",
"syntheticCapabilities": true,
"tools": [
"<string>"
],
"supportedBillings": [
"<string>"
],
"channels": [
"<string>"
],
"countries": [
"<string>"
],
"publisherDomains": [
"<string>"
],
"requireOperatorAuth": true
},
"lastActivity": {
"action": "<string>",
"resourceType": "<string>",
"resourceId": "<string>",
"resourceName": "<string>",
"description": "<string>",
"timestamp": "<string>"
},
"health": {
"lastError": "<string>",
"lastErrorCode": "<string>",
"lastErrorAt": "<string>",
"lastSuccessAt": "<string>",
"lastCheckedAt": "<string>"
},
"capabilityHealth": {
"inventory": {
"observations": [
{
"observer": "<string>",
"cause": "<string>",
"detail": "<string>",
"owner": "<string>",
"observedAt": "<string>",
"lastOkAt": "<string>"
}
]
},
"reporting": {
"observations": [
{
"observer": "<string>",
"cause": "<string>",
"detail": "<string>",
"owner": "<string>",
"observedAt": "<string>",
"lastOkAt": "<string>"
}
]
}
},
"detailAction": {
"operation": "list_ad_server_sources",
"arguments": {
"esaId": "<string>"
}
},
"catalogMappingReadiness": {
"progress": {
"ready": 4503599627370495,
"applicable": 4503599627370495,
"percent": 50
},
"nextAction": {
"operation": "open_modular_avails_commit",
"arguments": {
"sourceId": "<string>"
}
}
}
}
],
"diagnoses": [
{
"diagnosisId": "<string>",
"sourceId": "<string>",
"sourceName": "<string>",
"summary": "<string>",
"detail": "<string>",
"action": {
"kind": "recheck",
"label": "<string>",
"operation": "refresh_esa",
"pathParams": {
"esaId": "<string>"
},
"method": "POST",
"path": "<string>"
},
"docsAnchor": "<string>",
"observedAt": "<string>"
}
],
"availabilityGuidance": {
"stage": "before_source_dispatch",
"why": "<string>",
"effect": "<string>",
"fix": "<string>",
"subjects": [
{
"kind": "inventory_source",
"id": "<string>",
"name": "<string>"
}
],
"evidence": {
"kind": "billing_compatibility",
"requiredSupportedBilling": "agent",
"incompatibleSources": [
{
"sourceId": "<string>",
"sourceName": "<string>",
"advertisedSupportedBillings": [
"<string>"
]
}
]
}
},
"onboardingPlan": {
"version": 0,
"target": [
{
"value": "<string>",
"sourceRef": "<string>",
"confidence": 0.5,
"evidenceRefs": [
"<string>"
]
}
],
"steps": {},
"phaseTransitions": [
{
"at": "<string>"
}
],
"lastUpdatedBy": "<string>",
"lastUpdatedAt": "<string>"
},
"liveness": {
"reason": "<string>",
"remainingSteps": 4503599627370495,
"actionPath": "<string>"
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}{
"data": null,
"error": {
"code": "<string>",
"message": "<string>",
"field": "<string>",
"details": {}
}
}Authorizations
API key or access token
Response
Get storefront readiness
Storefront readiness assessment
Overall storefront readiness status
ready, blocked Compatibility-named seller intake hold. True blocks discovery, new buys, and buyer edits but does not pause existing delivery. False is neutral and does not itself imply readiness.
Canonical effective availability: non-paused, non-archived, and every current blocker complete.
Derived storefront status. Never stored and never copied from adcp_agent.status.
archived, paused, blocked, live Show child attributes
Show child attributes
Configured publisher domains with current authorization and property-resolution status.
Show child attributes
Show child attributes
Seller-side starter-brief coverage derived from profile, markets, channels, and product evidence.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Typed source-health diagnoses. Only seller-owned entries are tasks; scope3/vendor-owned entries are informational and never block readiness.
Show child attributes
Show child attributes
Seller onboarding phase, derived live from setup-mode + readiness: pass_through (a finished-products sales agent — no rungs) or the Crawl → Walk → Run progression for composition storefronts. Orients the seller ("you are in Phase 1 of 3").
pass_through, crawl, walk, run Canonical explanation for a top-level paused or archived admission control. Check-specific blockers remain in checks[].guidance.
Show child attributes
Show child attributes
The persisted onboarding plan (target model + phase-transition history), loaded and reconciled on this read.
Show child attributes
Show child attributes
The projected storefront liveness verdict (AI-4698) — one derived status over settlement invariants, go-live blockers, post-live degradation, and multi-source/mode honesty. Authoritative for every surface (seller-setup widget, storefront switcher) when present.
Show child attributes
Show child attributes