Documentation

ReferenceProduct management

createUnit mutation

Creates a unit (room type), including all of its features, and associates it with a property.

Note: Bed groups (bedGroups) is defined at the unit level. However, if unit spaces are defined for the unit, bedGroups is ignored.

Syntax

1mutation {
2  createUnit(input: CreateUnitInput!): CreateUnitPayload
3}

Examples

Creating a unit without amenities

This example creates a unit with one bedroom that provides an option for a two full beds or a king bed.

Request
Response

1mutation {
2  createUnit(
3    input: {
4      clientMutationId: "123456"
5      supplierUnitId: "room123"
6      propertyId: "15240094"
7      ageCategories: [
8        { category: "ADULT", minAge: 18 }
9        { category: "CHILD_A", minAge: 1 }
10      ]
11      area: { 
12        unit: SQUARE_FEET, 
13        value: 350 
14      }
15      bedGroups: [
16        { beds: [{ quantity: 1, size: "King", type: "KingBed" }] }
17        { beds: [{ quantity: 2, size: "Full", type: "FullBed" }] }
18      ]
19      extraBeds: [
20        {
21          quantity: 3
22          size: "FULL"
23          surcharge: { amount: "10.01", type: "PER_DAY" }
24          type: "ROLLAWAY_BED"
25        }
26      ]
27      maxOccupancy: { adults: 2, children: 3, total: 5 }
28      nameConfig: {
29        attributes: {
30          unitType: "SUITE"
31          unitClass: "CITY"
32          includeBedType: false
33          bedroomDetails: "TWO_BEDROOMS"
34          location: ""
35          view: "CITY_VIEW"
36          featuredAmenity: ""
37          includeSmokingPolicy: false
38          accessibility: {
39            includeAccessibility: false
40            accessibilityTypeOverride: ""
41          }
42          customLabel: "Product_Management_Example"
43        }
44      }
45      smokingPolicy: SMOKING_AND_NON_SMOKING
46    }
47  ) {
48    clientMutationId
49    unit {
50      id
51      propertyId
52      ids {
53        id
54        idSource
55      }
56      ageCategories {
57        category
58        minAge
59      }
60      area {
61        value
62        unit
63      }
64      bedGroups {
65        beds {
66          type
67          size
68          quantity
69        }
70      }
71      extraBeds {
72        quantity
73        size
74        surcharge {
75          amount
76          type
77        }
78        type
79      }
80      maxOccupancy {
81        adults
82        children
83        total
84      }
85      nameConfig {
86        attributes {
87          accessibility {
88            includeAccessibility
89            accessibilityTypeOverride
90          }
91          bedroomDetails
92          customLabel
93          featuredAmenity
94          includeBedType
95          includeSmokingPolicy
96          location
97          unitClass
98          unitType
99          view
100        }
101        value
102      }
103      rateThresholds {
104        net {
105          maxAmount
106          minAmount
107          source
108        }
109        sellLar {
110          maxAmount
111          minAmount
112          source
113        }
114      }
115      smokingPolicy
116    }
117  }
118}

Creating a unit with amenities

This example creates a unit with one bedroom with two beds.

Request
Response

1mutation {
2  createUnit(
3    input: {
4      clientMutationId: "123456"
5      propertyId: "15240094"
6      supplierUnitId: "room123"
7      ageCategories: [
8        { category: "ADULT", minAge: 18 }
9        { category: "INFANT", minAge: 1 }
10      ]
11      bedGroups: [ 
12        { 
13          beds: [ 
14            { quantity: 1, size: "Queen", type: "QueenBed" } 
15            { quantity: 1, size: "Full", type: "FullBed" } 
16          ] 
17        } 
18      ] 
19      amenities: [
20        {
21          key: "wifi-in-unit"
22          value: {
23            available: true
24            fields: [
25              {
26                key: "description"
27                value: {
28                  textValue: [
29                    { locale: "en-US", value: "This is Wifi Items" }
30                  ]
31                  value: null
32                }
33              }
34              {
35                key: "speed"
36                value: { feeValue: null, textValue: null, value: "25_MBPS" }
37              }
38              {
39                key: "fee"
40                value: {
41                  feeValue: { type: FREE }
42                  textValue: null
43                  value: null
44                }
45              }
46            ]
47          }
48        }
49      ]
50      nameConfig: {
51        attributes: {
52          unitType: "ROOM"
53          unitClass: "CITY"
54          includeBedType: false
55          bedroomDetails: "TWO_BEDROOMS"
56          location: ""
57          view: "CITY_VIEW"
58          featuredAmenity: ""
59          includeSmokingPolicy: false
60          accessibility: {
61            includeAccessibility: false
62            accessibilityTypeOverride: ""
63          }
64          customLabel: "Product_Management_Example"
65        }
66      }
67      smokingPolicy: SMOKING_AND_NON_SMOKING
68    }
69  ) {
70    clientMutationId
71    unit {
72      id
73      propertyId
74      ids {
75        id
76        idSource
77      }
78      ageCategories {
79        category
80        minAge
81      }
82      area {
83        value
84        unit
85      }
86      bedGroups {
87        beds {
88          type
89          size
90          quantity
91        }
92      }
93      extraBeds {
94        quantity
95        size
96        surcharge {
97          amount
98          type
99        }
100        type
101      }
102      maxOccupancy {
103        adults
104        children
105        total
106      }
107      nameConfig {
108        attributes {
109          accessibility {
110            includeAccessibility
111            accessibilityTypeOverride
112          }
113          bedroomDetails
114          customLabel
115          featuredAmenity
116          includeBedType
117          includeSmokingPolicy
118          location
119          unitClass
120          view
121          unitType
122        }
123        value
124      }
125      rateThresholds {
126        net {
127          maxAmount
128          minAmount
129          source
130        }
131        sellLar {
132          maxAmount
133          minAmount
134          source
135        }
136      }
137      smokingPolicy
138      amenities {
139        key
140        value {
141          available
142          fields {
143            key
144            type
145            value {
146              value
147              feeValue {
148                type
149              }
150              measurementValue {
151                unitOfMeasure
152                value
153              }
154            }
155          }
156        }
157      }
158    }
159  }
160}

Arguments

Name	Description
`input`	Required. Type: CreateUnitInput

Types

Name

Type

AcknowledgementRecord

Object

Acknowledgement record for a bookable unit.

Field	Description
`acknowledgementType`	Type of acknowledgement record. Type: AcknowledgementType
`id`	ID of the acknowledgement record. Type: String
`lastUpdated`	Date when the acknowledgment record was last updated. Type: String

AcknowledgementType

Enum

Acknowledgement type values.

Name	Description
`PLATFORM`
`LTR_POLICY`
`PLATFORM_ACK`
`PLATFORM_ACK_STATEMENT`
`PLATFORM_ATTESTATION`
`PLATFORM_ATTESTATION_LEGAL`
`PLATFORM_ATTESTATION_LINK`
`PLATFORM_ATTESTATION_NEVADA`
`PLATFORM_ATTESTATION_VER`
`PLATFORM_CERTIFY`
`PLATFORM_COMPLY`
`PLATFORM_JAPAN`
`PLATFORM_LEGAL`
`PLATFORM_READ`

AmenitiesFiltersInput

InputObject

Filter for results based on amenity availability or name.

Field	Description
`available`	Whether the results should include available amenities. Type: Boolean
`keys`	Amenities name on which to filter results. Type: OneOfStringFilterInput

Amenity

Object

Key-value pair that defines the amenity.

Field	Description
`key`	Not nullable. Amenity name. Type: String
`value`	Not nullable. Amenity attributes. Type: AmenityValue

AmenityField

Object

Details about the amenity attribute.

Field	Description
`key`	Not nullable. Attribute name. Type: String
`type`	Not nullable. Attribute value's type. Type: String
`value`	Not nullable. Attribute value. Type: AmenityFieldValue

AmenityFieldFeeType

Enum

Fee type values for amenities.

Name	Description
`FREE`
`SPECIFIC_AMOUNT`
`UNSPECIFIED_AMOUNT`

AmenityFieldFeeValue

Object

Fee type of an amenity.

Field	Description
`type`	Not nullable. Fee type of an amenity. Type: AmenityFieldFeeType

AmenityFieldFeeValueInput

InputObject

Fee type of an amenity.

Field	Description
`type`	Not nullable. Fee type of an amenity. Type: AmenityFieldFeeType

AmenityFieldInput

InputObject

Name and value of an amenity.

Field	Description
`key`	Not nullable. Amenity name. Type: String
`value`	Amenity value. Type: AmenityFieldValueInput

AmenityFieldMeasurementValue

Object

Amenity measurement value and unit.

Field	Description
`unitOfMeasure`	Not nullable. Type of measurement. Type: String
`value`	Not nullable. Value (size). Type: String

AmenityFieldMeasurementValueInput

InputObject

Amenity measurement value and unit.

Field	Description
`unitOfMeasure`	Not nullable. Type of measurement. Type: String
`value`	Not nullable. Value (size). Type: String

AmenityFieldValue

Object

Amenity field value.

Field	Description
`feeValue`	Fee value; used for field type `fee`. Allowed values include FREE and UNSPECIFIED_AMOUNT. Type: AmenityFieldFeeValue
`measurementValue`	Measurement value. Type: AmenityFieldMeasurementValue
`textValue`	Text value; used for field type `text`. Type: Array of non nullable LocalizedString
`value`	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`. Type: String

AmenityFieldValueInput

InputObject

Amenity field value.

Field	Description
`feeValue`	Fee value; used for field type `fee`. Allowed values include FREE and UNSPECIFIED_AMOUNT. Type: AmenityFieldFeeValueInput
`measurementValue`	Measurement value. Type: AmenityFieldMeasurementValueInput
`textValue`	Text value; used for field type `text`. Type: Array of non nullable LocalizedStringInput
`value`	Field value used for these field types: `enum`, `string`, `trilean`, `int`, and `decimal`. Note that if this is set to `trilean`, the value must be set to `true` to include the amenity on the PDP. If value is set to `false`, the amenity definition is stored but disabled it on the PDP, similar to how amenities are disabled using `AmenityValueInput : available`. Type: String

AmenityInput

InputObject

Amenity name and value.

Field	Description
`key`	Not nullable. Amenity name. Type: String
`value`	Not nullable. Amenity field value. Note that if the amenity value type is `trilean`, the value must be set to `true` to include the amenity on the PDP. If value is set to `false`, the amenity definition is stored but disabled it on the property, similar to how amenities are disabled using `AmenityValueInput : available`. Type: AmenityValueInput

AmenityValue

Object

Amenity attributes.

Field	Description
`available`	Not nullable. Whether the amenity is available. `false` indicates that the amenity is defined but disabled (not shown to travelers). Type: Boolean
`fields`	Not nullable. Amenity attributes. Type: Array of non nullable AmenityField

AmenityValueInput

InputObject

Amenity attributes.

Field	Description
`available`	Not nullable. Whether the amenity is available. Set this to `false` to keep the definition but disable it on the property, so that it's not shown to travelers. Type: Boolean
`fields`	Amenity attributes. Type: Array of non nullable AmenityFieldInput

ApplicableRegulations

Object

Additional registration information required by some districts.

Field	Description
`key`	Identifier for additional information required by the district. Type: ApplicableRegulationsKey
`value`	Value of the key required by the district. Type: String

ApplicableRegulationsKey

Enum

Regulation key values.

Name	Description
`LICENSE_DEPARTMENT_NAME`	Name of the department in the issuing government body that approved the attribute (registration number).
`LICENSE_GOVERNMENT_NAME`	Name of the government body that issued the attribute.
`LICENSE_HOLDER_NAME`	Name of the person (holder) who holds the license, which may be different from the lodging partner.
`LICENSE_HOLDER_STREET_ADDRESS_1`	Street address of the person (holder) who holds the license, which may be different from the lodging partner.
`LICENSE_HOLDER_STREET_ADDRESS_2`	Secondary street address of the person (holder) who holds the license, which may be different from the lodging partner.
`LICENSE_HOLDER_CITY`	City of the person (holder) who holds the license, which may be different from the lodging partner.
`LICENSE_HOLDER_PREFECTURE`	Prefecture of the person (holder) who holds the license, which may be different from the lodging partner.
`LICENSE_HOLDER_COUNTRY`	County of the person (holder) who holds the license, which may be different from the lodging partner.
`LICENSE_HOLDER_POSTAL`	Postal code of the person (holder) who holds the license, which may be different from the lodging partner.
`IS_VACATION_RENTAL`
`REGISTRATION_NUMBER`
`REGISTRATION_NUMBER_TYPE`

AreaUnit

Enum

Unit of measure used to indicate the size of a property's unit.

Name	Description
`SQUARE_FEET`
`SQUARE_METERS`

AttachmentType

Enum

Exemption category types.

Name	Description
`DRIVERS_LICENSE`

AttachmentUrl

Object

Registration document information.

Field	Description
`key`	Type of document referenced. Type: AttachmentType
`value`	URL of the registration document file. Type: String

BedGroup

Object

Field	Description
`beds`	Not nullable. Bed types offered in the room. Type: Array of non nullable BedType

BedGroupInput

InputObject

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. To remove a bed group from a space, send null (empty array) for bed groups, though at least one bed group must be defined for a unit. Note the following:

When bedding is not provided when a unit is created, one twin bed is defined for the unit (default).
When a space is created for a unit, bedding on the unit level is removed and will only be present within the space. Once a unit has a space defined, bedding can only be managed within the space (using updateUnitSpaces or deleteUnitSpace).

Field	Description
`beds`	Not nullable. Bed types offered in the room. Type: Array of non nullable BedTypeInput

Bedroom

Object

Details about this bedroom.

Field	Description
`bedGroups`	Not nullable. Bed types offered in the room. Type: Array of non nullable BedGroup
`id`	Not nullable. ID of this bedroom. Type: ID
`order`	Not nullable. Where the bedroom appears in the list of bedrooms (minimum value is 1). Type: Int
`text`	Text that describes this bedroom. Type: Array of non nullable Text

BedType

Object

Details about the bed.

Field	Description
`quantity`	Not nullable. Number of beds in the bed group. Type: Int
`size`	Bed size, such as FULL, KING, or TWIN. Type: String
`type`	Not nullable. Bed type, such as KINGBed or SofaBed. Type: String

BedTypeInput

InputObject

Details about the bed. Use the metadata query to retrieve the list of supported values for the input fields.

Field	Description
`quantity`	Not nullable. Number of beds in the bed group. To remove a bed from a bed group, set this value to 0. Type: Int
`size`	Bed size. Type: String
`type`	Not nullable. Bed type. Type: String

Boolean

The Boolean scalar type represents true or false.

Compliant

Object

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. Type: String
`status`	Not nullable. Whether the unit is compliant or not. Type: RegulatoryStatus

CreateAreaInput

InputObject

Unit and value of a unit's size.

Field	Description
`unit`	Not nullable. Type: AreaUnit
`value`	Not nullable. Type: Int

CreateUnitInput

InputObject

Details about the unit.

Field	Description
`ageCategories`	Not nullable. Age categories supported by the unit. Allowed values include ADULT, CHILD_A, CHILD_B, CHILD_C, CHILD_D, and INFANT. ADULT must be specified. Type: Array of non nullable UnitAgeCategoryInput
`amenities`	Amenities provided by the unit. Type: Array of non nullable AmenityInput
`area`	Unit size. Type: CreateAreaInput
`bedGroups`	Bed groups in the unit. If not provided, one twin bed is set as the default. Type: Array of non nullable BedGroupInput
`clientMutationId`	Partner's transaction ID that uniquely identifies the request, which can be used to associate requests and responses for troubleshooting purposes. This ID must be unique across requests and cannot be reused. However, if a request needs to be retried, such as because it failed or timed out, the ID provided in the original request should be used. The ID can be in any format as long as it uniquely identifies the request. Type: String
`extraBeds`	Extra bed combination (type, size, quantity, and surcharge) that the unit provides. Type: Array of non nullable ExtraBedTypeInput
`maxOccupancy`	Maximum occupancy of the unit in total and by age category. If not specified, occupancy is based on the defined bed group(s). When neither occupancy nor bed group(s) are defined, one twin bed and occupancy of 1 are the defaults. Type: CreateUnitOccupancyInput
`nameConfig`	Not nullable. Collection of elements/attributes related to the name of a unit. Type: CreateUnitNameConfigInput
`propertyId`	Not nullable. Expedia ID of the property to which the unit belongs. Type: ID
`smokingPolicy`	Not nullable. Whether the unit allows smoking. Type: UnitSmokingPolicy
`supplierUnitId`	Not nullable. Partner's ID for the unit (up to 40 characters). Type: String

CreateUnitNameAttributesInput

InputObject

Collection of attributes related to the name of a unit. -unitClass, unitType, and customLabel are always used, if provided.

Total character length for a unit name is 100 characters. If the length exceeds 100 characters, some attributes might be omitted from unit name.
Only one of includeBedType and bedroomDetails can be specified. If both are provided, only includeBedType is used.
Only two of these attributes can be stored at a time (listed here in ranking order): accessibility, includeSmokingPolicy, featuredAmenity, view, and location.

Use the metadata query for the list of supported values for each field.

Field	Description
`accessibility`	Attributes that define the unit's accessibility. Type: UnitNameAccessibilityInput
`bedroomDetails`	Details of the bedroom used to compose the name of the unit. Type: String
`customLabel`	Custom label that is used as suffix to the unit name; this is always used in the name if provided. This text is not localized. Type: String
`featuredAmenity`	Highlights a feature of the unit on its name. Type: String
`includeBedType`	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. Type: Boolean
`includeSmokingPolicy`	Whether the unit's smoking preferences should be used to compose the name of the unit. Type: Boolean
`location`	Highlights the location of the unit. Type: String
`unitClass`	Class of the unit, which is used to compose the name (such as Basic, Standard, and so on). Type: String
`unitType`	Not nullable. Type of unit, which is used to compose the name (such as Room, Apartment, Cabin, and so on). Type: String
`view`	Additional information about the view of the unit. Type: String

CreateUnitNameConfigInput

InputObject

Collection of elements/attributes related to the name of a unit.

Field	Description
`attributes`	Not nullable. Collection of attributes that can be used to build a unit name. Type: CreateUnitNameAttributesInput

CreateUnitOccupancyInput

InputObject

Maximum occupancy of the unit in total and by age category. If not specified, occupancy is based on the defined bed group(s). When neither occupancy nor bed group(s) are defined, one twin bed and occupancy of 1 are the defaults.

Field	Description
`adults`	Not nullable. Maximum number of adults that can reside in the unit; must be at least 1 and less than or equal to the total. Type: Int
`children`	Not nullable. Maximum number of children that can reside in the unit; must be less than the total. Type: Int
`total`	Not nullable. Total count of people that can reside in the unit; must be at least 1. Type: Int

CreateUnitPayload

Object

Details about the unit after it is created.

Field	Description
`clientMutationId`	Partner's transaction ID that identifies the request, which can be used to correlate with partner's transaction logs. This ID must be unique across requests and cannot be reused. Type: String
`unit`	Details about the unit. Type: Unit

Decimal

Scalar representing an arbitrary-precision and scale decimal number, serialized as a string.

ExemptionCategory

Enum

Exemption types.

Name	Description
`MAX_NIGHT_CAP`

ExtraBedType

Object

Extra bed combination (type, size, quantity, and surcharge) that the unit provides.

Field	Description
`quantity`	Not nullable. Number of extra beds. Type: Int
`size`	Not nullable. Size of the bed. Type: String
`surcharge`	Extra amount charged for the bed. Only extra beds of type 'CRIB' and 'ROLLAWAY_BED' will have a surcharge defined. Type: Surcharge
`type`	Not nullable. Type of bed. Type: String

ExtraBedTypeInput

InputObject

Extra bed combination (type, size, quantity, and surcharge) that the unit provides. Here are the allowed size/type combinations:

When type is CRIB, size must be CRIB.
When type is ROLLAWAY_BED, size can be FULL, KING, QUEEN, TWIN, or TWINXL.
When type is DAY_BED, size can be FULL, KING, QUEEN, TWIN, or TWINXL.
When type is SOFA_BED, size can be FULL, KING, QUEEN, TWIN, or TWINXL.

Field	Description
`quantity`	Not nullable. Number of extra beds. Type: Int
`size`	Not nullable. Size of the bed. Allowed values include CRIB, FULL, KING, QUEEN, TWIN, and TWIN_XL. Type: String
`surcharge`	Extra amount charged for the bed. Only extra bed types CRIB and ROLLAWAY_BED will have a surcharge defined. Type: SurchargeInput
`type`	Not nullable. Type of bed. Allowed values include SOFA_BED, CRIB, DAY_BED, and ROLLAWAY_BED. Type: String

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.

IdNode

Object

Known IDs in the source system.

Field	Description
`id`	ID in the source system. Type: ID
`idSource`	Not nullable. Source of the ID. Type: IdSource

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.

LivingRoom

Object

Details about a living room space.

Field	Description
`bedGroups`	Not nullable. Bed types offered in the living room. Type: Array of non nullable BedGroup
`id`	Not nullable. Space ID of this living room. Type: ID
`order`	Not nullable. Where the living room appears in the list of living rooms (minimum value is 1). Type: Int
`text`	Description of the living room. Type: Array of non nullable Text

Locale

A type that represents a string that conforms to the BCP-47 (RFC 5646) standard. Example: en-GB.

LocalizedString

Object

Localized text and its locale code.

Field	Description
`locale`	Not nullable. Locale code used to localize the text, which conforms to the BCP-47 (RFC 5646) standard, such as fr-FR. Type: Locale
`value`	Not nullable. Localized text. Type: String

LocalizedStringInput

InputObject

Localized text and its locale code.

Field	Description
`locale`	Not nullable. Locale code used to localize the text, which conforms to the BCP-47 (RFC 5646) standard, such as fr-FR. Use the `metadata` query to retrieve the list of supported locales. Type: Locale
`value`	Localized text string. Type: String

OneOfOperator

Enum

Values for operator input.

Name	Description
`IN`
`NOT_IN`

OneOfStringFilterInput

InputObject

Filter for results based on a string.

Field	Description
`operator`	Whether to include or exclude the listed string. Type: OneOfOperator
`values`	Not nullable. Strings used to filter results. Type: Array of non nullable String

PropertyUnitArea

Object

Unit's size and unit of measure.

Field	Description
`unit`	Not nullable. Unit of measure used to describe the unit's area. Type: AreaUnit
`value`	Not nullable. Size of the unit. Type: Int

RateThresholds

Object

Field	Description
`net`	The rate threshold settings of RateAcquisitionType NET. Type: RateThresholdSettings
`sellLar`	The rate threshold settings of RateAcquisitionType SELL_LAR. Type: RateThresholdSettings

RateThresholdSettings

Object

Minimum and maximum rates allowed as well as the source of the rate.

Field	Description
`maxAmount`	Not nullable. Maximum acceptable rate, expressed as a decimal number. Type: Decimal
`minAmount`	Not nullable. Minimum acceptable rate, expressed as a decimal number. Type: Decimal
`source`	Not nullable. How the minimum and maximum amounts were calculated. Type: RateThresholdsSource

RateThresholdsSource

Enum

How the minimum and maximum amounts were calculated.

Name	Description
`MANUAL_OVERRIDE`
`RECENT_BOOKINGS`

Registration

Object

Government registration information for the unit or room type.

Field	Description
`applicableRegulations`	Additional registration information required by certain districts. Type: Array of non nullable ApplicableRegulations
`complete`	Not nullable. 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. Type: Boolean
`detail`	Not nullable. Detailed registration information for the unit or room type. Type: RegistrationDetail
`district`	Geographical jurisdiction identifier. For non-configured districts, this is null. Type: String

RegistrationDetail

Object

Registration information for the unit or room type.

Field	Description
`acknowledgementRecords`	Not nullable. Acknowledgement records for the bookable unit. These are displayed to the traveler to confirm that they understand the regulatory requirements. Type: Array of non nullable AcknowledgementRecord
`applicableRegulations`	Not nullable. Additional information about the bookable unit required by certain districts. Type: Array of non nullable ApplicableRegulations
`attachmentUrls`	Links for registration documentation files (if required). Type: Array of non nullable AttachmentUrl
`compliant`	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. Type: Compliant
`displayRegistrationNumber`	Registration number displayed to the traveler. Type: String
`exemptionCategories`	List of exemptions for the property, such as maximum night cap. Type: Array of non nullable ExemptionCategory
`numberOfPhysicalRooms`	Number of rooms in the bookable unit. Type: Int
`registrationRecords`	Not nullable. Registration records for the bookable unit filed with the governing jurisdiction. Type: Array of non nullable RegistrationRecord
`regulatoryCategory`	Not nullable. Property classification category as maintained by the governing jurisdiction. Type: RegulatoryCategory
`regulatoryCategoryLabel`	Not nullable. Regulatory category in the specified locale. Type: String
`regulatorySubType`	Property subtype, such as primary or secondary, or null if not applicable. Type: String
`regulatoryType`	Property type, such as residence, condo, boat, etc. Type: String
`unitId`	Not nullable. Expedia ID of the unit or room type. 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. Type: ID

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`

RegistrationRecord

Object

Registration record for the bookable unit that has been filed with the jurisdiction.

Field	Description
`expiry`	Registration record expiration date in this format: yyyy-mm-dd Type: String
`registrationNumber`	Not nullable. Registration record ID. Type: String
`registrationNumberType`	Type of registration/license. Type: RegistrationNumberType
`registrationNumberTypeLabel`	Localized registration number type. Type: String

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`

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

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'. Type: Decimal
`type`	Not nullable. Surcharge type. Type: String

SurchargeInput

InputObject

Extra amount to charge for an extra bed.

Field	Description
`amount`	Amount of the surcharge. Must be defined if type is not 'Free'. Type: Decimal
`type`	Not nullable. Surcharge type. Allowed values include FREE, PER_DAY, PER_NIGHT, PER_WEEK, and PER_STAY. Type: String

Text

Object

Key-value pairs that specify free text elements.

Field	Description
`key`	Not nullable. Name of text element. Type: String
`values`	Not nullable. Localized value of text element. Type: Array of non nullable LocalizedString

Unit

Object

Unit details.

Field	Description
`ageCategories`	Not nullable. Minimum age(s) for the specified age category. Type: Array of non nullable UnitAgeCategory
`amenities`	Amenities available in the unit. You can filter by amenity name or whether it's available (active) by specifying the `filters` argument (type: `AmenitiesFiltersInput`). Type: Array of non nullable Amenity
`area`	Unit's size and unit of measure. Type: PropertyUnitArea
`bedGroups`	Not nullable. Bed groups defined for the unit. Type: Array of non nullable BedGroup
`count`	Cardinality of this unit configuration on the property. Type: Int
`extraBeds`	Not nullable. Extra beds offered by the unit. Type: Array of non nullable ExtraBedType
`id`	Not nullable. Expedia ID of the unit. Type: ID
`ids`	Known IDs for the unit in the source system(s). Type: Array of IdNode
`maxOccupancy`	Not nullable. Maximum occupancy of the unit in total and by age category. Type: UnitOccupancy
`nameConfig`	Not nullable. Collection of elements and attributes related to the name of a unit. Type: UnitNameConfig
`propertyId`	Not nullable. Expedia ID of the property associated with this unit. Type: ID
`rateThresholds`	Not nullable. Minimum and maximum acceptable amounts that can be pushed for a unit night under any rate plan of the unit. Type: RateThresholds
`registration`	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. Type: Registration
`smokingPolicy`	Not nullable. Smoking policy of this unit. Type: UnitSmokingPolicy
`spaces`	Spaces available in the unit (as created by `createUnitSpaces`). Type: UnitSpaces
`status`	Not nullable. Unit status in Expedia's system. Type: UnitStatus

UnitAgeCategory

Object

Minimum age for the specified age category.

Field	Description
`category`	Not nullable. Category of age being defined. Type: String
`minAge`	Not nullable. Minimum age for a person belonging to the specified age category. Type: Int

UnitAgeCategoryInput

InputObject

Minimum age for the specified age category.

Field	Description
`category`	Not nullable. Category of age being defined. Allowed values include ADULT, CHILD_A, CHILD_B, CHILD_C, CHILD_D, and INFANT. Type: String
`minAge`	Not nullable. Minimum age for a person belonging to the specified age category. Type: Int

UnitNameAccessibility

Object

Attributes that determine if unit has accessibility.

Field	Description
`accessibilityTypeOverride`	Not nullable. Type of accessibility to be included in the name as specified; this will override `includeAccessibility` if present. Type: String
`includeAccessibility`	Not nullable. Whether to include 'Accessible' in the unit name. When `accessibilityTypeOverride` is provided, this field is set to `true`. Type: Boolean

UnitNameAccessibilityInput

InputObject

Attributes that determine if unit has accessibility.

Field	Description
`accessibilityTypeOverride`	Type of accessibility to be included in the name as specified; this will override `includeAccessibility` if present. Use the `metadata` query for the list of supported values. Type: String
`includeAccessibility`	Whether to include 'Accessible' in the unit name. When `accessibilityTypeOverride` is provided, this field is set to `true`. Type: Boolean

UnitNameAttributes

Object

Collection of attributes that can be used to build a unit name.

Field	Description
`accessibility`	Not nullable. Whether the unit has accessibility. Type: UnitNameAccessibility
`bedroomDetails`	Not nullable. Details of the bedroom, which is used to compose the name. Type: String
`customLabel`	Not nullable. Custom label (up to 37 characters) used as a suffix to the unit name; always used in the name if provided. This text is not localized. Type: String
`featuredAmenity`	Not nullable. Highlights a feature of the unit, which is used to compose the name. Type: String
`includeBedType`	Not nullable. 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. Type: Boolean
`includeSmokingPolicy`	Not nullable. 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. Type: Boolean
`location`	Not nullable. Highlights the location of the unit, which is used to compose the name. Type: String
`unitClass`	Not nullable. Class of unit, which is used to compose the name (such as Basic, Standard, and so on). Type: String
`unitType`	Not nullable. Type of unit, which is used to compose the name (such as Room, Apartment, Cabin, and so on). Type: String
`view`	Not nullable. Additional information about the view of the unit, which is used to compose the name. Type: String

UnitNameConfig

Object

Collection of elements and attributes related to the name of a unit.

Field	Description
`attributes`	Not nullable. Collection of attributes that can be used to build a unit name. Type: UnitNameAttributes
`value`	Not nullable. An auto-generated attribute name that is returned if attributes are provided. Type: String

UnitOccupancy

Object

Maximum occupancy of the unit in total and by age category.

Field	Description
`adults`	Not nullable. Maximum number of adults that can reside in the unit; this will be at least 1 and less than or equal to the total. Type: Int
`children`	Not nullable. Maximum number of children that can reside in the unit; this will be less than the total. Type: Int
`total`	Not nullable. Total count of people that can reside in the unit; this will be at least 1. Type: Int

UnitSmokingPolicy

Enum

Smoking policy values.

Name	Description
`NON_SMOKING`
`SMOKING`
`SMOKING_AND_NON_SMOKING`

UnitSpaces

Object

Spaces available in the unit (as created by createUnitSpaces).

Field	Description
`bedrooms`	Bedrooms available in the unit. Type: Array of non nullable Bedroom
`livingRooms`	Living rooms available in the unit. Type: Array of non nullable LivingRoom

UnitState

Enum

Unit status values.

Name	Description
`ACTIVE`
`INACTIVE`

UnitStatus

Object

Unit status in Expedia's system.

Field	Description
`state`	Not nullable. Unit status. Type: UnitState

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Product management

createUnit mutation

Syntax

Examples

Creating a unit without amenities

Creating a unit with amenities

Arguments

Types

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Product management

createUnit mutationCopy link

Syntax

Examples

Creating a unit without amenities

Creating a unit with amenities

Arguments

Types

createUnit mutation