Retrieves a property’s registration information at the unit level. This is useful in confirming a unit’s (or room type's) information and determining its jurisdiction’s requirements. The API returns the registration information in our system for all active and inactive units on the property.
In this example, compliant shows whether the unit is compliant and why; include this object and its fields to understand the regulatory status of the unit. Note that the complete field is not included because it reports information at a property level and does not provide the true value for some properties.
You can then use the updateUnitRegistration mutation to update registration information for active units only.
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.
Field value used for these field types: enum, string, trilean, int,
and decimal. When the amenity type is trilean and the value is set to
true, the amenity is included on the PDP. When set to false, the amenity
definition is stored but disabled it on the PDP, similar to how amenities are
disabled using AmenityValueInput : available.
Bed types offered in the room. Vacation rentals are limited to a single bed
group with multiple bed types. Conventional lodging may have two bed groups to
represent alternatives. For example, a hotel might have a room type with 1 king
bed or 2 full beds.
Compliance status for mandatory requirements only (at the unit level) according
to the local jurisdiction's regulatory requirements. If invalid information is
provided for an optional regulatory requirement, or if regulatory information is
set in a jurisdiction that does not require regulatory information, status:
COMPLIANT is returned. For optional requirements, a warning is returned in the
warningStatus field of the updateUnitRegistration mutation's payload.
Field
Description
reason
Not nullable.
Reason why the unit is in or out of compliance. The label used for the
registration number in this string comes from the numberTypeLabel field on
the RegistrationNumberRequirement type.
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Checks the consistency of the information in our systems at the property level
to determine whether the registration information is sufficient to fulfill the
requirements of the property's district. We do not recommend including this
field in the query because it does not provide the true value for some properties.
If false is returned for a unit, you can use the Product API to identify
active units, though false may be returned for inactive units that have
incorrect regulatory information.
Compliance status for mandatory requirements only (at the unit level)
according to the local jurisdiction's regulatory requirements. If invalid
information is provided for an optional regulatory requirement, or if
regulatory information is set in a jurisdiction that does not require
regulatory information, status: COMPLIANT is returned. For optional
requirements, a warning is returned in the warningStatus field of the
updateUnitRegistration mutation's payload.
Note: We strongly recommend that you include this field in your
implementation even though it is nullable. This field provides an audit trail
for reporting purposes.
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
RegulatoryStatus
Enum
Values for regulatory status.
Name
Description
COMPLIANT
Unit meets all regulatory requirements.
COMPLIANT_ACTION_NEEDED
Unit meets requirements to remain listed but will need to provide
additional information (or other action) in order to not be delisted.
NOT_COMPLIANT
Unit does not meet all regulatory requirements and cannot be shown.
NOT_COMPLIANT_ACTION_NEEDED
Unit is not compliant, but enforcement hasn't started yet. Action should be
taken for the listing to be compliant after enforcement date.
NOT_ALLOWED
Platform does not allow units in this jurisdiction; no actions from partner can affect status.
NONE
Unit's status cannot be determined.
String
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.
Surcharge
Object
Extra amount to charge for an extra bed.
Field
Description
amount
Amount of the surcharge. Must be defined if type is not 'Free'.
Amenities available in the unit. You can filter by amenity name or whether
it's available (active) by specifying the filters argument (type:
AmenitiesFiltersInput).
Registration information for the unit or room type. 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.
Whether to include bed type on the unit name. Not all bed combinations are
fully displayed in the room name. Some combinations are displayed as “multiple
beds” in the unit name.
Whether to include unit smoking preferences in the unit name. When
smokingPolicy is set to SMOKING_AND_NON_SMOKING and includeSmokingPolicy
is set to true, the room name will specify SMOKING only.
registration query