Hotel Reservations

Use this type to declare a reservation for one or more guests at a hotel or place of lodging.

Use cases

The following use cases show common examples of how the LodgingReservation schema is used. Use these examples to ensure that you markup is properly structured.

Basic Hotel Reservation

This is an example of the minimal amount of markup that will qualify your email as an LodgingReservation.

Json-Ld

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "LodgingReservation",
  "reservationNumber": "abc456",
  "reservationStatus": "http://schema.org/Confirmed",
  "underName": {
    "@type": "Person",
    "name": "John Smith"
  },
  "reservationFor": {
    "@type": "LodgingBusiness",
    "name": "Hilton San Francisco Union Square",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "333 O'Farrell St",
      "addressLocality": "San Francisco",
      "addressRegion": "CA",
      "postalCode": "94102",
      "addressCountry": "US"
    },
    "telephone": "415-771-1400"
  },
  "checkinDate": "2017-04-11T16:00:00-08:00",
  "checkoutDate": "2017-04-13T11:00:00-08:00"
}
</script>

Microdata

<div itemscope itemtype="http://schema.org/LodgingReservation">
  <meta itemprop="reservationNumber" content="abc456"/>
  <link itemprop="reservationStatus" href="http://schema.org/Confirmed"/>
  <div itemprop="underName" itemscope itemtype="http://schema.org/Person">
    <meta itemprop="name" content="John Smith"/>
  </div>
  <div itemprop="reservationFor" itemscope itemtype="http://schema.org/LodgingBusiness">
    <meta itemprop="name" content="Hilton San Francisco Union Square"/>
    <div itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">
      <meta itemprop="streetAddress" content="333 O'Farrell St"/>
      <meta itemprop="addressLocality" content="San Francisco"/>
      <meta itemprop="addressRegion" content="CA"/>
      <meta itemprop="postalCode" content="94102"/>
      <meta itemprop="addressCountry" content="US"/>
    </div>
    <meta itemprop="telephone" content="415-771-1400"/>
  </div>
  <meta itemprop="checkinDate" content="2017-04-11T16:00:00-08:00"/>
  <meta itemprop="checkoutDate" content="2017-04-13T11:00:00-08:00"/>
</div>

Update reservation

You may update a reservation simply by sending the updated reservation and setting modifiedTime to the time of the update.

The reservationNumber of the updated reservation must match the one in the original reservation. If your reservation system issues new confirmation numbers for updates, you must first cancel the reservation with the original confirmation number. Then, create a new reservation using the new confirmation number and updated information.

JSON-LD

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "LodgingReservation",
  "reservationNumber": "abc456",
  "reservationStatus": "http://schema.org/Confirmed",
  "underName": {
    "@type": "Person",
    "name": "John Smith"
  },
  "reservationFor": {
    "@type": "LodgingBusiness",
    "name": "Hilton San Francisco Union Square",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "333 O'Farrell St",
      "addressLocality": "San Francisco",
      "addressRegion": "CA",
      "postalCode": "94102",
      "addressCountry": "US"
    },
    "telephone": "415-771-1400"
  },
  "checkoutDate": "2017-04-13T11:00:00-08:00",
  "checkinDate": "2017-04-10T16:00:00-08:00",
  "modifiedTime": "2013-05-01T08:00:00-08:00"
}
</script>

Microdata

<div itemscope itemtype="http://schema.org/LodgingReservation">
  <meta itemprop="reservationNumber" content="abc456"/>
  <link itemprop="reservationStatus" href="http://schema.org/Confirmed"/>
  <div itemprop="underName" itemscope itemtype="http://schema.org/Person">
    <meta itemprop="name" content="John Smith"/>
  </div>
  <div itemprop="reservationFor" itemscope itemtype="http://schema.org/LodgingBusiness">
    <meta itemprop="name" content="Hilton San Francisco Union Square"/>
    <div itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">
      <meta itemprop="streetAddress" content="333 O'Farrell St"/>
      <meta itemprop="addressLocality" content="San Francisco"/>
      <meta itemprop="addressRegion" content="CA"/>
      <meta itemprop="postalCode" content="94102"/>
      <meta itemprop="addressCountry" content="US"/>
    </div>
    <meta itemprop="telephone" content="415-771-1400"/>
  </div>
  <meta itemprop="checkoutDate" content="2017-04-13T11:00:00-08:00"/>
  <meta itemprop="checkinDate" content="2017-04-10T16:00:00-08:00"/>
  <meta itemprop="modifiedTime" content="2013-05-01T08:00:00-08:00"/>
</div>

Cancel a reservation

You may cancel the reservation by setting reservationStatus to http://schema.org/Cancelled and set modifiedTime to the time of the cancellation.

JSON-LD

<script type="application/ld+json">
{
  "@context": "http://schema.org",
  "@type": "LodgingReservation",
  "reservationNumber": "abc456",
  "reservationStatus": "http://schema.org/Cancelled",
  "underName": {
    "@type": "Person",
    "name": "John Smith"
  },
  "reservationFor": {
    "@type": "LodgingBusiness",
    "name": "Hilton San Francisco Union Square",
    "address": {
      "@type": "PostalAddress",
      "streetAddress": "333 O'Farrell St",
      "addressLocality": "San Francisco",
      "addressRegion": "CA",
      "postalCode": "94102",
      "addressCountry": "US"
    },
    "telephone": "415-771-1400"
  },
  "checkinDate": "2017-04-11T16:00:00-08:00",
  "checkoutDate": "2017-04-13T11:00:00-08:00",
  "modifiedTime": "2013-05-01T08:30:00-08:00"
}
</script>

Microdata

<div itemscope itemtype="http://schema.org/LodgingReservation">
  <meta itemprop="reservationNumber" content="abc456"/>
  <link itemprop="reservationStatus" href="http://schema.org/Cancelled"/>
  <div itemprop="underName" itemscope itemtype="http://schema.org/Person">
    <meta itemprop="name" content="John Smith"/>
  </div>
  <div itemprop="reservationFor" itemscope itemtype="http://schema.org/LodgingBusiness">
    <meta itemprop="name" content="Hilton San Francisco Union Square"/>
    <div itemprop="address" itemscope itemtype="http://schema.org/PostalAddress">
      <meta itemprop="streetAddress" content="333 O'Farrell St"/>
      <meta itemprop="addressLocality" content="San Francisco"/>
      <meta itemprop="addressRegion" content="CA"/>
      <meta itemprop="postalCode" content="94102"/>
      <meta itemprop="addressCountry" content="US"/>
    </div>
    <meta itemprop="telephone" content="415-771-1400"/>
  </div>
  <meta itemprop="checkinDate" content="2017-04-11T16:00:00-08:00"/>
  <meta itemprop="checkoutDate" content="2017-04-13T11:00:00-08:00"/>
  <meta itemprop="modifiedTime" content="2013-05-01T08:30:00-08:00"/>
</div>

Specification

Review the details of your email to see if any of these addional properties apply to your reservation. By marking up these additional properties you allow Google to display a much richer description of the lodging reservation to the user.

Property Type Description
reservationNumber Text (required) The number or id of the reservation.
reservationStatus ReservationStatus (required) Current status of the reservation.
url URL Web page where reservation can be viewed.
underName Person or Organization (required) The guest.
underName.name Text (required) Name of the Person.
underName.email Text Email address.
bookingAgent Organization or Person Booking agent or agency. Also accepts a string (e.g. "").
bookingAgent.name Text Name of the agent/service.
bookingAgent.url URL Website of the agent/service.
bookingTime DateTime Date the reservation was made.
modifiedTime DateTime (recommended for Google Now/Search Answers) Time the reservation was last modified.
programMembership ProgramMembership Any membership in a frequent flyer, hotel loyalty program, etc. being applied to the reservation.
programMembership.memberNumber Text The identifier of the membership.
programMembership.program Text The name of the program.
confirmReservationUrl URL Web page where reservation can be confirmed.
cancelReservationUrl URL Web page where reservation can be cancelled.
modifyReservationUrl URL (recommended for Google Now/Search Answers) Web page where reservation can be modified.
reservationFor LodgingBusiness (required) The lodging the reservation is at.
reservationFor.name Text (required) Name of the Address of lodging.
reservationFor.address PostalAddress (required) Address of the Address of lodging.
reservationFor.address.streetAddress Text (required) Street address of Address of lodging.
reservationFor.address.addressLocality Text (required) Locality (e.g. city) of Address of lodging.
reservationFor.address.addressRegion Text (required) Region (e.g. State) of Address of lodging.
reservationFor.address.postalCode Text (required) Postal code of Address of lodging.
reservationFor.address.addressCountry Text or Country (required) Country of Address of lodging.
reservationFor.telephone Text (required) Telephone number of the LodgingBusiness.
reservationFor.url URL Website of the lodging business.
reservationFor.image URL Photo of the lodging business.
reservationFor.contactPoint ContactPoint (recommended for Google Now/Search Answers) A contact point for the LodgingBusiness.
checkinDate DateTime (required) Checkin time.
checkoutDate DateTime (required) Checkout time.
lodgingUnitDescription Text Textual description of the unit type (including suite vs. room, size of bed, etc.).
price Text Total price of the LodgingReservation.
priceCurrency Text The currency (in 3-letter ISO 4217 format) of the LodgingReservation's price.
numAdults Number Number of adults who will be staying in the lodging unit.
numChildren Number Number of children who will be staying in the lodging unit.