Availability and Rates APIs
Booking APIs
Property Mgmt APIs
Product management
ReferenceProduct management

createUnitSpaces mutation

Creates one or more unit spaces, including the type, description, amenities, and order of the space in the list of like spaces. Creating spaces is optional; however, if spaces are created for a unit, bed groups defined for the unit are ignored.

Note: Be sure to retrieve the unit and space IDs in the response because you need them to manage the unit and spaces later (using updateUnit, updateUnitSpaces, and deleteUnitSpace).

In addition, use the metadata query to retrieve the list of allowed values for the various fields in each unit (such as bed type). This helper query is especially important when defining amenities for a unit space. Be sure to review the details in the metadata query's reference page for an explanation of how to read amenity metadata.

Syntax

1mutation { 
2  createUnitSpaces( 
3    input: CreateUnitSpacesInput! 
4  ): CreateUnitSpacesPayload 
5}

Example

This example creates a bedroom with a king and twin bed.

1mutation {
2  createUnitSpaces(
3    input: {
4      propertyId: 15240094
5      unitId: 325666913
6      bedrooms: [
7        {
8          order: 1
9          text: [
10            {
11              key: "space-name"
12              values: [{ locale: "en-US", value: "Bedroom" }]
13            }
14          ]
15          bedGroups: [
16            {
17              beds: [
18                { type: "KingBed", size: "King", quantity: 1 }
19                { type: "TwinBed", size: "Twin", quantity: 1 }
20              ]
21            }
22          ]
23        }
24      ]
25      livingRooms: [
26        {
27          order: 1
28          text: [
29            {
30              key: "LivingRm 1"
31              values: [{ locale: "en-US", value: "LivingRm 1" }]
32            }
33          ]
34          bedGroups: [
35            { beds: [{ quantity: 1, size: "Twin", type: "SofaBed" }] }
36          ]
37        }
38      ]
39    }
40  ) {
41    spaces {
42      bedrooms {
43        id
44        order
45        text {
46          key
47          values {
48            locale
49            value
50          }
51        }
52        bedGroups {
53          beds {
54            type
55            size
56            quantity
57          }
58        }
59      }
60      livingRooms {
61        id
62        order
63        text {
64          key
65          values {
66            locale
67            value
68          }
69        }
70        bedGroups {
71          beds {
72            type
73            size
74            quantity
75          }
76        }
77      }
78    }
79  }
80}

Arguments

NameDescription

input

Required.
Type: CreateUnitSpacesInput

Types


Name
Type
BedGroup
Object

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.

FieldDescription
bedsNot 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).
FieldDescription
bedsNot nullable.

Bed types offered in the room.

Type: Array of non nullable BedTypeInput
Bedroom
Object

Details about this bedroom.

FieldDescription
bedGroupsNot nullable.

Bed types offered in the room.

Type: Array of non nullable BedGroup
idNot nullable.

ID of this bedroom.

Type: ID
orderNot 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.

FieldDescription
quantityNot nullable.

Number of beds in the bed group.

Type: Int
size

Bed size, such as FULL, KING, or TWIN.

Type: String
typeNot 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.

FieldDescription
quantityNot 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
typeNot nullable.

Bed type.

Type: String
CreateUnitSpacesBedroomInput
InputObject

Details about a bedroom space.

FieldDescription
bedGroupsNot nullable.

Bed types offered in the room.

Type: Array of non nullable BedGroupInput
orderNot nullable.

Where the bedroom appears in the list of bedrooms (minimum value is 1).

Type: Int
textNot nullable.

Description of this bedroom.

Type: Array of non nullable TextInput
CreateUnitSpacesInput
InputObject

Details about the spaces to create in the unit.

FieldDescription
bedrooms

Details about the bedrooms in the unit.

Type: Array of non nullable CreateUnitSpacesBedroomInput
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
livingRooms

Details about the living rooms in the unit.

Type: Array of non nullable CreateUnitSpacesLivingRoomInput
propertyIdNot nullable.

Expedia ID of the property to which the unit belongs.

Type: ID
unitIdNot nullable.

Expedia ID of the unit for which spaces are created.

Type: ID
CreateUnitSpacesLivingRoomInput
InputObject

Details about a living room space.

FieldDescription
bedGroupsNot nullable.

Bed types offered in the living room.

Type: Array of non nullable BedGroupInput
orderNot nullable.

Where the living room appears in the list of living rooms (minimum value is 1).

Type: Int
textNot nullable.

Description of the living room.

Type: Array of non nullable TextInput
CreateUnitSpacesPayload
Object

Details about the unit's spaces after they are created. Be sure to retrieve the unit and space IDs in the payload because you need them in order to update the unit and spaces later (using the updateUnit and updateUnitSpaces mutations).

FieldDescription
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
spacesNot nullable.

Space details.

Type: UnitSpaces
ID
ID

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.

Int
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.

FieldDescription
bedGroupsNot nullable.

Bed types offered in the living room.

Type: Array of non nullable BedGroup
idNot nullable.

Space ID of this living room.

Type: ID
orderNot 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
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.

FieldDescription
localeNot nullable.

Locale code used to localize the text, which conforms to the BCP-47 (RFC 5646) standard, such as fr-FR.

Type: Locale
valueNot nullable.

Localized text.

Type: String
LocalizedStringInput
InputObject

Localized text and its locale code.

FieldDescription
localeNot 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
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.

Text
Object

Key-value pairs that specify free text elements.

FieldDescription
keyNot nullable.

Name of text element.

Type: String
valuesNot nullable.

Localized value of text element.

Type: Array of non nullable LocalizedString
TextInput
InputObject

Key-value pairs that specify free text elements.

FieldDescription
keyNot nullable.

Name of the text element. Use the metadata query to retrieve the list of supported text keys when creating or updating a property.

Type: String
valuesNot nullable.

Localized value of the text element.

Type: Array of non nullable LocalizedStringInput
UnitSpaces
Object

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

FieldDescription
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