Intro to property status
Limited Availability: At this time, this GraphQL API capability is available to pilot partners only. If you are interested in this feature, contact your Expedia Technical Relationship Manager.
The property status capability is provided by the Lodging Supply GraphQL API, and it enables Expedia and Vrbo partners to retrieve property information from our systems, including the following:
- Status (active or inactive) of a property on the Expedia platform.
- Point-of-sale URLs of the property's listings on the Expedia platform.
- Fulfilled and missing content requirements (referred to as "checkpoints"). Refer to the
name
field on theStatusCheckpoint
type for a complete list.
Refer to the property query reference for details. If you are unfamiliar with GraphQL concepts, such as queries and mutations, read this overview to learn more.
Download the launch kit here.
Limitations
Be aware of these as you integrate the property status capability:
- If a property was first onboarded onto Expedia, only Expedia checkpoints are returned by the API even if the property is distributed to Vrbo. Similarly, only Expedia listing URLs are returned. If a property was onboarded onto Vrbo, only Vrbo checkpoints are returned.
- Property status resources are accessible only after property creation is completed in our systems. For properties that are newly onboarded and set up using Property API, this API capability can only return information after the OnboardingSucceeded status is reached.
- Not all checkpoints are included in every response when checkpoints are requested because not all checkpoints apply to all properties. The list of documented checkpoints may change over time, therefore assumptions about the presence of any of the checkpoints should not be built into logic.
- Property updates that are made to fulfill checkpoints may take up to five hours to reflect in the query results.
- The rate limit is currently set to five transactions per second (TPS).
Retrieving status and IDs
Use this query to determine whether an Expedia property is active and to retrieve its IDs. An Expedia property is inactive if one of these conditions is true:
- Payment issues or overdue invoices
- Compliance issues due to regulatory or tax mandates
- Recontracting or change of ownership
- Incomplete onboarding
- Renovations
- Request
- Response
1query {2 property(id: "9672235", idSource: EXPEDIA) {3 ids {4 id5 idSource6 }7 name8 activeStatus {9 active10 }11 }12}
Retrieving all content checkpoints
Use this query to retrieve the content checkpoints (found and fulfilled content requirements) for a property. Note the lastEvaluated
field, which indicates when the checkpoint was last evaluated (checkpoints are evaluated every five hours).
- Request
- Response
1query {2 property(id: "9672235", idSource: EXPEDIA) {3 name4 activeStatus {5 active6 statusCheckpoint {7 name8 lastEvaluated9 resolutionStatus10 checkpoints {11 name12 path13 lastEvaluated14 resolutionStatus15 fulfilled16 }17 }18 }19 }20}
Determining missing content
Use this query to determine why a property is inactive and not displayed on Expedia sites. It retrieves the checkpoints that are unfulfilled.
- Request
- Response
1query {2 property(id: "9672235", idSource: EXPEDIA) {3 name4 activeStatus {5 active6 statusCheckpoint {7 fulfilled8 lastEvaluated9 checkpoints(filter: {result: FAILED}) {10 name11 resolutionStatus12 fulfilled13 }14 }15 }16 }17}
Retrieving location and listing URLs
Use this query to retrieve a property's address and listing URLs on the Expedia and Vrbo platforms.
- Request
- Response
1query {2 property(id: "9672235", idSource: EXPEDIA) {3 id4 name5 address {6 line17 line28 city9 country10 postalCode11 }12 listings(domains: ["expedia.com"]) {13 locale14 url15 }16 }17}