Reservation | Documentation

Pulls reservation by condition

post

20 reservations per page

Authorizations

api-tokenstringRequired

Body

property_idinteger · int64Required

pageinteger · int32Optional

acknowledgedbooleanOptional

Responses

200

OK

application/json

post

/api/external/v0/reservation/pull

POST /api/external/v0/reservation/pull HTTP/1.1
Host: stage-api.forhotel.eu
api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "property_id": 1,
  "page": 1,
  "acknowledged": true
}

200

OK

{
  "data": [
    {
      "id": 1,
      "created_at": "1970-01-01 12:00:00",
      "updated_at": "1970-01-01 12:00:00",
      "status": "NEW",
      "financial_status": "UNPAID",
      "acknowledged": true,
      "reservation_number": "text",
      "sale_channel": "FRONT_DESK",
      "guarantee_method": "UPON_ARRIVAL",
      "room_type_id": 1,
      "rate_plan_id": 1,
      "from": "2025-12-09T22:20:06.269Z",
      "to": "2025-12-09T22:20:06.269Z",
      "night_count": 1,
      "reservation_guests": {
        "adult_count": 1,
        "child_count": 1,
        "infant_count": 1
      },
      "customer": {
        "first_name": "John",
        "last_name": "Snow",
        "language_code": "uk",
        "email": "text",
        "phone": "text"
      },
      "guests": [
        {
          "first_name": "John",
          "last_name": "Snow",
          "language_code": "uk",
          "email": "text",
          "phone": "text"
        }
      ],
      "accommodations": [
        {
          "date": "2025-12-09",
          "type": "FULL_DAY",
          "calculation_mode": "RATE_PLAN",
          "amount": 1
        }
      ],
      "services": [
        {
          "date": "2025-12-09",
          "service": "text",
          "quantity": 1,
          "included": true,
          "amount": 1
        }
      ],
      "payments": [
        {
          "created_at": "2025-12-09T22:20:06.269Z",
          "finalized_at": "2025-12-09T22:20:06.269Z",
          "order_number": "text",
          "amount": 1
        }
      ],
      "amounts": {
        "currency_code": "text",
        "accommodations": 1,
        "services": 1,
        "taxes": 1,
        "origin": 1,
        "total": 1,
        "paid": 1,
        "due": 1
      }
    }
  ],
  "meta": {
    "total": 1
  }
}

Finds reservation by ID

post

Authorizations

api-tokenstringRequired

Body

reservation_idinteger · int64Required

Responses

200

OK

application/json

post

/api/external/v0/reservation/find-by-id

POST /api/external/v0/reservation/find-by-id HTTP/1.1
Host: stage-api.forhotel.eu
api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "reservation_id": 1
}

200

OK

{
  "id": 1,
  "created_at": "1970-01-01 12:00:00",
  "updated_at": "1970-01-01 12:00:00",
  "status": "NEW",
  "financial_status": "UNPAID",
  "acknowledged": true,
  "reservation_number": "text",
  "sale_channel": "FRONT_DESK",
  "guarantee_method": "UPON_ARRIVAL",
  "room_type_id": 1,
  "rate_plan_id": 1,
  "from": "2025-12-09T22:20:06.269Z",
  "to": "2025-12-09T22:20:06.269Z",
  "night_count": 1,
  "reservation_guests": {
    "adult_count": 1,
    "child_count": 1,
    "infant_count": 1
  },
  "customer": {
    "first_name": "John",
    "last_name": "Snow",
    "language_code": "uk",
    "email": "text",
    "phone": "text"
  },
  "guests": [
    {
      "first_name": "John",
      "last_name": "Snow",
      "language_code": "uk",
      "email": "text",
      "phone": "text"
    }
  ],
  "accommodations": [
    {
      "date": "2025-12-09",
      "type": "FULL_DAY",
      "calculation_mode": "RATE_PLAN",
      "amount": 1
    }
  ],
  "services": [
    {
      "date": "2025-12-09",
      "service": "text",
      "quantity": 1,
      "included": true,
      "amount": 1
    }
  ],
  "payments": [
    {
      "created_at": "2025-12-09T22:20:06.269Z",
      "finalized_at": "2025-12-09T22:20:06.269Z",
      "order_number": "text",
      "amount": 1
    }
  ],
  "amounts": {
    "currency_code": "text",
    "accommodations": 1,
    "services": 1,
    "taxes": 1,
    "origin": 1,
    "total": 1,
    "paid": 1,
    "due": 1
  }
}

Marks reservations as acknowledged

post

20 reservations per request

Authorizations

api-tokenstringRequired

Body

reservation_idsinteger · int64[]Required

Responses

200

OK

application/json

post

/api/external/v0/reservation/acknowledge

POST /api/external/v0/reservation/acknowledge HTTP/1.1
Host: stage-api.forhotel.eu
api-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "reservation_ids": [
    1
  ]
}

200

OK

{
  "status": "text"
}