Sign in

v1

latestSwagger 2.02026-07-14214688.6 KB
Codes

Get all the details for a specific code available for the hotel.

Read the details about a specific code available for the defined hotel.

get/api/hotel/v0/hotels/{hotelId}/codes/{id}

Path parameters

hotelIdinteger required

The hotel id the code available for.

idstring required

The code identifier you want to see details for.

Headers

App-Idstring required

Application identifier

App-Keystring required

Application key.

Response

Details for the given code and hotel.

_linksobject

Collection of links to related resources

codestring

The code value. This value you will see in reservations as market code and in other resources like the revenue buckets in transactions

commentstring

The comment for this code

defaultboolean

This attribute tells you if this code is the default code for the specific type or not. Not all the types of codes need to have a default code

idstring

The id of the code

namestring

The name of the code that usually is more human readable

type'GuestRequest' | 'RequestDietary' | 'VIPStatus' | 'ReasonForRateChange' | 'Regrets' | 'MarketSegments' | 'SourceOfBusiness' | 'LoyaltyProgram' | 'CancellationReason' | 'AccountType' | 'AccountRank' | 'VIPLevel' | 'Title' | 'ContactFunction' | 'Territory' | 'CorrespondenceType' | 'ExternalProgramType' | 'RevenueBucket' | 'AdditionalRevenueBucket' | 'AdditionalStatisticsBuckets' | 'MealPeriod' | 'BillingCycle' | 'ReminderCycle' | 'MajorMarketSegments' | 'DocumentType' | 'ActivityType' | 'ReservationLabels'

The type or category of the code