Skip to main content
GET
/
readiness
Get storefront readiness
curl --request GET \
  --url https://api.interchange.io/api/v2/storefront/readiness \
  --header 'Authorization: Bearer <token>'
{
  "platformId": "<string>",
  "checks": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "category": "<string>",
      "isBlocker": true,
      "method": "<string>",
      "details": "<string>",
      "actionLabel": "<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>"
        }
      ]
    }
  ],
  "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>",
      "executionType": "<string>",
      "sourceStatus": "<string>",
      "agentId": "<string>",
      "agentStatus": "<string>",
      "endpointUrl": "<string>",
      "protocol": "<string>",
      "auth": {
        "required": true,
        "configured": true,
        "type": "<string>"
      },
      "capabilities": {},
      "productBuilder": {
        "wholesaleProductCount": 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>"
        ],
        "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>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

API key or access token

Response

Get storefront readiness

Storefront readiness assessment

platformId
string
required
status
enum<string>
required

Overall storefront readiness status

Available options:
ready,
blocked
checks
object[]
required
demandCoverage
object
required

Seller-side starter-brief coverage derived from profile, markets, channels, and product evidence.

sourceDiagnostics
object[]
required