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>",
  "status": "ready",
  "checks": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "category": "<string>",
      "status": "complete",
      "isBlocker": true,
      "method": "<string>",
      "details": "<string>",
      "compliance": [
        {
          "agentId": "<string>",
          "agentUrl": "<string>",
          "passed": true,
          "tracks": [
            {
              "track": "<string>",
              "status": "pass",
              "label": "<string>",
              "durationMs": 123,
              "failureReason": "<string>"
            }
          ],
          "summary": "<string>",
          "observations": [
            {
              "category": "<string>",
              "severity": "info",
              "message": "<string>"
            }
          ],
          "durationMs": 123,
          "error": "<string>"
        }
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.interchange.io/llms.txt

Use this file to discover all available pages before exploring further.

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