← Home
GET/hyax-api/v1/products/:id/publish-readiness

Check publish readiness

The same checks the product editor runs. `blocking` checks prevent checkout and refuse publishing; `warning` checks let the product sell but flag something likely missing. Call this before publishing — it explains what to fix rather than only refusing.

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request

curl -X GET 'https://platform.hyax.com/hyax-api/v1/products/clx_example_id/publish-readiness' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "canPublish": false,
    "checks": [
      {
        "id": "price_set",
        "severity": "blocking",
        "isComplete": true,
        "label": "Set a price",
        "description": "This product has a fixed pricing type, so it needs a price above zero before customers can buy it."
      },
      {
        "id": "payment_method_connected",
        "severity": "blocking",
        "isComplete": false,
        "label": "Connect a payment method",
        "description": "Buyers need Stripe, PayPal, or USDC to pay you. With none connected, checkout has nowhere to send them."
      }
    ],
    "blockingIssues": ["payment_method_connected"],
    "warnings": ["product_media"]
  }
}