API Reference
Commerce REST API endpoints
Base URL: https://commerce.hanzo.ai/v1
All requests require a Bearer token:
curl -H "Authorization: Bearer $HANZO_COMMERCE_KEY" \
https://commerce.hanzo.ai/v1/products
| Method | Endpoint | Description |
|---|
POST | /products | Create product |
GET | /products | List products |
GET | /products/:id | Get product |
PATCH | /products/:id | Update product |
DELETE | /products/:id | Delete product |
| Method | Endpoint | Description |
|---|
POST | /checkouts | Create checkout session |
GET | /checkouts/:id | Get checkout status |
| Method | Endpoint | Description |
|---|
GET | /orders | List orders |
GET | /orders/:id | Get order |
POST | /orders/:id/fulfill | Mark as fulfilled |
POST | /orders/:id/refund | Refund order |
| Method | Endpoint | Description |
|---|
POST | /subscriptions | Create subscription |
GET | /subscriptions/:id | Get subscription |
PATCH | /subscriptions/:id | Update subscription |
DELETE | /subscriptions/:id | Cancel subscription |
| Method | Endpoint | Description |
|---|
POST | /usage | Record usage event |
GET | /usage | Get usage summary |
| Method | Endpoint | Description |
|---|
POST | /payments | Create payment |
GET | /payments/:id | Get payment |
POST | /payments/:id/refund | Refund payment |
POST | /payment-intents | Create payment intent |
POST | /payment-intents/:id/confirm | Confirm payment intent |
| Method | Endpoint | Description |
|---|
POST | /webhooks | Create webhook |
GET | /webhooks | List webhooks |
DELETE | /webhooks/:id | Delete webhook |
| Code | Description |
|---|
400 | Invalid request parameters |
401 | Invalid or missing API key |
404 | Resource not found |
409 | Conflict (duplicate resource) |
429 | Rate limit exceeded |
500 | Internal server error |
How is this guide?
Last updated on