| Property | Expected Type | description |
|---|---|---|
| numberOfRooms | Number QuantitativeValue | The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business.
Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue. |
| occupancy | The allowed total occupancy for the accommodation in persons (including infants etc). For individual accommodations, this is not necessarily the legal maximum but defines the permitted usage as per the contractual agreement (e.g. a double room used by a single person).
Typical unit code(s): C62 for person |
| Property | Expected Type | description |
|---|---|---|
| numberOfRooms | Number QuantitativeValue | The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business.
Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue. |
| Property | Expected Type | description |
|---|---|---|
| accommodationCategory | Text | Category of an Accommodation, following real estate conventions, e.g. RESO (see PropertySubType, and PropertyType fields for suggested values). |
| accommodationFloorPlan | A floorplan of some Accommodation. | |
| amenityFeature | An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs. | |
| floorLevel | Text | The floor level for an Accommodation in a multi-storey building. Since counting
systems vary internationally, the local system should be used where possible. |
| floorSize | The size of the accommodation, e.g. in square meter or squarefoot.
Typical unit code(s): MTK for square meter, FTK for square foot, or YDK for square yard | |
| leaseLength | Length of the lease for some Accommodation, either particular to some Offer or in some cases intrinsic to the property. | |
| numberOfBathroomsTotal | Integer | The total integer number of bathrooms in some Accommodation, following real estate conventions as documented in RESO: "The simple sum of the number of bathrooms. For example for a property with two Full Bathrooms and one Half Bathroom, the Bathrooms Total Integer will be 3.". See also numberOfRooms. |
| numberOfBedrooms | Number QuantitativeValue | |
| numberOfFullBathrooms | Number | Number of full bathrooms - The total number of full and ¾ bathrooms in an Accommodation. This corresponds to the BathroomsFull field in RESO. |
| numberOfPartialBathrooms | Number | Number of partial bathrooms - The total number of half and ¼ bathrooms in an Accommodation. This corresponds to the BathroomsPartial field in RESO. |
| numberOfRooms | Number QuantitativeValue | The number of rooms (excluding bathrooms and closets) of the accommodation or lodging business.
Typical unit code(s): ROM for room or C62 for no unit. The type of room can be put in the unitText property of the QuantitativeValue. |
| permittedUsage | Text | Indications regarding the permitted usage of the accommodation. |
| petsAllowed | Text Boolean | Indicates whether pets are allowed to enter the accommodation or lodging business. More detailed information can be put in a text value. |
| tourBookingPage | URL | A page providing information on how to book a tour of some Place, such as an Accommodation or ApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate. |
| yearBuilt | Number | The year an Accommodation was constructed. This corresponds to the YearBuilt field in RESO. |
| Property | Expected Type | description |
|---|---|---|
| additionalProperty | A property-value pair representing an additional characteristic of the entity, e.g. a product feature or another characteristic for which there is no matching property in schema.org.\n\nNote: Publishers should be aware that applications designed to use specific schema.org properties (e.g. https://schema.org/width, https://schema.org/color, https://schema.org/gtin13, ...) will typically expect such data to be provided using those properties, rather than using the generic property/value mechanism. | |
| address | Text PostalAddress | Physical address of the item. |
| aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
| amenityFeature | An amenity feature (e.g. a characteristic or service) of the Accommodation. This generic property does not make a statement about whether the feature is included in an offer for the main accommodation or available at extra costs. | |
| branchCode | Text | A short textual code (also called "store code") that uniquely identifies a place of business. The code is typically assigned by the parentOrganization and used in structured URLs.\n\nFor example, in the URL http://www.starbucks.co.uk/store-locator/etc/detail/3047 the code "3047" is a branchCode for a particular branch. |
| containedIn | The basic containment relation between a place and one that contains it. | |
| containedInPlace | The basic containment relation between a place and one that contains it. | |
| containsPlace | The basic containment relation between a place and another that it contains. | |
| event | Upcoming or past event associated with this place, organization, or action. | |
| events | Upcoming or past events associated with this place or organization. | |
| faxNumber | Text | A string representing a fax number. |
| geo | The geo coordinates of the place. | |
| geoContains | Represents a relationship between two geometries (or the places they represent), relating a containing geometry to a contained geometry. "a contains b iff no points of b lie in the exterior of a, and at least one point of the interior of b lies in the interior of a". As defined in DE-9IM. | |
| geoCoveredBy | Represents a relationship between two geometries (or the places they represent), relating a geometry to another that covers it. As defined in DE-9IM. | |
| geoCovers | Represents a relationship between two geometries (or the places they represent), relating a covering geometry to a covered geometry. "Every point of b is a point of (the interior or boundary of) a". As defined in DE-9IM. | |
| geoCrosses | Represents a relationship between two geometries (or the places they represent), relating a geometry to another that crosses it: "a crosses b: they have some but not all interior points in common, and the dimension of the intersection is less than that of at least one of them". As defined in DE-9IM. | |
| geoDisjoint | Represents spatial relations in which two geometries (or the places they represent) are topologically disjoint: "they have no point in common. They form a set of disconnected geometries." (A symmetric relationship, as defined in DE-9IM.) | |
| geoEquals | Represents spatial relations in which two geometries (or the places they represent) are topologically equal, as defined in DE-9IM. "Two geometries are topologically equal if their interiors intersect and no part of the interior or boundary of one geometry intersects the exterior of the other" (a symmetric relationship). | |
| geoIntersects | Represents spatial relations in which two geometries (or the places they represent) have at least one point in common. As defined in DE-9IM. | |
| geoOverlaps | Represents a relationship between two geometries (or the places they represent), relating a geometry to another that geospatially overlaps it, i.e. they have some but not all points in common. As defined in DE-9IM. | |
| geoTouches | Represents spatial relations in which two geometries (or the places they represent) touch: "they have at least one boundary point in common, but no interior points." (A symmetric relationship, as defined in DE-9IM.) | |
| geoWithin | Represents a relationship between two geometries (or the places they represent), relating a geometry to one that contains it, i.e. it is inside (i.e. within) its interior. As defined in DE-9IM. | |
| globalLocationNumber | Text | The Global Location Number (GLN, sometimes also referred to as International Location Number or ILN) of the respective organization, person, or place. The GLN is a 13-digit number used to identify parties and physical locations. |
| googleMapsUrl | URL | Contains the URL of the official Google page for this place. This will be the Google-owned page that contains the best available information about the place. Applications must link to or embed this page on any screen that shows detailed results about the place to the user. |
| googlePlaceId | Text | Contains the URL of the official Google page for this place. This will be the Google-owned page that contains the best available information about the place. Applications must link to or embed this page on any screen that shows detailed results about the place to the user. |
| googlePlaceTypes | Text | A list of types of the place. |
| hasDriveThroughService | Boolean | Indicates whether some facility (e.g. FoodEstablishment, CovidTestingFacility) offers a service that can be used by driving through in a car. In the case of CovidTestingFacility such facilities could potentially help with social distancing from other potentially-infected users. |
| hasMap | URL Map | A URL to a map of the place. |
| isAccessibleForFree | Boolean | A flag to signal that the item, event, or place is accessible for free. |
| isicV4 | Text | International Standard Industrial Classification of All Economic Activities, Revision 4 (ISIC Rev.4) code identifying either an entity’s activity or an industry category (section, division, group, or class). |
| keywords | Keywords or tags used to describe some item. Multiple textual entries in a keywords list are typically delimited by commas, or by repeating the property. | |
| latitude | Number Text | The latitude of a location. For example `` 37.42242`` (WGS 84). |
| logo | ImageObject URL | An associated logo. |
| longitude | Text Number | The longitude of a location. For example `` -122.08585`` (WGS 84). |
| map | URL | A URL to a map of the place. |
| maps | URL | A URL to a map of the place. |
| maximumAttendeeCapacity | Integer | The total number of individuals that may attend an event or venue. |
| openingHoursSpecification | The opening hours of a certain place. | |
| photo | A photograph of this place. | |
| photos | Photographs of this place. | |
| publicAccess | Boolean | A flag to signal that the Place is open to public visitors. If this property is omitted there is no assumed default boolean value |
| review | A review of the item. | |
| reviews | Review of the item. | |
| slogan | Text | A slogan or motto associated with the item. |
| smokingAllowed | Boolean | Indicates whether it is allowed to smoke in the place, e.g. in the restaurant, hotel or hotel room. |
| specialOpeningHoursSpecification | The special opening hours of a certain place.\n\nUse this to explicitly override general opening hours brought in scope by openingHoursSpecification or openingHours. | |
| telephone | Text | The telephone number. Including the international dialing prefix. |
| telephoneFormatted | Text | The local telephone number. |
| tourBookingPage | URL | A page providing information on how to book a tour of some Place, such as an Accommodation or ApartmentComplex in a real estate setting, as well as other kinds of tours as appropriate. |
| Property | Expected Type | description |
|---|---|---|
| listingSubTypes | ||
| listingType | ||
| playTypes | The types of sport, active recreation, and fitness associated with the entity. | |
| price | Text Number | The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes. |
| priceCurrency | Text | The currency of the price. |
| priceValidUntil | Date | This property is particularly useful for indicating time-sensitive pricing, such as limited-time discounts or promotional rates. After the priceValidUntil date, the price may change, or the offer may no longer be available at that price. It focuses specifically on the expiration of the stated price, which can differ from the overall validity period of the offer (defined by properties like validThrough) |
| registrationUrl | URL | The URL of the registration page for a listing. |
| scheduleTimezone | Text | Indicates the timezone for which the time(s) indicated in the Schedule are given. The value provided should be among those listed in the IANA Time Zone Database. |
| scheduleType | The type of schedule associated with the item or event. When left blank, a schedule is not applicable to the listing. | |
| validFrom | Date DateTime | the date and time when the offer becomes active, meaning when you can start booking, purchasing, or accepting it. Example: For the boat lease, this might be when the offer is first posted (e.g., June 1, 2010). |
| validThrough | Date DateTime | This is the date and time after which the offer can no longer be accepted. It’s the deadline to book or buy. Example: For the boat lease, this is the last moment to reserve it (e.g., July 15, 2010, at 23:59). |
| website | WebSite URL | . |
| Property | Expected Type | description |
|---|---|---|
| acceptedPaymentMethod | The payment method(s) accepted by seller for this offer. | |
| addOn | An additional offer that can only be obtained in combination with the first base offer (e.g. supplements and extensions that are available for a surcharge). | |
| advanceBookingRequirement | The amount of time that is required between accepting the offer and the actual usage of the resource or service. | |
| aggregateRating | The overall rating, based on a collection of reviews or ratings, of the item. | |
| areaServed | The geographic area where a service or offered item is provided. | |
| asin | Text URL | An Amazon Standard Identification Number (ASIN) is a 10-character alphanumeric unique identifier assigned by Amazon.com and its partners for product identification within the Amazon organization (summary from Wikipedia's article). Note also that this is a definition for how to include ASINs in Schema.org data, and not a definition of ASINs in general - see documentation from Amazon for authoritative details. ASINs are most commonly encoded as text strings, but the asin property supports URL/URI as potential values too. |
| availability | The availability of this item—for example In stock, Out of stock, Pre-order, etc. | |
| availabilityEnds | the date and time after which the product or service is no longer available. It marks the end of the period when you can use, receive, or pick up the item or service. Example: For the boat lease, this is when you must return it (e.g., August 31, 2010, at 23:59). | |
| availabilityStarts | the date and time when the product or service becomes available to the customer. It’s when you can start using, receiving, or picking up what’s being offered. Example: If you’re leasing a boat, this is when you can begin using it (e.g., August 1, 2010, at 09:00). | |
| availableAtOrFrom | The place(s) from which the offer can be obtained (e.g. store locations). | |
| availableDeliveryMethod | The delivery method(s) available for this offer. | |
| businessFunction | The business function (e.g. sell, lease, repair, dispose) of the offer or component of a bundle (TypeAndQuantityNode). The default is http://purl.org/goodrelations/v1#Sell. | |
| category | A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy. | |
| checkoutPageURLTemplate | Text | A URL template (RFC 6570) for a checkout page for an offer. This approach allows merchants to specify a URL for online checkout of the offered product, by interpolating parameters such as the logged in user ID, product ID, quantity, discount code etc. Parameter naming and standardization are not specified here. |
| deliveryLeadTime | The typical delay between the receipt of the order and the goods either leaving the warehouse or being prepared for pickup, in case the delivery method is on site pickup. | |
| eligibleCustomerType | The type(s) of customers for which the given offer is valid. | |
| eligibleDuration | The duration for which the given offer is valid. | |
| eligibleQuantity | The interval and unit of measurement of ordering quantities for which the offer or price specification is valid. This allows e.g. specifying that a certain freight charge is valid only for a certain quantity. | |
| eligibleRegion | The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is valid.\n\nSee also ineligibleRegion. | |
| eligibleTransactionVolume | The transaction volume, in a monetary unit, for which the offer or price specification is valid, e.g. for indicating a minimal purchasing volume, to express free shipping above a certain order volume, or to limit the acceptance of credit cards to purchases to a certain minimal amount. | |
| gtin | Text URL | A Global Trade Item Number (GTIN). GTINs identify trade items, including products and services, using numeric identification codes. The GS1 digital link specifications express GTINs as URLs (URIs, IRIs, etc.). Details including regular expression examples can be found in, Section 6 of the GS1 URI Syntax specification; see also schema.org tracking issue for schema.org-specific discussion. A correct gtin value should be a valid GTIN, which means that it should be an all-numeric string of either 8, 12, 13 or 14 digits, or a "GS1 Digital Link" URL based on such a string. The numeric component should also have a valid GS1 check digit and meet the other rules for valid GTINs. See also GS1's GTIN Summary and Wikipedia for more details. Left-padding of the gtin values is not required or encouraged. The gtin property generalizes the earlier gtin8, gtin12, gtin13, and gtin14 properties. Note also that this is a definition for how to include GTINs in Schema.org data, and not a definition of GTINs in general - see the GS1 documentation for authoritative details. |
| gtin12 | Text | The GTIN-12 code of the product, or the product to which the offer refers. The GTIN-12 is the 12-digit GS1 Identification Key composed of a U.P.C. Company Prefix, Item Reference, and Check Digit used to identify trade items. See GS1 GTIN Summary for more details. |
| gtin13 | Text | The GTIN-13 code of the product, or the product to which the offer refers. This is equivalent to 13-digit ISBN codes and EAN UCC-13. Former 12-digit UPC codes can be converted into a GTIN-13 code by simply adding a preceding zero. See GS1 GTIN Summary for more details. |
| gtin14 | Text | The GTIN-14 code of the product, or the product to which the offer refers. See GS1 GTIN Summary for more details. |
| gtin8 | Text | The GTIN-8 code of the product, or the product to which the offer refers. This code is also known as EAN/UCC-8 or 8-digit EAN. See GS1 GTIN Summary for more details. |
| hasAdultConsideration | Used to tag an item to be intended or suitable for consumption or use by adults only. | |
| hasMeasurement | A product measurement, for example the inseam of pants, the wheel size of a bicycle, or the gauge of a screw. Usually an exact measurement, but can also be a range of measurements for adjustable products, for example belts and ski bindings. | |
| hasMerchantReturnPolicy | Specifies a MerchantReturnPolicy that may be applicable. | |
| includesObject | This links to a node or nodes indicating the exact quantity of the products included in an Offer or ProductCollection. | |
| ineligibleRegion | The ISO 3166-1 (ISO 3166-1 alpha-2) or ISO 3166-2 code, the place, or the GeoShape for the geo-political region(s) for which the offer or delivery charge specification is not valid, e.g. a region where the transaction is not allowed.\n\nSee also eligibleRegion. | |
| inventoryLevel | The current approximate inventory level for the item or items. | |
| isFamilyFriendly | Boolean | Indicates whether this content is family friendly. |
| itemCondition | A predefined value from OfferItemCondition specifying the condition of the product or service, or the products or services included in the offer. Also used for product return policies to specify the condition of products accepted for returns. | |
| itemOffered | An item being offered (or demanded). The transactional nature of the offer or demand is documented using businessFunction, e.g. sell, lease etc. While several common expected types are listed explicitly in this definition, others can be used. Using a second type, such as Product or a subtype of Product, can clarify the nature of the offer. | |
| leaseLength | Length of the lease for some Accommodation, either particular to some Offer or in some cases intrinsic to the property. | |
| mobileUrl | Text | The mobileUrl property is provided for specific situations in which data consumers need to determine whether one of several provided URLs is a dedicated 'mobile site'. To discourage over-use, and reflecting intial usecases, the property is expected only on Product and Offer, rather than Thing. The general trend in web technology is towards responsive design in which content can be flexibly adapted to a wide range of browsing environments. Pages and sites referenced with the long-established url property should ideally also be usable on a wide variety of devices, including mobile phones. In most cases, it would be pointless and counter productive to attempt to update all url markup to use mobileUrl for more mobile-oriented pages. The property is intended for the case when items (primarily Product and Offer) have extra URLs hosted on an additional "mobile site" alongside the main one. It should not be taken as an endorsement of this publication style. |
| mpn | Text | The Manufacturer Part Number (MPN) of the product, or the product to which the offer refers. |
| offeredBy | A pointer to the organization or person making the offer. | |
| price | Text Number | The offer price of a product, or of a price component when attached to PriceSpecification and its subtypes. |
| priceCurrency | Text | The currency of the price. |
| priceSpecification | One or more detailed price specifications, indicating the unit price and delivery or payment charges. | |
| priceValidUntil | Date | This property is particularly useful for indicating time-sensitive pricing, such as limited-time discounts or promotional rates. After the priceValidUntil date, the price may change, or the offer may no longer be available at that price. It focuses specifically on the expiration of the stated price, which can differ from the overall validity period of the offer (defined by properties like validThrough) |
| review | A review of the item. | |
| reviews | Review of the item. | |
| seller | An entity which offers (sells / leases / lends / loans) the services / goods. A seller may also be a provider. | |
| serialNumber | Text | The serial number or any alphanumeric identifier of a particular product. When attached to an offer, it is a shortcut for the serial number of the product included in the offer. |
| shippingDetails | Indicates information about the shipping policies and options associated with an Offer. | |
| sku | Text | The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers. |
| validFrom | Date DateTime | the date and time when the offer becomes active, meaning when you can start booking, purchasing, or accepting it. Example: For the boat lease, this might be when the offer is first posted (e.g., June 1, 2010). |
| validThrough | Date DateTime | This is the date and time after which the offer can no longer be accepted. It’s the deadline to book or buy. Example: For the boat lease, this is the last moment to reserve it (e.g., July 15, 2010, at 23:59). |
| warranty | The warranty promise(s) included in the offer. |
| Property | Expected Type | description |
|---|---|---|
| additionalType | URL | An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally. |
| alternateName | Text | An alias for the item. |
| description | Text | A description of the item. |
| disambiguatingDescription | Text | A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation. |
| identifier | The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. | |
| image | URL ImageObject | An image of the item. This can be a URL or a fully described ImageObject. |
| instanceOf | Type to which this subject belongs. Use for membership in a value set (Enumeration), not inheritance. Example: K2 instanceOf mountain; volcano subClassOf mountain. | |
| mainEntityOfPage | URL CreativeWork | Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. |
| name | Text | The name of the item. |
| potentialAction | Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role. | |
| sameAs | URL | URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website. |
| subjectOf | A CreativeWork or Event about this Thing. | |
| url | URL | URL of the item. |