Property Mapping

Overview

In your migration to the BHI B2B API, property and related content mapping is designed to be simple and low-impact. This guide provides you with the information that you need to map your existing property IDs to the BHI B2B API property IDs and present the same property content in your implementation with minimal changes.

The GAR Property APIs (All Properties and Single Property) expose property IDs for all related supplies associated with a given property, enabling partners to retrieve the full property mapping programmatically.

Property identifier definitions

You will find the following property IDs in the provided APIs, which will be important for mapping.

IDAPIDescription
idGAR API > All Properties and Single PropertyThe primary property ID in the GAR API.
ids_bhi_b2bGAR API > All Properties and Single PropertyThe property ID(s) in the new BHI B2B API that you need to map to the given GAR property. Map each ID returned in this array to the matching hotelId in BHI B2B API.
hotelIdBHI B2B API: Content > Feed_5, Feed_6, Feed_7, Feed_9 and Feed_19The primary property ID in the new BHI B2B API, matched to a ids_bhi_b2b ID.
propertyIdBHI B2B API > Search APIThe property ID in Search API in the new BHI B2B API.

Recommended migration steps

We recommend the following steps to ensure a seamless migration.

  1. Retrieve the complete list of property IDs from the GAR API: Use the All Properties API to retrieve the catalog of IDs, including the id and the ids_bhi_b2b data.
  2. Identify any properties currently unmapped and/or unavailable: If the ids_bhi_b2b is returned null for a property, that property may be unavailable in the BHI B2B API, or may not yet be mapped at the moment.
📘

Note:

Properties can be incrementally supported in the future and we will keep you updated.

  1. Map the properties to BHI B2B API catalogs: Using theids_bhi_b2b field value(s), map the GAR property and content catalogs to the matching hotelId in the Content API (for example, Feed_19 for Full Hotel Information) in the new BHI B2B API.

Key information to ensure smooth mapping migration

Mapping use cases

  • Property mapping between the current GAR API and the new BHI B2B API will often have a many-to-one property ID mapping, but in some cases, there can be one-to-many mappings. Refer to the following guidelines on how you can handle these mapping scenarios when you are using the GAR API > ids_bhi_b2b to the new BHI B2B API > hotelId mapping logic.
  • Many-to-one (many GAR IDs map to the same BHI B2B ID):
    • This is expected due to the GAR API having multiple supplies for properties. This can also happen due to different mapping logics used in the GAR API vs. the BHI B2B API. For example, GAR may consider each separate apartment in a Non-Hotel-Accommodation building as a different property, while BHI B2B may consider the Non-Hotel-Accommodation building as a single property with different rooms.
    • To handle mapping in this scenario;
      • Map all of the GAR property IDs to the given BHI B2B Property ID.
      • This will act as a merge of the duplicated GAR properties to the new BHI B2B property ID mapping.
      • It is important that you map all related GAR IDs to the BHI B2B Property ID to ensure comprehensive rate shopping. You may see availability of rates on both GAR IDs in the current flow, and you will see availability on the mapped BHI B2B ID to the blend of the two GAR IDs.
  • One-to-many (one GAR ID may map to many BHI B2B IDs):
    • This is a less common use case and may occur due to duplicate properties in the BHI B2B catalog.
    • To handle mapping in this scenario, you can either;
      • (Recommended) Pick and map the first BHI B2B property ID to the corresponding GAR property, then catalog and shop all remaining BHI B2B property IDs as a net new supply.
      • Or map the GAR property ID and the multiple BHI B2B property IDs to a single record in your system and shop all properties.
      • Or utilize your own mapping logic to determine if the multiple BHI B2B property IDs are duplicates in your system.

Content coverage

  • The new BHI B2B API provides coverage of property content for the standard property-level attributes (e.g., name, address, descriptions, amenities, images, etc).
  • Important property content field mapping:
GAR API FieldBHI B2B API Field Name - Feed_19Notes
ids_bhi_b2bhotelIdProperty identifier to match
namehotelName
property_typehotels.hotel.accommodationType
descriptiondescriptions.description.overview
address.street_addressaddresses.address.addressLine1 and addresses.address.addressLine2
address.localityaddresses.address.cityCity name
address.regionaddresses.address.stateState/province name
address.country_codecountryIdMay not be a one-to-one match.
address.postal_codeaddresses.address.postalCode
address.latitudehotels.hotel.latitude
address.longitudehotels.hotel.longitude
star_ratinghotels.hotel.starRating
check_in_start_timeFeed_10 > propertyId=8 & propertyName=Check-in fromCheck-in time; not directly in Feed_19 (use Feed_10 > propertyId=8 & propertyName=Check-in from)
check_out_end_timeFeed_10 > propertyId=9 & propertyName=Check-out untilCheck-out time; not directly in Feed_19 (use Feed_10 > propertyId=9 & propertyName=Check-out until)
amenitiesfacilities arrayAmenities do not match one-to-one. The facilities array provides the hotel amenity information.
imagespictures arrayPhotos do not match one-to-one. The pictures array provides the hotel photo information.
Reach out to your Account Manager for image tags data.
content_updated_atUse Feed_32 for BHI B2B property changes tracking
chainhotels.hotel.ownerId / ownerName
themesReach out to your Account Manager for themes data in BHI B2B API.

Did this page help you?