Access Code - Corporate, Group or Promotion

Include Corporate, Group, or Promotion Access codes in the request to return associated rates Rates in the availability response.

Request Parameters

Parameter	Description	Type
accessCode	Access code	String
accessType	Access code type. Values: Corporate, Group, Promotion	String
accessFilterCorporateRates	If true, the system will filter the results to only include Preferred and Always Display Company rates when available. Only applicable when `@accessType=corporate`.	Boolean
onlyCheckRequested	If true, the system will only check for product availability based upon the requested parameters.	Boolean

Response Parameters

Parameter	Description	Type
Rate/@Code	Rate code associated to the accessCode	String
Ref	Indicates the access code type. Values: AccessCode, AccessGeoLocation, Agent, ChannelizedRateAccessCode, Corporate, Group, Loyalty, Rate, RateClass, RateFilter, Room, RoomFeature, Template, Unknown	String
RefValue	Access code value.	String

Corporate access code (accessType=corporate)

Note: For a Corporate code search, the system will look for a Hotel-level company profile first and if not found then a Chain-level profile.

Request

/v1/api/hotel/availability?hotelId=13098&chainId=12723&adults=2&startDate=2023-12-17&endDate=2023-12-20&numRooms=1&primaryChannel=WEB&secondaryChannel=WEB&onlyCheckRequested=true&accessCode=IBM&accessType=corporate

Successful Response (partial)

A successful response will return a matching Rate/@Code and corresponding Ref and RefValue parameters.

{
    "productAvailability": {
        "Prices": [{
            "Product": {
                "Rate": {
                    "Code": "Corp_Rate"
                },
                "Room": {
                    "Code": "SUPK"
                },
                "Ref": "AccessCode",
                "RefValue": "IBM"
            }
        }],
        "ProductResult": "Success"
    }
}

Corporate access code (accessType=corporate) with accessFilterCorporateRates

Chains, Brands and Hotels can configure corporate rates as Preferred or to Always Display.

Preferred
- Allows the user to assign a rate attached to a company profile as a Preferred Rate. This means SynXis only returns the first available preferred rate in the sort order of the preferred rates.
Always Display
- Allows the user to assign a rate attached to a company profile as Always Display. This means when this rate is available it displays along with any Preferred Rates.

Description	Value
Enable Preferred Rates for Company Profiles	Enabled
Company Profile	Sabre Hospitality Solutions
Rate Assignment in Company Profile	Negotiated Local Rate (LOCRATE) Negotiated Global Rate (GLORATE) Extended Stay Rate LOS 3 – 7 Nights (LOSRATE3) Extended Stay Rate LOS 8 + Nights (LOSRATE8) Other Rate 1 (OTHRATE1) Other Rate 2 (OTHRATE2)
Preferred Rates	Preferred Rate 1 is LOCRATE Preferred Rate 2 is GLORATE
Always Return when Available	LOSRATE3 LOSRATE8
Scenario 1 Search Availability for 2 Nights	Return LOCRATE Return GLORATE if LOCRATE is unavailable Return OTHRATE1 and OTHRATE2 if LOCRATE and GLORATE is unavailable
Scenario 2 Search Availability for 4 Nights	Return LOCRATE, LOSRATE3 Return GLORATE, LOSRATE3 if LOCRATE is unavailable Return OTHRATE1, OTHRATE2, LOSRATE3 if LOCRATE and GLORATE are unavailable
Scenario 3 Search Availability for 9 Nights	Return LOCRATE, LOSRATE8 Return GLORATE, LOSRATE8 if LOCRATE is unavailable Return OTHRATE1, OTHRATE2, LOSRATE8 if LOCRATE and GLORATE are unavailable

Promotion access code (accessType=promotion)

Request

/v1/api/hotel/availability?hotelId=13098&chainId=12723&adults=2&startDate=2023-12-17&endDate=2023-12-20&numRooms=1&primaryChannel=WEB&secondaryChannel=WEB&onlyCheckRequested=true&accessCode=Save10&accessType=promotion

Successful Response (partial)

A successful response will return a matching Rate/@Code and corresponding Ref and RefValue parameters.

{
    "productAvailability": {
        "Prices": [{
            "Product": {
                "Rate": {
                    "Code": "Promo_Rate"
                },
                "Room": {
                    "Code": "SUPK"
                },
                "Ref": "AccessCode",
                "RefValue": "Save10"
            }
        }],
        "ProductResult": "Success"
    }
}

GEO Promotion (accessType=promotion)

This type of promotion is configured for specific geographic locations. The request includes a latitude/longitude pair which is used to check for available promotions.

Request Parameters

Parameter	Description	Type
accessType	Access code type. Values: Corporate, Group, Promotion	String
accessLatitude	Latitude used to search for Geo promotions. Only applicable when `@accessType=promotion`.	Number
accessLongitude	Longitude used to search for Geo promotions. Only applicable when `@accessType=promotion`.	Number

Request

/v1/api/hotel/availability?hotelId=13098&chainId=12723&adults=2&startDate=2023-12-17&endDate=2023-12-20&numRooms=1&primaryChannel=WEB&secondaryChannel=WEB&accessType=promotion&accessLatitude=38.8352&accessLongitude=-104.8198

Successful Response (partial)

A successful response will return publicly available rates along with any that are included in the GEO promotion with corresponding Ref and RefValue parameters.

{
    "productAvailability": {
        "Prices": [{
            "Product": {
                "Rate": {
                    "Code": "Promo_Rate2"
                },
                "Room": {
                    "Code": "SUPK"
                },
                "Ref": "AccessGeoLocation",
                "RefValue": "US"
            }
        }],
        "ProductResult": "Success"
    }
}

Group access code (accessType=group)

Request

/v1/api/hotel/availability?hotelId=13098&chainId=12723&adults=2&startDate=2023-12-17&endDate=2023-12-20&numRooms=1&primaryChannel=WEB&secondaryChannel=WEB&onlyCheckRequested=true&accessCode=Soccer&accessType=group

Successful Response (partial)

A successful response will return a matching Rate/@Code and corresponding Ref and RefValue parameters.

{
    "productAvailability": {
        "Prices": [{
            "Product": {
                "Rate": {
                    "Code": "Soccer"
                },
                "Room": {
                    "Code": "SUPK"
                },
                "Ref": "Group",
                "RefValue": "Soccer"
            }
        }],
        "ProductResult": "Success"
    }
}

Warning Response

An invalid access code will result in a warning.