Cognis
Commerce Brand Launch

Get Prerequisites

GET
/org/{orgId}/ecom/automation/brand-launch/prerequisites

Public API endpoint: ecomBrandLaunch.getPrerequisites

Required scopes: org:ecom:read

Authorization

bearerAuth
AuthorizationBearer <token>

API key (prefix: cogn_) from Account → Developer

In: header

Path Parameters

orgId*string

Organization ID (prefix: org_)

Query Parameters

domainSource?string
Value in"reuse_existing" | "purchase_new" | "porkbun_existing"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3013/api/v1/org/string/ecom/automation/brand-launch/prerequisites"
{
  "success": true,
  "data": {
    "ready": false,
    "wizardReady": false,
    "items": [
      {
        "id": "porkbun_connected",
        "met": false,
        "detailKey": "ecom.automation.brandLaunch.prerequisites.porkbunConnected.detail"
      },
      {
        "id": "porkbun_default",
        "met": false,
        "detailKey": "ecom.automation.brandLaunch.prerequisites.porkbunDefault.detail"
      },
      {
        "id": "cloudflare_connected",
        "met": false,
        "detailKey": "ecom.automation.brandLaunch.prerequisites.cloudflareConnected.detail"
      },
      {
        "id": "stripe_checkout",
        "met": false,
        "detailKey": "ecom.automation.brandLaunch.prerequisites.stripeCheckout.detail"
      },
      {
        "id": "airwallex_checkout",
        "met": false,
        "detailKey": "ecom.automation.brandLaunch.prerequisites.airwallexCheckout.detail"
      },
      {
        "id": "org_languages",
        "met": false,
        "detailKey": "ecom.automation.brandLaunch.prerequisites.orgLanguages.detail"
      },
      {
        "id": "mailgun_ready",
        "met": false,
        "detailKey": "ecom.automation.brandLaunch.prerequisites.mailgunReady.detail"
      },
      {
        "id": "experimental_access",
        "met": false,
        "detailKey": "ecom.automation.brandLaunch.prerequisites.experimentalAccess.detail"
      }
    ]
  },
  "message": "Success",
  "traceId": "req_abc123"
}
{
  "success": false,
  "message": "Invalid data",
  "errors": [
    {
      "code": 400,
      "message": "Invalid data"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unauthorized",
  "errors": [
    {
      "code": 401,
      "message": "Unauthorized"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Forbidden",
  "errors": [
    {
      "code": 403,
      "message": "Forbidden"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Not found",
  "errors": [
    {
      "code": 404,
      "message": "Not found"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Conflict",
  "errors": [
    {
      "code": 409,
      "message": "Conflict"
    }
  ],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "string",
  "errors": [
    {
      "code": 0,
      "message": "string",
      "details": {}
    }
  ],
  "traceId": "string",
  "params": {},
  "readableMessage": "string"
}
{
  "success": false,
  "message": "Rate limit exceeded",
  "errors": [],
  "traceId": "req_xxx"
}
{
  "success": false,
  "message": "Unexpected error",
  "errors": [
    {
      "code": 500,
      "message": "Unexpected error"
    }
  ],
  "traceId": "req_xxx"
}