Skip to main content

​
Base URL

Use the host provided by PageOne Travel: 
https://<your-host>/api
All routes in this documentation are shown with /api prefix.

​
Content Type

Use application/json for request and response payloads.

​
Success Response Envelope

Backend applies a global response interceptor, so successful calls return: 
{
  "data": {},
  "message": "success"
}

​
Error Response

Error responses are standard NestJS HTTP errors (not wrapped by data/message envelope), for example: 
{
  "statusCode": 400,
  "message": "Price changed",
  "error": "Bad Request"
}

​
Required Date/Time Formats

  • Date fields (checkIn, checkOut): YYYY-MM-DD
  • Cancellation penalty deadlines: ISO-8601 datetime string

​
Important Runtime Behavior

  • session-id header: auto-generated by backend if missing.
  • connection-code header: auto-filled from settings.access.code when available.
  • Search/Quote have rate limiting with response headers:
    • X-RateLimit-Limit
    • X-RateLimit-Remaining
    • X-RateLimit-Reset
    • Retry-After (when limited)

​
API Index

  • Authentication: /api-reference/authentication
  • Flow sequence: /api-reference/workflow
  • Core APIs: /api-reference/core/search, /api-reference/core/quote, /api-reference/core/book, /api-reference/core/cancel
  • Partner management: /api-reference/management/auth-login, /api-reference/management/users, /api-reference/management/api-keys, /api-reference/management/partner-connections
  • Admin APIs: /api-reference/management/admin-bootstrap-users, /api-reference/management/admin-connections
  • Shared object models: /api-reference/models/common-objects