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.
| ID | API | Description |
|---|---|---|
id | GAR API > All Properties and Single Property | The primary property ID in the GAR API. |
ids_bhi_b2b | GAR API > All Properties and Single Property | The 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. |
hotelId | BHI B2B API: Content > Feed_5, Feed_6, Feed_7, Feed_9 and Feed_19 | The primary property ID in the new BHI B2B API, matched to a ids_bhi_b2b ID. |
propertyId | BHI B2B API > Search API | The property ID in Search API in the new BHI B2B API. |
Recommended migration steps
We recommend the following steps to ensure a seamless migration.
- Retrieve the complete list of property IDs from the GAR API: Use the All Properties API to retrieve the catalog of IDs, including the
idand theids_bhi_b2bdata. - Identify any properties currently unmapped and/or unavailable: If the
ids_bhi_b2bis 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.
- Map the properties to BHI B2B API catalogs: Using the
ids_bhi_b2bfield value(s), map the GAR property and content catalogs to the matchinghotelIdin the Content API (for example,Feed_19for 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_b2bto the new BHI B2B API >hotelIdmapping 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 Field | BHI B2B API Field Name - Feed_19 | Notes |
|---|---|---|
ids_bhi_b2b | hotelId | Property identifier to match |
name | hotelName | |
property_type | hotels.hotel.accommodationType | |
description | descriptions.description.overview | |
address.street_address | addresses.address.addressLine1 and addresses.address.addressLine2 | |
address.locality | addresses.address.city | City name |
address.region | addresses.address.state | State/province name |
address.country_code | countryId | May not be a one-to-one match. |
address.postal_code | addresses.address.postalCode | |
address.latitude | hotels.hotel.latitude | |
address.longitude | hotels.hotel.longitude | |
star_rating | hotels.hotel.starRating | |
check_in_start_time | Feed_10 > propertyId=8 & propertyName=Check-in from | Check-in time; not directly in Feed_19 (use Feed_10 > propertyId=8 & propertyName=Check-in from) |
check_out_end_time | Feed_10 > propertyId=9 & propertyName=Check-out until | Check-out time; not directly in Feed_19 (use Feed_10 > propertyId=9 & propertyName=Check-out until) |
amenities | facilities array | Amenities do not match one-to-one. The facilities array provides the hotel amenity information. |
images | pictures array | Photos 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_at | — | Use Feed_32 for BHI B2B property changes tracking |
chain | hotels.hotel.ownerId / ownerName | |
themes | — | Reach out to your Account Manager for themes data in BHI B2B API. |
Updated 2 months ago