Vrbo API Checkpoints

This support article is under construction 👷

Please pardon the incompleteness while we work on this. We have made the article visible in the meantime because the content may be useful.

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 a Vrbo site.

Checkpoint	Property or unit level?	Minimum requirement
HasActiveSubscription	Property level	An active subscription order exists on the property, which can be PPB or PPS.
HasNotCancelledSubscriptions	Property level	When "false", this checkpoint indicates that the subscription is active and has not been cancelled.
IsActiveByOwner	Property level	Property needs to be shared in the Listings integration to go live.
IsNotInactiveByCSR	Property level	When "false", property has been inactivated by a customer service representative.
IsListingNotArchived	Property level	Property needs to be unarchived to go live.
IsNotDeleted	Property level	The listing exists (is not deleted).
IsNotInactiveByOwner	Property level	Property has not been deactivated (disabled) by the property manager.
IsNotMultiUnitListing	Property level	Property is not multi-unit; this should always be met/true because it is not possible to create a multi-unit property.
NotRegulatoryDelistRequest	Property level	When "false", regulatory requirements are missing or wrong and our regulatory team has delisted the property.
HasImages	Property level	At least six images (JPG, GIF, or PNG) are required. Resolution must be at least 1920x1080. Use the `createPropertyImage` mutation as necessary.
HasRates	Unit level	In the `<lodgingRate>` element of the Lodging Rate content (pushed to use using the Lodging Rate update service), nightly rates must be specified. Or, in the `<lodgingRateLos>` element, stay rates must be specified.
HasPropertyDetails, which relies on the following checkpoints:
HasBathroom	Unit level	At least one bathroom must be defined using the `createUnitSpaces` mutation.
HasMaxOccupancy	Property level	Use the `createProperty` or `updateProperty` mutation to create a stay policy and set maximum occupancy.
HasPropertyDescription	Property level	For all sites other than Vrbo Japan, at least 400 characters must be specified for the property description. For listings on Vrbo Japan, at least 200 characters must be specified. A maximum of 10,000 characters is allowed. Use the `createProperty` or `updateProperty` mutation.
HasPropertyHeadline	Property level	For all sites other than Vrbo Japan, at least 20 characters must be specified for the headline. For listings on Vrbo Japan, at least 10 characters must be specified. A maximum of 80 characters is allowed. Set the headline by specifying the `name` or `names` input parameter of `createProperty`.
HasPropertyType	Property level	The `type` input must be specified using the `createProperty` or `updateProperty` mutation.
HasLocation, which relies on the following checkpoints:
HasValidatedAddress	Property level	Property's `location` matches `address` as specified by the `createProperty` or `updateProperty` mutation.
HasGeoCode	Property level	Property's `location` is set by the `createProperty` or `updateProperty` mutation.
HasCompletedAddress	Property level	Property's `address` is set by the `createProperty` or `updateProperty` mutation.
HasRegistrationNumber	Unit level	If the district requires registration, registration data must be set for the unit using the `updateUnitRegistration>` mutation of the compliance capability.
HasBookingType	Property level	The booking policy (including `bookingType`) is set for the property using the `createProperty` or `updateProperty` mutation.
HasAcceptedPaymentForm	Property level	The booking policy (including `acceptedPaymentForms`) is set for the property using the `createProperty` or `updateProperty` mutation.
HasCancellationPolicy	Property level	A property's cancellation policy is set using the `createCancellationPolicyConfig` or `replaceCancellationPolicyConfig` mutation.
HasHouseRules	Property level	When defining stay policies, maximum occupancy, check-in, checkout, and minimum age (within check-in policy) must be set using the `createProperty` or `updateProperty` mutation.
HasCheckInCheckOut	Property level	When defining stay policies, check-in and checkout policies must be set using the `createProperty` or `updateProperty` mutation.

NotSHOW Property Level Per Shelby: account is set to ‘preview’ which means the PM has to go into their dashboard and select PPB plan for the listing to go live

Property-level checkpoints for Vrbo properties

The following is an alphabetized list of checkpoints may be met at the property (listing) level for properties onboarded on Vrbo:

Important: Not all checkpoints are included in every query response, and **this list may not be definitive**. Assumptions about the presence of any of these checkpoints should not be built into logic.

HasActivePPSV2Subscription - The listing has a valid subscription of type SUBSCRIPTION_V2.
HasActiveSubscription - The listing has a valid subscription and is active (though a listing may be inactive for reasons other than cancellation, such as expired subscription).
HasActiveUnit - The listing has a unit and it is enabled. However, a unit may be considered bookable by our system, though it may not actually be bookable for other reasons, such as being archived.
HasBookableUnit - The listing has units that are enabled and bookable. However, a unit may be considered bookable by our system, though it may not actually be bookable for other reasons, such as being archived.
HasMatchingListProductType - The listing's product type matches the entitlement type.
HasNotCancelledSubscriptions - If false is returned for this checkpoint, the listing subscriptions have been cancelled (though a listing may be inactive for reasons other than cancellation, such as expired subscription).
HasPendingOrActiveSubscription - The listing has a pending or active subscription.
HasSubscription - The listing has a subscription.
IsAccountNotDelinquent - If false is returned for this checkpoint, the listing has violations; to address this, outstanding balance for PPB commission needs to be paid.
IsActiveByOwner - The listing is not deactivated by the property manager.
IsListingNotArchived - If false is returned for this checkpoint, the listing is archived (archived listings are inactive, and they are not available in search of the Vrbo dashboard).
IsMerchantAccountNotRevoked - If false is returned for this checkpoint, the listing's merchant account has been revoked.
IsMinimumContentProvided - The listing has met the minimum content requirements.
IsNotDeleted - If false is returned for this checkpoint, the listing does not exist (was deleted).
IsNotInactiveByCSR - If false is returned for this checkpoint, the listing was deactivated by a customer service representative.
IsNotInactiveByOwner - If false is returned for this checkpoint, the listing was deactivated (disabled) by the property manager.
IsNotMultiUnitListing - If false is returned for this checkpoint, the property is a multi-unit property.
IsNotPpbListing - If false is returned for this checkpoint, the listing has the pay-per-booking (PPB) payment type defined.
IsNotPreviewListing - If false is returned for this checkpoint, the listing has a product type of "preview".
IsPreviewListing - The listing has a product type of "preview".
IsPropertyLive - Top-level checkpoint and "container" of all others.
IsRenewable - The listing is renewable.
IsTrustedPmListing - The listing belongs to a trusted partner.
IsUserNfmp - User is flagged as "not fair market practice".
NotRegulatoryDelistRequest - If false is returned for this checkpoint, the property was delisted by regulatory operations.

Unit-level checkpoints for Vrbo properties

The following is an alphabetized list of checkpoints may be met at unit level for properties onboarded on Vrbo: