Orders API
Access order information, payment status, and transaction details.
Overview
The Orders API provides read-only access to order information. Orders are created when attendees complete the checkout process for event bookings.
Each order has a unique access key that can be used by attendees to view their order status without authentication.
Base Path
https://api.nookhive.com/v1/ordersEndpoints
GET
/v1/orders/{orderId}Get Order Details
Retrieve detailed information about a specific order.
Parameters
Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/orders/ord_abc123" \
-H "Authorization: Bearer nk_live_your_api_key_here"ResponseJSON
{
"order": {
"id": "ord_abc123",
"orderNumber": "ORD-2026-00123",
"status": "COMPLETED",
"customer": {
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890"
},
"event": {
"id": "evt_example123",
"slug": "annual-conference-2026",
"title": "Annual Conference 2026"
},
"items": [
{
"ticketType": "Standard Ticket",
"quantity": 2,
"unitPrice": 199.00,
"amount": 398.00
}
],
"subtotal": 398.00,
"discount": 0.00,
"tax": 0.00,
"totalAmount": 398.00,
"currency": "USD",
"payment": {
"method": "CARD",
"status": "SUCCEEDED",
"paidAt": "2026-01-10T15:30:00Z"
},
"bookings": [
{
"id": "bkg_abc123",
"attendeeName": "John Doe"
},
{
"id": "bkg_abc124",
"attendeeName": "Jane Doe"
}
],
"createdAt": "2026-01-10T15:00:00Z",
"completedAt": "2026-01-10T15:30:00Z"
}
}GET
/v1/orders/{orderId}/statusGet Order Status
Get a lightweight status check for an order. Useful for polling payment status.
Parameters
Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/orders/ord_abc123/status" \
-H "Authorization: Bearer nk_live_your_api_key_here"ResponseJSON
{
"orderId": "ord_abc123",
"status": "COMPLETED",
"paymentStatus": "SUCCEEDED",
"updatedAt": "2026-01-10T15:30:00Z"
}GET
/v1/orders/{orderId}/confirmationGet Order Confirmation PDF
Generate and download a PDF confirmation for an order.
Parameters
Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/orders/ord_abc123/confirmation" \
-H "Authorization: Bearer nk_live_your_api_key_here" \
-o confirmation.pdfReturns a PDF file with Content-Type: application/pdf
GET
/v1/orders/{orderId}/invoiceGet Order Invoice PDF
Generate and download an invoice PDF for an order.
Parameters
Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/orders/ord_abc123/invoice" \
-H "Authorization: Bearer nk_live_your_api_key_here" \
-o invoice.pdfGET
/v1/orders/{orderId}/receiptGet Payment Receipt PDF
Generate and download a payment receipt PDF for an order.
Parameters
Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/orders/ord_abc123/receipt" \
-H "Authorization: Bearer nk_live_your_api_key_here" \
-o receipt.pdfThe Order Object
{
"id": "ord_abc123",
"orderNumber": "ORD-2026-00123",
"status": "COMPLETED",
"customer": {
"name": "John Doe",
"email": "john@example.com",
"phone": "+1234567890",
"company": "Acme Corp"
},
"event": {
"id": "evt_example123",
"slug": "annual-conference-2026",
"title": "Annual Conference 2026",
"startDate": "2026-03-15T09:00:00Z"
},
"items": [
{
"id": "item_xyz789",
"ticketTypeId": "tt_standard",
"ticketType": "Standard Ticket",
"quantity": 2,
"unitPrice": 199.00,
"amount": 398.00,
"currency": "USD"
}
],
"subtotal": 398.00,
"discountCode": null,
"discount": 0.00,
"tax": 0.00,
"totalAmount": 398.00,
"currency": "USD",
"payment": {
"method": "CARD",
"status": "SUCCEEDED",
"reference": "pi_abc123def456",
"paidAt": "2026-01-10T15:30:00Z"
},
"bookings": [
{
"id": "bkg_abc123",
"attendeeName": "John Doe",
"attendeeEmail": "john@example.com"
}
],
"accessKey": "ak_secure_key_here",
"confirmationSentAt": "2026-01-10T15:31:00Z",
"createdAt": "2026-01-10T15:00:00Z",
"completedAt": "2026-01-10T15:30:00Z",
"updatedAt": "2026-01-10T15:31:00Z"
}Order Statuses
| Status | Description |
|---|---|
PENDING | Order created, awaiting payment |
PROCESSING | Payment is being processed |
COMPLETED | Payment successful, order complete |
FAILED | Payment failed |
CANCELLED | Order was cancelled |
REFUNDED | Payment was refunded |