Documentation

ReferenceCompliance

district query

Retrieves regulatory requirements for the specified property as defined by its jurisdiction. The query can return all regulatory information in our system for the jurisdiction, such as allowed property types, registration numbers, and minimum and maximum length-of-stay requirements.

For an explanation of how to read the query response, refer to Retrieving regulatory requirements.

Syntax

1query { 
2  property(id: String!, idSource: IdSource) { 
3    district(locale: String): District 
4  } 
5}

Example

The GraphQL explorer is provided for the example below. For more examples, refer to the Introduction.

Use this interactive explorer to get comfortable with the sample query.

A test property ID is passed into the explorer for use by the query; its test data is returned.
Click Run Query to execute the query in the explorer on the page. You can modify the query to retrieve the desired fields, and the explorer provides a list of fields when you start typing.
Click API Explorer to launch the full explorer in another tab/window, which provides syntax highlighting, schema introspection, real-time error highlighting, and auto-completion, among other things.

Response

Arguments

Name Description

Name	Description
`id`	Required. Expedia ID (EID) or supplier ID (external ID in the partner's system) of the property. If specifying the supplier ID for a Vrbo property, specify the ID in this format: `systemId/advertiserId/listingExternalId`. For direct PM integrations, the value of `systemId` is “PM”. For PMS integrations, this value represents the PMS originating the request. If you are unsure of your system ID, contact your Engagement Manager or Technical Relationship Manager. Type: String
`idSource`	Source system of the ID. EXPEDIA is the default value. Type: IdSource

id

Required.

Expedia ID (EID) or supplier ID (external ID in the partner's system) of the property.

If specifying the supplier ID for a Vrbo property, specify the ID in this format: systemId/advertiserId/listingExternalId.

For direct PM integrations, the value of systemId is “PM”.
For PMS integrations, this value represents the PMS originating the request.

If you are unsure of your system ID, contact your Engagement Manager or Technical Relationship Manager.

Type: String

idSource

Source system of the ID. EXPEDIA is the default value.

Type: IdSource

Types

Name

Type

AdditionalDataRequirement

Object

Additional parameters to meet onboarding requirements.

Field	Description
`group`	Grouping to which the field belongs, for UI layout purposes. Type: String
`groupLocalized`	Description of the group, to be localized. Type: String
`isOptional`	Whether the data is optional. Type: String
`key`	Not nullable. Field name for the information to be captured. Type: String
`keyLocalized`	Description of the key, to be localized. Type: String
`subtype`	Subtype of data. Type: String
`subtypeLocalized`	Description of the subtype, to be localized. Type: String
`type`	Type of data. Type: String
`typeLocalized`	Description of the type, to be localized. Type: String

Boolean

The Boolean scalar type represents true or false.

District

Object

District regulatory information.

Field	Description
`description`	Description of the district regulation. Type: String
`id`	Not nullable. District ID (such as Miami Beach). Type: String
`legalPropertyTypes`	Not nullable. List of legal property types. Type: Array of LegalPropertyType
`localizedName`	Localized district name that can be used for display. Type: String
`nativeLocale`	Four-character locale code (language and country codes) of property's local district (such as fr_FR for a property in France). Type: String
`referenceUrls`	URL to jurisdiction regulation information. Type: Array of String
`registrationRequired`	Not nullable. Whether registration is required by the jurisdiction. This is based on the geo code of the property’s address, not the property type (for example, registration may be required for a hotel but not a vacation rental in a specific area). Type: Boolean
`requirements`	Jurisdiction regulations that the partner needs to meet to comply with onboarding to Expedia. Type: Array of JurisdictionRequirement

Exemption

Object

Exemption to jurisdiction requirements.

Field	Description
`category`	Exemption type. Type: ExemptionCategory
`description`	Description of the exemption. Type: String

ExemptionCategory

Enum

Exemption types.

Name	Description
`MAX_NIGHT_CAP`

IdSource

Enum

Source of a given ID.

Name	Description
`EXPEDIA`	Expedia is the source of the ID.
`SUPPLIER`	Connectivity provider or lodging partner is the source of the ID. This value is not supported for use in `promotions`.
`VRBO`	Unsupported.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

JurisdictionRequirement

Object

Jurisdiction regulations that the partner needs to meet to comply with onboarding to Expedia.

Field	Description
`additionalDataRequirements`	Additional required regulation data by jurisdiction, such as license holder name or property address. Type: Array of AdditionalDataRequirement
`exemptions`	Exemptions of a requirement under certain conditions. Type: Array of Exemption
`isVacationRental`	Whether this regulatory category is a vacation rental. Type: Boolean
`maxNightCap`	Maximum number of nights allowed by the jurisdiction. null means no requirement. Type: MaxNightCap
`minStayNights`	Not nullable. Minimum number of stay nights for this category (default is 1). Type: Int
`qualifiedPropertyTypes`	Regulation requirement that Expedia and Vrbo support. Type: Array of LegalPropertyType
`registrationNumberRequirements`	List of registration number requirements. Type: Array of non nullable RegistrationNumberRequirement
`regulatoryCategory`	Property regulatory category where the registration number requirements apply. Type: RegulatoryCategory
`regulatoryCategoryLabel`	Localized string of the regulatory category. Type: String

LegalPropertyType

Object

Property type for the district. This type provides what’s possible for the district. Then, qualifiedPropertyTypes indicates the type and subtype at the unit level. If subtype is set for the property, you should use both type and subtype.

Field	Description
`subtype`	Legal property subtype, applicable for residences, such as primary home or secondary home. (This field provides the value that is specified in the `registration:details:regulatorySubType` field of the `updateUnitRegistration` mutation.) Type: String
`type`	Legal property type, such as hotel, bed and breakfast, residence, etc. (This field provides the value that is specified in the `registration:details:regulatoryType` field of the `updateUnitRegistration` mutation.) Type: String

MaxNightCap

Object

Maximum night cap parameters for the jurisdiction.

Field	Description
`annualLimit`	Annual night cap. Type: Int
`isEnforced`	Whether the cap is enforced (or just informational). Type: Boolean

Property

Object

Representation of a physical property, including its units, reservations, and promotions.

Field	Description
`district`	Regulatory requirements and parameters that apply to the property. You can specify the `locale` argument to retrieve the results in a specific language; specify the four-letter ISO code for language. Use a four-character code that indicates language and region, such as fr_FR for French in France. Type: District

Purpose

Enum

Purpose of the requirement.

Name	Description
`DATA_SHARING`

RegistrationNumberRequirement

Object

Registration requirement.

Field	Description
`allowPendingRegistrations`	Not nullable. Whether properties with pending registration applications are allowed to list. Type: Boolean
`format`	Example(s) of the registration requirement's value. Type: String
`isExpirationDateRequired`	Not nullable. Whether an expiration date must be set for the registration requirement. Type: Boolean
`isOptional`	Not nullable. Whether the jurisdiction requires registration information. Be aware that if a jurisdiction requires a property owner to apply for a permit but there is no requirement for us to collect or display the permit, this field will be set to `true` (indicating that registration information is optional). Type: Boolean
`localName`	Localized display name of the registration requirement as shown in the Vrbo dashboard or Expedia Partner Central (such as みんぱく for Japan Minpaku). Type: String
`numberType`	Registration requirement type. (This field provides the value that must be specified in the `registration:details:registrationRecords:registrationNumberType` field of the `updateUnitRegistration` mutation.) Type: RegistrationNumberType
`numberTypeLabel`	Label used to describe the registration requirement in the Vrbo dashboard and Expedia Partner Central. Type: String
`purpose`	Purpose of this requirement, if other than common regulatory validations. Type: Purpose
`regex`	Regular expression used to validate the syntax of the registration requirement's value. Type: String
`thirdPartyValidation`	Information about external validation parameters, if required for the registration requirement. Type: ThirdPartyValidation
`url`	URL of a page that provides information about the registration requirement. Type: String

RegistrationNumberType

Enum

Types of registration numbers (licenses).

Name	Description
`LICENSE_NUMBER`
`LICENSE_ID`
`PARTIAL_TAX_ID`
`REGISTRATION_NUMBER`
`BUSINESS_LICENSE_NUMBER`
`OPERATOR_LICENCE_ID`
`OPERATOR_LICENSE_ID`
`BUSINESS_TAX_ID`
`RESORT_TAX_ID`
`SHORT_TERM_RENTAL_LICENSE`
`PERMIT_NUMBER`
`PLANNING_NUMBER`
`HOTEL_LICENSE`
`IS_IN_ZONING_PLAN`
`IS_PROFESSIONAL_HOST`
`TOURIST_DEVELOPMENT_TAX_ACCOUNT_NUMBER`
`HOME_SHARING_NUMBER`
`HOME_SHARING_PERMIT_NUMBER`
`CERTIFICATE_OF_USE_NUMBER`
`GENERAL_EXCISE_TAX_ID`
`TRANSIENT_ACCOMMODATIONS_TAX_ID`
`REGISTRATION_CERTIFICATE_NUMBER`
`PROPERTY_REGISTRY_NUMBER`
`SPECIAL_OPERATION_SIGN`
`TRANSIENT_REGISTRATION_NUMBER`
`PROVINCIAL_TOURIST_IDENTIFICATION_CODE`
`PARCEL_NUMBER_TAX_MAP_KEY`
`BUSINESS_TAX_RECEIPT_NUMBER`
`OPERATOR_LICENSE_NUMBER`
`OPERATOR_PERMIT`
`OWNER_PERMIT`
`TAX_IDENTIFICATION_NUMBER`
`MA_REGISTRATION_CERTIFICATE_NUMBER`
`BOSTON_REGISTRATION_NUMBER`
`OWNER_NAME`
`CADASTRAL_REFERENCE`
`OWNER_IS_CITIZEN`
`OWNER_ID`
`ZIPCODE`
`HOUSE_NUMBER`
`IS_CONDITION`
`ENTITY_TYPE`
`IS_TRADED`
`IS_GOVERNMENT_ENTITY`
`IS_ADDRESS_IN_EU`
`IS_RESIDENCE_IN_EU`
`LEGAL_ADDRESS`
`ISSUED_TAX_ID`
`PERMANENT_ESTABLISHMENT_COUNTRY`
`BUSINESS_REGISTRATION_NUMBER`
`LAND_REGISTRATION_NUMBER`
`BIRTH_DATE`
`IS_VAT_REGISTERED`
`VAT_ID`
`DATE`
`CITIZEN_ID`
`FOREIGN_ID`
`NEIGHBORHOOD_NAME`
`NATIONAL_ADDRESS_NUMBER`
`FLOOR_SYSTEM_NUMBER`
`JOURNAL_NUMBER`
`IS_ZONING_LAW_APPLIED`
`APPLICATION_NUMBER`
`ISSUANCE_DATE`

RegulatoryCategory

Enum

Category values for regulatory categories. Most of jurisdiction districts only allow for two categories, HOTEL and VACATION_RENTAL, though more values GRAPHQL_VALIDATION_FAILED are provided to satisfy local government requirements.

Name	Description
`HOTEL`
`BED_AND_BREAKFAST`
`HOTEL_OR_BNB`
`PRIMARY_HOME`
`PRIMARY_HOME_WITH_EXCEPTION`
`SECONDARY_HOME`
`VACATION_RENTAL`
`LONG_TERM_ONLY`
`SHORT_TERM_RENTAL`
`MINPAKU`
`SIMPLE_LODGING`
`EVENT`
`SPECIAL`
`NO_LICENSE`
`HOTEL_RYOKAN`
`RYOKAN`
`PRIMARY_OR_SECONDARY`
`TRANSIENT_OCCUPANCY_RESIDENTIAL_STRUCTURE`
`MOTEL`
`HOME_SHARING_NUMBER`
`VACATION_RENTAL_OTHER`
`HOSTEL`
`CAMPING_SITES`
`RURAL_LODGING`
`APARTMENT_HOTEL`

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

ThirdPartyValidation

Object

Third-party validation information.

Field	Description
`attributes`	Attributes used to validate the registration number as provided by the third-party. Type: Array of String
`required`	Not nullable. Whether third-party validation is required. Type: Boolean

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Compliance

district query

Syntax

Example

Arguments

Types

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Compliance

district queryCopy link

Syntax

Example

Arguments

Types

district query