v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

Retrieve reservation

get/reservation/external-id/{id}

Path parameters

idstring required

Reservation ID from external system

Query parameters

allow_multipleboolean

If the external id is used on multiple Breezeway reservations, allow returning the collection

Response

200

{"stackTrail":"paths:/reservation/external-id/{id}:get:responses:200:content:application/json:schema:properties:access_code","oasType":"schema","type":"unknown"}

checkin_datestring

{"stackTrail":"paths:/reservation/external-id/{id}:get:responses:200:content:application/json:schema:properties:checkin_early","oasType":"schema","type":"unknown"}

checkin_timestring

checkout_datestring

{"stackTrail":"paths:/reservation/external-id/{id}:get:responses:200:content:application/json:schema:properties:checkout_late","oasType":"schema","type":"unknown"}

checkout_timestring

{"stackTrail":"paths:/reservation/external-id/{id}:get:responses:200:content:application/json:schema:properties:guide_url","oasType":"schema","type":"unknown"}

idinteger

{"stackTrail":"paths:/reservation/external-id/{id}:get:responses:200:content:application/json:schema:properties:note","oasType":"schema","type":"unknown"}

property_idinteger

reference_external_property_idstring

reference_property_idstring

reference_reservation_idstring

statusstring

Example response

{
  "checkin_date": "2021-06-17",
  "checkin_time": "15:00:00",
  "checkout_date": "2021-06-18",
  "checkout_time": "10:00:00",
  "id": 10136911,
  "property_id": 8542,
  "reference_external_property_id": "peyto_home",
  "reference_property_id": "peyto_home",
  "reference_reservation_id": "june-17-peyto-home-1",
  "status": "active",
  "type_guest": {
    "code": "owner",
    "name": "Owner"
  },
  "type_reservation": {
    "code": "booking",
    "name": "Booking"
  },
  "type_stay": {
    "code": "owner",
    "name": "Owner"
  }
}