Getting startedProperty status

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 the StatusCheckpoint 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
1query {
2 property(id: "9672235", idSource: EXPEDIA) {
3 ids {
4 id
5 idSource
6 }
7 name
8 activeStatus {
9 active
10 }
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).

1query {
2 property(id: "9672235", idSource: EXPEDIA) {
3 name
4 activeStatus {
5 active
6 statusCheckpoint {
7 name
8 lastEvaluated
9 resolutionStatus
10 checkpoints {
11 name
12 path
13 lastEvaluated
14 resolutionStatus
15 fulfilled
16 }
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.

1query {
2 property(id: "9672235", idSource: EXPEDIA) {
3 name
4 activeStatus {
5 active
6 statusCheckpoint {
7 fulfilled
8 lastEvaluated
9 checkpoints(filter: {result: FAILED}) {
10 name
11 resolutionStatus
12 fulfilled
13 }
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.

1query {
2 property(id: "9672235", idSource: EXPEDIA) {
3 id
4 name
5 address {
6 line1
7 line2
8 city
9 country
10 postalCode
11 }
12 listings(domains: ["expedia.com"]) {
13 locale
14 url
15 }
16 }
17}