Skip to main content

Hotel

Represents a hotel.

type Hotel {
  additionalAmenities: String
  address: HotelAddress
  amenities: [Amenity!]
  billingAddress: HotelAddress
  billingDetails: HotelBillingDetails
  cancelationPolicy: ItemCancelationPolicy!
  commissionRate: Float!
  contactDetails: HotelContactDetails
  createdAt: DateTime!
  createdBy: String
  customFields(
    input: CustomFieldSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [CustomField!]! @deprecated
  customFieldsPaged(
    filterInput: CustomFieldAdvancedSearchFilterInput! = [object Object]
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): CustomFieldPage!
  description: String
  distanceFromVenue: Float!
  eventVenue: String
  id: ID!
  inventory: HotelInventory!
  lastModifiedAt: DateTime!
  lastModifiedBy: String
  mapLink: URL
  name: String!
  paymentPolicy: ItemPaymentPolicy!
  photos: [HotelPhoto!]
  roomTypes(
    limit: PaginationLimit! = 100
    offset: NonNegativeInt! = 0
  ): [RoomType!]!
  selfRated: Boolean!
  standardCheckInTime: LocalTime
  standardCheckOutTime: LocalTime
  starRating: Float!
  termsConditions: String
  uniqueCode: String
}

Fields​

Hotel.additionalAmenities ● String scalar​

A UTF-8 string representing the additional amenities at the hotel. Optional.

Hotel.address ● HotelAddress object​

The address of the hotel. Optional.

Hotel.amenities ● [Amenity!] list object​

The amenities available at the hotel. Optional.

Hotel.billingAddress ● HotelAddress object​

The billing address of the hotel. Optional.

Hotel.billingDetails ● HotelBillingDetails object​

The billing details of the hotel. Optional.

Hotel.cancelationPolicy ● ItemCancelationPolicy! non-null object​

The cancelation policy for the hotel.

Hotel.commissionRate ● Float! non-null scalar​

The commission rate for the hotel.

Hotel.contactDetails ● HotelContactDetails object​

The details of the main contact at the hotel. Optional.

Hotel.createdAt ● DateTime! non-null scalar​

The date and time the record was created.

Hotel.createdBy ● String scalar​

UTF-8 string value that represents the username of the user who created the record. Optional.

Hotel.customFields ● [CustomField!]! deprecated non-null object​

DEPRECATED

Use customFieldsPaged instead. It returns the same custom fields together with pagination metadata (total count, has-next-page) and exposes a richer filter input supporting both inclusion and exclusion semantics (eq, ne, in, notIn). This field will be removed in a future release.

A list of custom field values associated with this hotel.

CustomFields and CustomFieldDefinitions can be matched through the definitionId and id fields, respectively.

See CustomFieldSearchFilterInput for details on how the optional input argument can be used to filter custom fields.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
Hotel.customFields.input ● CustomFieldSearchFilterInput! non-null input​
Hotel.customFields.limit ● PaginationLimit! non-null scalar​
Hotel.customFields.offset ● NonNegativeInt! non-null scalar​

Hotel.customFieldsPaged ● CustomFieldPage! non-null object​

Custom fields associated with this record that match the filter criteria specified in the optional filterInput argument, returned together with pagination metadata.

See CustomFieldAdvancedSearchFilterInput for details on how the filterInput argument can be used. The filter supports both inclusion and exclusion semantics (eq, ne, in, notIn).

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).

Throws an error with code:

  • BAD_USER_INPUT if all fields in the filterInput argument have a combined total number of values exceeding 1,000.
Hotel.customFieldsPaged.filterInput ● CustomFieldAdvancedSearchFilterInput! non-null input​
Hotel.customFieldsPaged.limit ● PaginationLimit! non-null scalar​
Hotel.customFieldsPaged.offset ● NonNegativeInt! non-null scalar​

Hotel.description ● String scalar​

A UTF-8 string representing the description of the hotel. Optional.

Hotel.distanceFromVenue ● Float! non-null scalar​

The distance from the hotel to the event venue.

Hotel.eventVenue ● String scalar​

The event venue for the distance from the hotel. Optional.

Hotel.id ● ID! non-null scalar​

The unique identifier for the hotel.

Hotel.inventory ● HotelInventory! non-null object​

The inventory for this hotel.

Hotel.lastModifiedAt ● DateTime! non-null scalar​

The date and time the record was last modified.

Hotel.lastModifiedBy ● String scalar​

UTF-8 string value that represents the username of the user who last modified the record. Optional.

The URL for an external map link for this hotel. Optional.

Hotel.name ● String! non-null scalar​

A UTF-8 string representing the name of the hotel.

Hotel.paymentPolicy ● ItemPaymentPolicy! non-null object​

The payment policy for the hotel.

Hotel.photos ● [HotelPhoto!] list object​

A collection of photos for the hotel. Optional.

Hotel.roomTypes ● [RoomType!]! non-null object​

The different types of rooms available in the hotel.

Optionally, the offset and limit arguments can be used to page through multiple items:

  • offset must be a non-negative integer (defaults to 0).
  • limit must be a positive integer from 1 to 2000 (defaults to 100).
Hotel.roomTypes.limit ● PaginationLimit! non-null scalar​
Hotel.roomTypes.offset ● NonNegativeInt! non-null scalar​

Hotel.selfRated ● Boolean! non-null scalar​

A flag indicating if the star rating is self rated.

Hotel.standardCheckInTime ● LocalTime scalar​

The standard check-in time for bookings made at this hotel. Optional.

Hotel.standardCheckOutTime ● LocalTime scalar​

The standard check-out time for bookings made at this hotel. Optional.

Hotel.starRating ● Float! non-null scalar​

The star rating of the hotel.

Hotel.termsConditions ● String scalar​

A UTF-8 string representing the terms and conditions of the hotel. Optional.

Hotel.uniqueCode ● String scalar​

A customer supplied, UTF-8 string value that represents a unique code for the hotel. Optional.

The value must be unique across all hotels for an event.

Member Of​

AccommodationSetup object ● CreateHotelPayload object ● HotelBooking object ● RoomType object ● UpdateHotelPayload object