# List health

URL: https://docs.hanzo.ai/docs/openapi/commerce/get-commerce-health

> Answers ok whenever the commerce subsystem is mounted.

`GET /v1/commerce/health`

> [Commerce →](https://docs.hanzo.ai/docs/openapi/commerce) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                           |
| ------------- | ----------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/commerce/health` |
| **Method**    | `GET`                                     |
| **Operation** | `get_commerce_health`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`    |

Answers ok whenever the commerce subsystem is mounted. It is registered
before the module embed boots, so it keeps answering even when the embed
failed and every business route serves the fail-closed 503 — which is the
point: it reports that the process is reachable, never that the money plane
is healthy. Unauthenticated: a probe that needs a credential is a probe that
reports the credential.

A named handler, not a closure, so zipdoc can lift this prose into the registry.

## Request

`GET /v1/commerce/health` takes no parameters and no body — the credential is the whole request.

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | liveness        | ok      |
| `default` | problem-details | refused |

`200` body — 2 fields.

| Field     | In   | Type   | Always | Description                                                     |
| --------- | ---- | ------ | ------ | --------------------------------------------------------------- |
| `service` | body | string | —      | Service names the answering subsystem; it is always commerce.   |
| `status`  | body | string | —      | Status is always ok: mounted is the only state that can answer. |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo commerce health
```

**SDK**

**.ts**

```ts
import { Configuration, CommerceApi } from 'hanzoai';

const api = new CommerceApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getCommerceHealth();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import CommerceApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = CommerceApi(client).get_commerce_health()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.CommerceAPI.GetCommerceHealth(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, commerce_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = commerce_api::get_commerce_health(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.CommerceApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new CommerceApi(client).getCommerceHealth();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/commerce/health \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `commerce`, op `get_commerce_health` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "commerce",
         "arguments": {
           "op": "get_commerce_health",
           "input": {}
         }
       }
     }'
```

---

[Commerce API](https://docs.hanzo.ai/docs/openapi/commerce) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)