Version v40

Assets

API	Description
POST API/V40/System/Properties/{propertyCode}/Assets	Add a new asset
GET API/V40/System/Properties/{propertyCode}/Assets/Current?SessionToken={SessionToken}	Retrieve current asset
DELETE API/V40/System/Properties/{propertyCode}/Assets/Current?SessionToken={SessionToken}	Delete an asset

Asset upgrade (Deprecated)

API	Description
POST API/V40/System/Properties/{propertyCode}/AssetUpgrade/Room/{roomNumber}	Adds asset info
GET API/V40/System/Properties/{propertyCode}/AssetUpgrade?ip={ip}&isPairing={isPairing}	Get's asset info
GET API/V40/System/Properties/{propertyCode}/AssetUpgrade/Rooms	Gets assets for a property
GET API/V40/System/Properties/{propertyCode}/AssetUpgrade/Room/{roomNumber}	Gets asset info by room
DELETE API/V40/System/Properties/{propertyCode}/AssetUpgrade/Room/{roomNumber}	Clears asset info by room

Cart (Deprecated - please use Outlet)

API	Description
POST API/V40/Interactive/Cart/Clear	Clear the cart
POST API/V40/Interactive/Cart/Items	Add an item to cart
PATCH API/V40/Interactive/Cart/Items/{code}	Update cart item
POST API/V40/Interactive/Cart/Checkout	Cart check Out
POST API/V40/Interactive/Cart/AddItemsAndCheckout	Cart quick checkout
GET API/V40/Interactive/Cart?SessionToken={SessionToken}	Return the cart
POST API/V40/Interactive/Cart	Creates one Order per Outlet

Content

API	Description
GET API/V40/CMS/Content/Outlet/{OutletCode}/SectionsCategoriesItems?SessionToken={SessionToken}	Retrieve outlet sections/categories/items
GET API/V40/CMS/Content/SectionsCategoriesItems?SessionToken={SessionToken}	Retrieve property sections/categories/items
GET API/V40/CMS/Content/Guest/{GuestId}/SectionsCategoriesItems?SessionToken={SessionToken}	Retrieve property sections/categories/items by guest
GET API/V40/CMS/Content/Sections?SessionToken={SessionToken}	Retrieve sections
GET API/V40/CMS/Content/Sections/{SectionCode}/Categories?SessionToken={SessionToken}	Retrieve categories by section code
GET API/V40/CMS/Content/Sections/{SectionCode}/EncryptedURL?SessionToken={SessionToken}	Retrieve encrypted section url
GET API/V40/CMS/Content/Categories/{CategoryCode}/Items?SessionToken={SessionToken}	Retrieve items by category
GET API/V40/CMS/Content/Outlet/{outletCode}/CategoryItemsByPosItemCode/{posItemCode}?SessionToken={SessionToken}	Retrieves CategoryItems for an Outlet by PosItemCode
GET API/V40/CMS/Content/Items/{Code}?SessionToken={SessionToken}	Retrieve an item
GET API/V40/CMS/Content/Dashboard?SessionToken={SessionToken}	Retrieve dashboard content
GET API/V40/CMS/Content/Homepage?SessionToken={SessionToken}	Retrieve homepage content
GET API/V40/CMS/Content/Guest/{GuestId}/Homepage?SessionToken={SessionToken}	Retrieve homepage by guest

Flights

API	Description
GET API/V40/Information/Flight/Airports?SessionToken={SessionToken}	List commercial airports
GET API/V40/Information/Flight/Airports/{AirportCode}/Arrivals?SessionToken={SessionToken}	List arrival flights
GET API/V40/Information/Flight/Airports/{AirportCode}/Departures?SessionToken={SessionToken}	List departure flights

Guest

API	Description
GET API/V40/Interactive/Guest/Profile?SessionToken={SessionToken}	Retrieve guest profile
GET API/V40/Interactive/Guest/Profile2?SessionToken={SessionToken}	Retrieve guest profile (This endpoint was duplicated from GetGuestProfile to investigate the cause of the 500 error and returns 404 instead of 500.)
POST API/V40/Interactive/Guest/CheckIn	Check-in guest
POST API/V40/Interactive/Guest/CheckOut	Check-out guest
POST API/V40/Interactive/Guest/ReservationNumber	Verify reservation number
POST API/V40/Interactive/Guest/ConfirmationNumber	No documentation available.

Messages

API	Description
GET API/V40/Interactive/Messages/Conversations?SessionToken={SessionToken}	Retrieve conversations
POST API/V40/Interactive/Messages/Conversations	Create conversation
POST API/V40/Interactive/Messages/NonVerifiedGuestConversations	Create non verified guest conversation
PATCH API/V40/Interactive/Messages/{code}	Mark message as read
PATCH API/V40/Interactive/Messages/Conversations/{code}/Message	Start new message
POST API/V40/Interactive/Messages/NonVerifiedGuestConversations/{code}/Message	Start new message for a non verified guest conversation
GET API/V40/Interactive/Messages?PageNumber={PageNumber}&DescendingOrder={DescendingOrder}&PageLength={PageLength}&SessionToken={SessionToken}	Retrieve messages

Order

API	Description
GET API/V40/Interactive/Order?SessionToken={SessionToken}	Retrieve orders
GET API/V40/Interactive/PropertyOrders/{orderCode}?SessionToken={SessionToken}	Retrieves a property order (verified or non verified) by code
GET API/V40/Interactive/PropertyOrders?requestModel.SessionToken={requestModel.SessionToken}&orderCodes[0]={orderCodes[0]}&orderCodes[1]={orderCodes[1]}	Retrieves property orders (verified or non verified)
GET API/V40/Interactive/Order/BillInfo?SessionToken={SessionToken}	Retrieve bill

Outlet

API	Description
GET API/V40/Interactive/Outlet?SessionToken={SessionToken}	Retrieve all outlets
GET API/V40/Interactive/Outlet/{request.OutletCode}/DeliveryLocation?OutletCode={OutletCode}&SessionToken={SessionToken}	Retrieve outlet delivery locations
POST API/V40/Interactive/Outlet/{outletCode}/AddItemsToBasket	Creates new basket with items
POST API/V40/Interactive/Outlet/{outletCode}/PlaceVerifiedGuestOrder	Place order to outlet
POST API/V40/Interactive/Outlet/{outletCode}/PlaceVerifiedGuestServiceRequest	Place verified service request
POST API/V40/Interactive/Outlet/{outletCode}/PlaceNonVerifiedGuestOrder	Place non-verified order
GET API/V40/Interactive/Outlet/{outletCode}/NonVerifiedGuestOrder?DeliveryLocationCode={DeliveryLocationCode}&Offset={Offset}&Limit={Limit}&SessionToken={SessionToken}	Retrieve non-verified orders
POST API/V40/Interactive/Outlet/{outletCode}/PlaceNonVerifiedGuestServiceRequest	Place non-verified service request
POST API/V40/Interactive/Outlet/{outletCode}/deliveryLocation/{deliveryLocationCode}/CallWaiter	Place call waiter request
POST API/V40/Interactive/Outlet/{outletCode}/deliveryLocation/{deliveryLocationCode}/GetOpenCheck	Get open check for delivery location

Payment

API	Description
GET API/V40/Interactive/Payment/Outlet/{request.OutletCode}/Initialise?OutletCode={OutletCode}&Amount={Amount}&PaymentType={PaymentType}&SessionToken={SessionToken}	Retrieve client payment integration settings for property
POST API/V40/Interactive/Payment/Outlet/{request.OutletCode}/Initialise	Retrieve client payment integration settings for property
POST API/V40/Interactive/Payment/Outlet/{outletCode}/AddPaymentToCheck	Create a payment for an existing GXP delivery location POS order.
POST API/V40/Interactive/Payment/Outlet/{outletCode}/AddDiscountToCheck	Add a discount to an open tab

Service Requests (Deprecated - please use Outlet)

API	Description
PUT API/V40/Interactive/ServiceRequests	Create service request

Session

API	Description
POST API/V40/System/Session/Initialise	Initialise session
POST API/V40/System/Session/InitialiseByGuestIdentifier	Initialise session by guest identifier
POST API/V40/System/Session/InitialiseByToken	Initialise session by token
POST API/V40/System/Session/LoginByToken	Login guest by token
POST API/V40/System/Session/InitialiseByRoom	Initialise session by room
POST API/V40/System/Session/InitialiseByAsset	Initialise session by asset
POST API/V40/System/Session/LoginByRoom	Login guest by room number
POST API/V40/System/Session/LoginByGuestIdentifier	Login by guest identifier
POST API/V40/System/Session/Logout	Logout guest
GET API/V40/System/Session/IsLoggedIn?SessionToken={SessionToken}	Check guest is logged in
POST API/V40/System/Session/ContentVersion	Set the content version
GET API/V40/System/Session/ContentVersion?SessionToken={SessionToken}	Retrieve the content version
POST API/V40/System/Session/Language	Set the language
POST API/V40/System/Session/Pin	Verify device pin

Settings

API	Description
GET API/V40/System/Settings?AlternativeCodeType={AlternativeCodeType}&SessionToken={SessionToken}	Retrieve all settings
GET API/V40/System/Settings/Property?SessionToken={SessionToken}	Retrieve property settings
GET API/V40/System/Settings/CMS?SessionToken={SessionToken}	Retrieve CMS settings
GET API/V40/System/Settings/Cart?SessionToken={SessionToken}	Retrieve cart settings
GET API/V40/System/Settings/Versions?SessionToken={SessionToken}	Retrieve content version
GET API/V40/System/Settings/Languages?AlternativeCodeType={AlternativeCodeType}&SessionToken={SessionToken}	Retrieve languages
GET API/V40/System/Settings/Outlet?Code={Code}&SessionToken={SessionToken}	Retrieve outlet settings
GET API/V40/System/Settings/OutletAndContentPreCalculatedAvailability/{outletCode}?SessionToken={SessionToken}	Retrieve outlet availability settings
GET API/V40/System/Settings/AppStyles?SessionToken={SessionToken}	Retrieve app styles for a Property
GET API/V40/System/Settings/PaymentSettings?SessionToken={SessionToken}	Retrieve payment settings

StaticContent

API	Description
GET API/V40/System/StaticContent/Messages?SessionToken={SessionToken}	Retrieve static Content
GET API/V40/System/StaticContent/DraftMessages?SessionToken={SessionToken}	Retrieve Draft Static Content

Weather

API	Description
GET API/V40/Information/Weather/Forecast?SessionToken={SessionToken}	Weather forcast