The Hotel Data API is a platform to allow the retrieval of system data including, Deployments, Transactions and Documents. The API exposes a series of REST endpoints as well as a Webhook system for real time notifications of specific events.
Authentication
See Authentication for details on how to obtain and manage Access tokens, using the PKN of HOTELDATAAPI.
Endpoint Types
The REST endpoints are split into two contexts, Search endpoints and Direct endpoints.
Search Endpoints
These are endpoints that allow search criteria to be provided and will filter down the records returned by this criteria. Unless otherwise stated search criteria is inclusive.
The data returned from these endpoints is paginated and a summary of the data. For details results use the Direct Endpoints to request more detailed information on individual resources.
ℹ️ All search endpoints are POST requests.
/v1/Documents to search for Documents or /v1/Transactions to search for Transactions.
Direct Endpoints
These are endpoints where you know the entity you wish to retrieve, by id. You can request this Entity directly or request Child entities related to it.
Direct Endpoints also require the Card Pool Id via query string that the request resource belongs to.
/v1/Deployments/123 to request a specific Deployment or /v1/Deployments/123/invoices to request the invoices related to that Deployment.