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 PPN Hotel.Hotels Download API exposes property IDs from all related supplies associated with a 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
hotelid_ppnPPN API > BOF2.Downloads.Hotel.HotelsThe primary property ID in the PPN API.
hotelids_bhiPPN API > BOF2.Downloads.Hotel.HotelsThe property ID(s) in the new BHI B2B API that you need to map to the given PPN 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 hotelids_bhi 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 PPN API: Use the BOF2.Downloads.Hotel.Hotels API to retrieve the catalog of IDs, including the hotelid_ppn and the hotelids_bhi data. Refer to the Hotel.Hotels Download API Documentation to learn more about this API.
  2. Identify any properties currently unmapped and/or unavailable: If the hotelids_bhi 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 thehotelids_bhi field value(s), map the PPN 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 PPN 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 PPN API > hotelids_bhi to the new BHI B2B API > hotelId mapping logic.
  • Many-to-one (many PPN IDs map to the same BHI B2B ID):
    • This is expected due to the PPN API having multiple supplies for properties. This can also happen due to different mapping logics used in the PPN API vs. the BHI B2B API. For example, PPN 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 PPN property IDs to the given BHI B2B Property ID.
      • This will act as a merge of the duplicated PPN properties to the new BHI B2B property ID mapping.
      • It is important that you map all related PPN IDs to the BHI B2B Property ID to ensure comprehensive rate shopping. You may see availability of rates on both PPN IDs in the current flow, and you will see availability on the mapped BHI B2B ID to the blend of the two PPN IDs.
  • One-to-many (one PPN 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 PPN property, then catalog and shop all remaining BHI B2B property IDs as a net new supply.
      • Or map the PPN 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:
PPN API FieldBHI B2B API Field Name - Feed_19Notes
hotelids_bhihotelIdProperty identifier to match
hotel_namehotelName
hotel_typehotels.hotel.accommodationType or property_type_id?
property_descriptiondescriptions.description.overview
hotel_addressaddresses.address.addressLine1 and addresses.address.addressLine2
cityaddresses.address.cityCity name
stateaddresses.address.stateState/province name
countryaddresses.address.countryCountry name
postal_codeaddresses.address.postalCode
latitudehotels.hotel.latitude
longitudehotels.hotel.longitude
star_ratinghotels.hotel.starRating
check_inFeed_10 > propertyId=8 & propertyName=Check-in fromCheck-in time; not directly in Feed_19 (use Feed_10 > propertyId=8 & propertyName=Check-in from)
check_outFeed_10 > propertyId=9 & propertyName=Check-out untilCheck-out time; not directly in Feed_19 (use Feed_10 > propertyId=9 & propertyName=Check-out until)
amenity_codes & related BOF2.Downloads.Hotel.Amenities API datafacilities arrayAmenities do not map one-to-one. The facilities array provides the hotel amenity information.
thumbnail & BOF2.Downloads.Hotel.Photos API datapictures arrayPhotos do not map one-to-one. The pictures array provides the hotel photo information.
Reach out to your Account Manager for image tags data.
last_changed_dateUse Feed_32 for BHI B2B property changes tracking
chain_id_ppnhotels.hotel.ownerId / ownerNameThis is not a one-to-one mapping.
theme_idsReach out to your Account Manager for themes data in BHI B2B API.