Objects

AdditionalGuest

Fields

Name	Description
id String

Availability

Fields

Name	Description
m DaysTime
t DaysTime
w DaysTime
th DaysTime
f DaysTime
sa DaysTime
s DaysTime

Booking

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
roomNumber String
bookingReference String
checkInDate DateTime
checkOutDate DateTime
carRegistration String
party [BookingParty!]
bookingDetails BookingDetails
roomType String
estimatedTimeOfArrival String
numberOfAdults Float
numberOfChildren Float
clubMemberNumber String
purposeOfStay String
pmsId String
dateReviewed DateTime
dateSubmitted DateTime
dateCheckedIn DateTime
dateCheckedOut DateTime
dateCanceled DateTime
guest Guest
additionalGuests AdditionalGuest
status BookingStatus!

BookingDetails

Fields

Name	Description
toggleQuestion [BookingToggleQuestion!]!

BookingParty

Fields

Name	Description
id String!
firstName String
lastName String
ageGroup AgeGroup!
email String
mobile String
mobileCountryCode String
countryOfResidence String
address String
nationality String
passportNumber String
nextDestination String
dateOfBirth DateTime
dietaryRequirements String
purposeOfStay String	Deprecated: This field has been moved to booking level
specialOccasions String
job String
company String
pmsId String
carRegistration String

BookingToggleQuestion

Fields

Name	Description
title String!
type CustomFieldType!
result String
toggle Boolean

CardDetails

Fields

Name	Description
id String
country String
brand String!
last4 String!

Coordinates

Fields

Name	Description
lat Float!
lng Float!

CreateOrderResponse

Fields

Name	Description
order Order

DaysTime

Fields

Name	Description
start String!
end String!

GetAccessTokenResponse

Fields

Name	Description
accessToken String!
refreshToken String!
ttl Float!
grantLevel [AccessTokenGrantLevel!]!

GetCustomDomainResponse

Fields

Name	Description
id String!
domain String!
configured Boolean!
clientStatus String!

GetUserLoginTokenResponse

Fields

Name	Description
loginLink String!

Group

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
name String!
subscription GroupSubscription
demo Boolean
apiKeys [GroupAPIKey!]
hotels [Hotel!]!
users [User!]!

GroupAPIKey

Fields

Name	Description
label String!
dateCreated DateTime!

GroupSubscription

Fields

Name	Description
lite Boolean
subscriptionId String
status GroupSubscriptionStatus
annual Boolean

Guest

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
deviceId String
email String
firstName String
lastName String
dateLastSeen DateTime
mobile String
mobileCountryCode String
dateOfBirth DateTime
countryOfResidence String
address String
nationality String
passportNumber String
dietaryRequirements String
company String
job String
pmsId String
clubMemberNumber String
bookings [Booking!]
threads [Thread!]!
orders [Order!]!
hotels Hotel!
groups [Group!]!

GuestWithStatistics

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
deviceId String
email String
firstName String
lastName String
dateLastSeen DateTime
mobile String
mobileCountryCode String
dateOfBirth DateTime
countryOfResidence String
address String
nationality String
passportNumber String
dietaryRequirements String
company String
job String
pmsId String
clubMemberNumber String
bookings [Booking!]
threads [Thread!]!
orders [Order!]!
hotels Hotel!
groups [Group!]!
totalSpend Float!
ordersCount Float!
itemsCount Float!

Hotel

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
name String!
telephone String!
description String
photos [String!]
address HotelAddress!
socials HotelSocials
website String!
currencyCode String!
countryCode String!
pmsSettings HotelPMSSettings
launchpad HotelLaunchpad
appWidgetSettings HotelAppWidgetSettings
users [User!]!
group Group!
experiencesSettings HotelExperiencesSettings

HotelAddress

Fields

Name	Description
line1 String!
line2 String
town String!
country String!
postalCode String!
coordinates Coordinates
placeId String

HotelAppWidgetSettings

Fields

Name	Description
description String!

HotelExperiencesSettings

Fields

Name	Description
enabled Boolean!
viator HotelExperiencesSettingsViator

HotelExperiencesSettingsViator

Fields

Name	Description
apiKey String
accessType HotelExperiencesViatorAccessType
destination Float

HotelLaunchpad

Fields

Name	Description
enabled Boolean

HotelMarketplaceAppSubscription

Fields

Name	Description
id String!
endpoint String!
topics [HotelMarketplaceAppSubscriptionTopic!]!

HotelPMSMewsSettings

Fields

Name	Description
orderableServiceId String!
bookableServiceId String!

HotelPMSSettings

Fields

Name	Description
pmsId String
mewsSettings HotelPMSMewsSettings

HotelSocials

Fields

Name	Description
instagram String
twitter String

Message

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
text String!
author MessageAuthor!
guest Guest!
user User!
thread Thread!

Order

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
dateApproved DateTime
dateReady DateTime
dateCompleted DateTime
dateScheduled DateTime
items [OrderItem!]!
totalPrice Float!
roomNumber String!
notes String
cardDetails CardDetails
paymentProvider PayoutsStrategy
paymentType PaymentType!
orderReference String
posId String
paymentIntentId String
subtotal Float!
discount PriceMultiplier
surcharges [PriceMultiplier!]
reasonRejected String
rejected Boolean
canceled Boolean
refunded Boolean
delivery PricelistDeliveryType
collection PricelistCollectionType
paid Boolean
feedback OrderFeedback
guest Guest!
space Space
pricelist Pricelist
thread Thread
status OrderStatus!

OrderFeedback

Fields

Name	Description
rating Float

OrderItem

Fields

Name	Description
id String!
name String!
posId String
modifiers [OrderItemModifier!]!
discount PriceMultiplier
quantity Float!
roomServicePrice Float
regularPrice Float
posSettings PricelistPOSSettingsFulfilment
totalPrice Float!
omnivoreSettings OrderItemPOSSettings

OrderItemModifier

Fields

Name	Description
id String!
name String!
posId String
options [OrderItemOption!]!

OrderItemNestedModifier

Fields

Name	Description
id String!
name String!
posId String
options [OrderItemNestedOption!]!

OrderItemNestedOption

Fields

Name	Description
id String!
name String!
posId String
price Float!
quantity Float!

OrderItemOption

Fields

Name	Description
id String!
name String!
posId String
price Float!
quantity Float!
nestedModifiers [OrderItemNestedModifier!]

OrderItemPOSSettings

Fields

Name	Description
tableService PricelistItemPOSPriceLevel
roomService PricelistItemPOSPriceLevel

Pricelist

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
name String!
description String
availability Availability
commerce Boolean
collection [PricelistCollection!]
delivery [PricelistDelivery!]
catalog PricelistCatalog
posSettings PricelistPOSSettings
promotions PricelistPromotions
surcharges [PricelistSurcharge!]
enabledPayments PricelistEnabledPayments
autoApprove Boolean
feedback Boolean
posId String
space Space!
scheduledOrders Boolean

PricelistCatalog

Fields

Name	Description
categories [PricelistCategory!]!
labels [PricelistLabel!]

PricelistCategory

Fields

Name	Description
id String!
name String!
description String
posId String
items [PricelistItem!]!
availability Availability

PricelistCollection

Fields

Name	Description
enabled Boolean
type PricelistCollectionType!

PricelistDelivery

Fields

Name	Description
enabled Boolean
type PricelistDeliveryType!

PricelistDiscount

Fields

Name	Description
id String!
name String!
value Float!
available Boolean
level PricelistDiscountLevel
minOrderAmount Float
type PricelistMultiplierType!
loyaltyMembership Boolean
posSettings PricelistDiscountPOSSettings
posId String
delivery [PricelistDelivery!]
collection [PricelistCollection!]
count Float

PricelistDiscountPOSSettings

Fields

Name	Description
open Boolean

PricelistEnabledPayments

Fields

Name	Description
card Boolean
roomBill Boolean
cash Boolean

PricelistItem

Fields

Name	Description
id String!
name String!
description String
photos [String!]
modifiers [PricelistItemModifier!]!
regularPrice Float!
roomServicePrice Float!
posSettings PricelistItemPOSSettings
labels [PricelistLabel!]
note String
posId String
snoozed Boolean
promotions PricelistPromotions

PricelistItemModifier

Fields

Name	Description
id String!
name String!
posId String
required Boolean	Deprecated: Please use `minSelection` instead of `required`
minSelection Float
minTotalSelection Float
maxSelection Float
maxTotalSelection Float
options [PricelistItemOption!]!

PricelistItemNestedModifier

Fields

Name	Description
id String!
name String!
posId String
required Boolean	Deprecated: Please use `minSelection` instead of `required`
minSelection Float
minTotalSelection Float
maxSelection Float
maxTotalSelection Float
options [PricelistItemNestedOption!]!

PricelistItemNestedOption

Fields

Name	Description
id String!
name String!
posId String
snoozed Boolean
price Float!
maxQuantity Float

PricelistItemOption

Fields

Name	Description
id String!
name String!
posId String
snoozed Boolean
price Float!
maxQuantity Float
nestedModifiers [PricelistItemNestedModifier!]

PricelistItemPOSPriceLevel

Fields

Name	Description
posId String!
name String!
price Float!

PricelistItemPOSSettings

Fields

Name	Description
roomService PricelistItemPOSPriceLevel!
tableService PricelistItemPOSPriceLevel!
priceLevels [PricelistItemPOSPriceLevel!]

PricelistLabel

Fields

Name	Description
id String!
name String!

PricelistPOSSettings

Fields

Name	Description
enabled Boolean
posId String
revenueCenterId String
tableService PricelistPOSSettingsFulfilment
roomService PricelistPOSSettingsFulfilment
employeeId String
provider String
autoLocations Boolean

PricelistPOSSettingsFulfilment

Fields

Name	Description
posId String!
name String!

PricelistPromotions

Fields

Name	Description
discounts [PricelistDiscount!]

PricelistSurcharge

Fields

Name	Description
id String!
name String!
value Float!
type PricelistMultiplierType!
delivery [PricelistDelivery!]
collection [PricelistCollection!]

PriceMultiplier

Fields

Name	Description
id String!
posId String
value Float!
type PricelistMultiplierType!
name String!

Space

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
name String!
location String!
description String
type SpaceType!
availability Availability!
posSettings SpacePOSSettings
enabled Boolean
pricelists [Pricelist!]!
photos [String!]

SpacePOSSettings

Fields

Name	Description
enabled Boolean!
deliverect SpacePOSSettingsDeliverect!

SpacePOSSettingsDeliverect

Fields

Name	Description
locationId String!
registered Boolean
channelId String!

Thread

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
resolved Boolean
guest Guest!
order Order
lastMessage Message
tags [String!]

User

Fields

Name	Description
id String!
dateCreated DateTime!
deleted Boolean
dateUpdated DateTime!
email String!
firstName String
lastName String
mobile String
jobTitle String
developer Boolean
group Group!
hotels [Hotel!]!