Intro to property statusCopy link

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 property query reference for details.

If you are unfamiliar with GraphQL concepts, such as queries and mutations, read this overview to learn more.

Limitations

Be aware of these as you integrate the property status capability:

• 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).

Checkpoints

Fulfilled and missing content requirements ("checkpoints") can be retrieved using the property query. This section lists the checkpoints that may be returned.

Minimum content requirements

The following is a list of checkpoints that correspond to minimum content requirements, which must be met for a property to go live on an Expedia site.

Checkpoints for Expedia properties

The following is an alphabetized list of checkpoints may be met for properties onboarded on Expedia:

• BEXHasPropertyOnboarded - Relies on the following checkpoints:
  • HasActiveImages - At least six images were provided
  • HasActiveRoom - At least one room type has been created
  • HasAddress - Relies on the following checkpoints:
    • HasAddressLine1
    • HasAddressLine2
    • HasCity
    • HasCountry
    • HasPostalCode
    • HasProvince
    • HasValidatedAddress
  • HasAmenities - Relies on these checkpoints:
    • HasBathroomType
    • HasBreakfast (for conventional lodging only)
    • HasBuildingFeatures
    • HasCheckInCheckOut
    • HasGuestFacilitiesAndServices
    • HasInternet
    • HasKitchen (for vacation rentals only)
    • HasKitchenFeatures (for vacation rentals only)
    • HasMandatoryFeesFacilitiesAndServices (for vacation rentals only)
    • HasParkingTransport
    • HasPaymentMethod
    • HasPets
    • HasPool
    • HasRoomLayout
    • HasMandatoryFees
  • HasBathroomCount - Number of bathrooms were specified
  • HasBedroomCount - Number of bedrooms were specified
  • HasBusinessModel - Business model is set
  • HasCheckInInstructions - Whether text specified in the Property API's SPECIAL_CHECKIN_INSTRUCTIONS field has been moderated, if text is specified (special instructions are optional)
  • HasContact - At least a contact's first name, last name, and email address are provided
  • HasCurrencyCode - A currency code has been provided
  • HasInventory - Property has availability
  • HasLatLong- Latitude and longitude are provided
  • HasPhone- Property phone number is provided
  • HasPropertyName- Property name is provided
  • HasPropertyTaxes - Relies on these checkpoints:
    • HasLodgingTax
    • HasTaxEntityName
    • HasTaxId
    • IsRegisteringTaxId
    • IsTaxIdValid
  • HasRegulatory- Regulatory records are provided, if required
  • HasStructureType- Structure (property) type is set
• BEXHasStopSellDisabled - No external services have set stop-sell on the property. This checkpoint is generated internally and cannot be updated by the partner.
• BEXPropertyIsEnabledPredicate - Top-level checkpoint and "container" of all others.
• HasProviderConfigured - An active provider exists for the property. This checkpoint is generated internally by Expedia based on internal processes; it cannot be updated by the partner. Contact your Technical Relationship Manager if you have issues with this checkpoint.
• IsNotPCOOnboarded - The property has not completed the prelive step of Partner Central Onboarding. If this is fulfilled, IsPCOPublishSubmitted is not required. This checkpoint is generated internally and cannot be updated by the partner, and it is not applicable for properties that were onboarded using the API.
• IsPCOOnboarded - The property has completed the prelive step of Partner Central Onboarding, which determines if the IsPCOPublishSubmitted checkpoint is required. This checkpoint is generated internally and cannot be updated by the partner, and it is not applicable for properties that were onboarded using the API.
• IsPCOPublishSubmitted - The partner has clicked the "publish" button at the end of Partner Central Onboarding. This checkpoint is generated internally and cannot be updated by the partner.

Minimum certification requirements

To adopt the property status capability, you must successfully complete end-to-end certification with Expedia Group teams. Specifically, you must be able to retrieve property information from our systems, including the following:

• Status (active or inactive) of a property on the Expedia platform.
• Fulfilled and missing content requirements (referred to as "checkpoints"); see above

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      addressLines
7      locality
8      countryCode
9      postalCode
10    }
11    listings(domains: ["expedia.com"]) {
12      locale
13      url
14    }
15  }
16}