Skip to main content

​
Authentication

This endpoint requires authentication. See Authentication for detailed information about required headers and how to obtain your API keys.

​
Query Params

​
startDate
Date
required
Filter by start date (from this date). Format: YYYY-MM-DD
​
endDate
Date
required
Filter by end date (to this date). Format: YYYY-MM-DD
​
formatDates
boolean
default:"false"
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.
​
includeGuestNames
boolean
default:"false"
Whether to include guest names in the response. When set to true, the response will include guest name information.

​
Example Requests

Basic request: 
GET /orders?startDate=2025-01-01&endDate=2025-01-31
With formatted dates and guest names: 
GET /orders?startDate=2025-01-01&endDate=2025-01-31&formatDates=true&includeGuestNames=true

​
Response

The response returns data in a humanized format, meaning all information is localized and ready to be displayed to end users in the requested language. 
[
	{
		"uuid": "order_123456",
		"orderDate": "01/15/2025",
		"totalAmount": "$250.00",
		"status": "Confirmed",
		"guestNames": "John Doe, Jane Smith",
		"items": [
			{
				"name": "Room Upgrade",
				"quantity": 1,
				"price": "$150.00"
			},
			{
				"name": "Spa Treatment",
				"quantity": 2,
				"price": "$50.00"
			}
		]
		// Additional fields based on the order data
	}
]

​
Error Responses

​
400
Bad Request
Invalid query parameters or date format
​
401
Unauthorized
Missing or invalid authentication headers
​
403
Forbidden
Insufficient permissions to access order data
​
404
Not Found
Start Date or End Date not provided