Documentation / Guides
Hotel mapping
Match a supplier's hotel record to one Plexe hotel ID, and look hotels up by supplier ID.
Match a hotel
Send one supplier hotel record to POST /v1/hotels/find-match with your API key; it is the same key as for room mapping. Only name is required; every other field you send makes the match more reliable, coordinates and street address above all.
curl https://sandbox.plexe.ai/v1/hotels/find-match \
-H "Authorization: Bearer $PLEXE_KEY" -H "Content-Type: application/json" \
-d '{"name": "Hadleys Hotel", "address1": "34 Murray St", "city": "Hobart",
"postalCode": "7000", "countryCode": "AU", "lat": -42.884, "lon": 147.3279}'
Fields: name, address1, address2, city, state, postalCode, countryCode (ISO alpha-2; alpha-3 and UK are accepted), lat, lon, phones, emails, website, chain, brand, starRating, propertyType, and topK (1 to 10, default 5).
The response gives decision, hotelId when the decision is a match, and up to topK ranked candidates, each with its hotelId, score, a short hotel summary and the reasons behind the score. issues lists data-quality problems found in the record you sent.
Look up hotels
GET /v1/hotels/{hotelId} returns one Plexe hotel: its name, address, coordinates, stars, chain and brand, chosen from its supplier records, and supplierRecords, every supplier hotel ID mapped to it.
GET /v1/hotel-mappings/{source}/{sourceId} returns the Plexe hotel for a supplier's own hotel ID, for example /v1/hotel-mappings/HotelBeds/196260. Sources in the index: DOTW, GRNConnect, HotelBeds, RateHawk, Restel and HyperGuestDirect.
POST /v1/hotels/validate checks a record for data-quality problems without matching it and without using quota.
Read the decision
- match: one Plexe hotel clearly fits;
hotelIdis set. - review: a likely hotel exists, but the evidence is not conclusive: two hotels score highly, the brands differ (a rebrand or a neighbouring property), or the score falls between the thresholds. Check the candidates before linking.
- new: no hotel in the index fits; the record describes a hotel the index does not have.
Scores are calibrated probabilities that the two records describe the same building. Hard rules override them: for example, records more than 25 km apart with no matching address or phone are never the same hotel.
The hotel index
Matching runs against a read-only index of 155,396 supplier records clustered into 64,193 Plexe hotels across 234 countries. Hotel IDs are Plexe's own. No request changes the index, so your calls never move another account's hotels and theirs never move yours.
Records without coordinates, or with a geocode kilometres off, can still match on phone, website, email or street address. A record for a hotel the index does not have returns new.
Limits
Matches and lookups count toward the same daily quota as room mapping; validation does not. The index loads for about 30 seconds after each deploy; meanwhile the endpoints answer 503 and GET /v1/hotels/status reports loading.