Authentication
This endpoint requires authentication. See Authentication for detailed information about required headers and how to obtain your API keys.
Path Parameters
The unique identifier (UUID) of the order to retrieve.
Query Params
Whether to format dates according to the locale. When set to true, dates
will be formatted in a human-readable format based on the X-LOCALE header.
Whether to include guest names in the response. When set to true, the
response will include guest name information.
Example Requests
Basic request:
With formatted dates and guest names:
GET /orders/order_123456?formatDates=true&includeGuestNames=true
Response
{
"uuid": "67890abc-def1-2345-6789-0123456789ab",
"orderDate": "2025-01-15T14:30:00.000Z",
"totalAmount": 250.0,
"status": "confirmed",
"guestNames": ["John Doe", "Jane Smith"],
"items": [
{
"name": "Room Upgrade",
"quantity": 1,
"price": 150.0,
"itemId": "item_abc123"
},
{
"name": "Spa Treatment",
"quantity": 2,
"price": 50.0,
"itemId": "item_def456"
}
],
"billingAddress": {
"street": "123 Main St",
"city": "New York",
"zip": "10001",
"country": "US"
},
"paymentMethod": "credit_card",
"paymentStatus": "paid",
"notes": "Special request for early check-in",
"createdAt": "2025-01-15T10:00:00.000Z",
"updatedAt": "2025-01-15T14:30:00.000Z"
}
Error Responses
Missing or invalid authentication headers
Insufficient permissions to access order data
Order not found or invalid Order ID provided
