Orders API
Create, retrieve, update, and manage orders programmatically.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /orders | List all orders |
| POST | /orders | Create a new order |
| GET | /orders/{orderId} | Get order details |
| PUT | /orders/{orderId} | Update an order |
GET
/ordersRetrieve a paginated list of orders with optional filtering
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (default: 1) |
| limit | integer | No | Items per page (default: 20, max: 100) |
| status | string | No | Filter by status: PENDING, CONFIRMED, PROCESSING, SHIPPED, DELIVERED, CANCELLED, REFUNDED |
| startDate | datetime | No | Filter orders created after this date (ISO 8601) |
| endDate | datetime | No | Filter orders created before this date (ISO 8601) |
Example Request
curl -X GET "https://api.regentherapy.com/api/v1/orders?page=1&limit=20&status=PROCESSING" \
-H "X-API-Key: rg_your_api_key"Response
{
"success": true,
"data": {
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"orderNumber": "ORD-1713456789-ABCD12",
"tenantId": "ten_abc123",
"customerId": "cust_123",
"customerEmail": "john@example.com",
"customerName": "John Smith",
"status": "PROCESSING",
"paymentStatus": "PAID",
"subtotal": 1420.00,
"taxAmount": 100.00,
"shippingAmount": 0.00,
"discountAmount": 0.00,
"totalAmount": 1520.00,
"currency": "USD",
"itemCount": 8,
"createdAt": "2026-04-18T10:30:00Z",
"updatedAt": "2026-04-18T14:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 156,
"pages": 8
}
},
"meta": {
"timestamp": "2026-04-18T14:30:00Z",
"requestId": "req_abc123"
}
}POST
/ordersCreate a new order with items and shipping information
Order Statuses
Orders progress through these statuses during their lifecycle
| Status | Description | Webhook Event |
|---|---|---|
| PENDING | Order created, awaiting payment | order.created |
| CONFIRMED | Payment received, order confirmed | order.confirmed |
| PROCESSING | Order is being prepared | order.processing |
| SHIPPED | Order has been shipped | order.shipped |
| DELIVERED | Order delivered to customer | order.delivered |
| CANCELLED | Order was cancelled | order.cancelled |
| REFUNDED | Order was refunded | order.refunded |
Related Resources