Retrieve reservation

get/reservation/external-id/{id}

Request

  • Base URL
    https://api.breezeway.io/public/inventory/v1
  • URL
    https://api.breezeway.io/public/inventory/v1/reservation/external-id/{id}
  • Auth
    API key in header Authorization

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

access_codeunknown
checkin_datestring
checkin_earlyunknown
checkin_timestring
checkout_datestring
checkout_lateunknown
checkout_timestring
guide_urlunknown
idinteger
noteunknown
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"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.