Skip Navigation

Query Products

Hotel
Search
REST API
Hospitality

What is it?

This API is used to retrieve a list of Active Rooms, Rates, Rate Categories or Products from SynXis CR. The results can include all items or narrowed down using filter criteria.

Why use it?

The API can be used to:

  • Validate Rooms, Rates, Rate Categories and Product loaded in the SynXis CR match a secondary system
  • Export and import to a different system
  • Display the results on a website to a consumer or agent

How to use

Use basic parameters to return a list of all items related to the operation or narrow the results by adding filter criteria as outlined in the Use Cases below.

RATES

Use Case Parameters
Request a specific Rate by code and/or name code, name
Request Corporate, Group, Public or all rates  type
Request Confidential rates confidential=true
Request Group rates by allocation dates allocationBlockStartDate, allocationBlockEndDate
{
    "paging": {
        "Size": 1,
        "Total": 1
    },
    "rateList": [{
        "Details": {
            "AutoEnrollment": {
                "CountryList": []
            },
            "CommissionablePercentage": 0.0,
            "ChannelList": [{
                "Description": "Booking Engine",
                "Code": "WEB",
                "Name": "Booking Engine"
            },{
                "Description": "Voice",
                "Code": "CRS",
                "Name": "Voice"
            }],
            "Currency": {
                "CurrencyCode": "USD"
            },
            "Description": "",
            "DetailedDescription": "",
            "Hotel": {
                "Id": 13098
            },
            "Indicators": {
                "AutoEnrollmentEnabled": false,
                "Commissionable": true,
                "Corporate": false,
                "Group": false,
                "Loyalty": false,
                "LoyaltyAccrual": false,
                "Monthly": false,
                "Promotional": false,
                "Redeemable": false,
                "Suppressed": false,
                "TaxInclusive": false,
                "AllowSingleUseCard": false,
                "PointsOnly": false,
                "ManagedInCRSOnly": false
            },
            "CompanyList": []
        },
        "ActiveBlocks": false,
        "CategoryCode": "BAR",
        "CurrencyCode": "USD",
        "Code": "BAR",
        "Name": "Best Available Rate",
        "SortSequenceNumber": 0,
        "PmsCode": ""
    }],
    "contentList": {
        "HotelList": [{
            "Code": "CRSPROD1",
            "Id": 13098,
            "Name": "Sabre Hospitality Hotel"
        }]
    }
}

RATE CATEGORIES

Use Case Parameters
Request a specific RateCategory by code and/or name code, name
Request Group RateCategories include=Groups
{
    "paging": {
        "Size": 1,
        "Total": 1
    },
    "rateCategoryList": [{
        "Details": {
            "Description": "",
            "Hotel": {
                "Id": 12723
            }
        },
        "Code": "BAR",
        "Name": "Best Available Rates"
    }, {
        "Details": {
            "Description": "Government",
            "Hotel": {
                "Id": 13098
            }
        },
        "Code": "GOV",
        "Name": "Government"
    }],
    "contentList": {
        "HotelList": [{
            "Code": "CRSPROD1",
            "Id": 13098,
            "Name": "Sabre Hospitality Hotel"
        }, {
            "Code": "FAMORIM",
            "Id": 12723,
            "Name": "Sabre Hospitality Chain"
        }]
    }
}

RATE FILTERS

{
    "paging": {
        "Size": 2,
        "Total": 2
    },
    "rateList": [
        {
            "Code": "BAR Medium",
            "Name": "BAR Medium Rate"
        },
        {
            "Code": "AARP",
            "Name": "AARP"
        },
        {
            "Code": "AAA",
            "Name": "AAA"
        }
    ],
    "rateFilterList": [
        {
            "ChannelList": [
                {
                    "SortOrder": 0,
                    "Code": "WEB"
                }
            ],
            "RateList": [
                {
                    "Hotel": {
                        "Id": "80227"
                    },
                    "Code": "BAR Medium"
                }
            ],
            "Code": "HOTELRF2",
            "Name": "Hotel Rate Filter2",
            "RequiresCredentials": false
        },
        {
            "ChannelList": [
                {
                    "SortOrder": 0,
                    "Code": "WEB"
                }
            ],
            "RateList": [
                {
                    "Hotel": {
                        "Id": "13098"
                    },
                    "Code": "AARP"
                },
                {
                    "Hotel": {
                        "Id": "13098"
                    },
                    "Code": "AAA"
                }
            ],
            "Code": "ASSOC",
            "Name": "Association",
            "RequiresCredentials": false
        }
    ],
    "contentList": {
        "HotelList": [
            {
                "Code": "Hotel1",
                "Id": 80227,
                "Name": "HOTEL One"
            },
            {
                "Code": "Hotel2",
                "Id": 80707,
                "Name": "Hotel Two"
            },
            {
                "Code": "Hotel3",
                "Id": 13098,
                "Name": "Hotel Three"
            }
        ]
    }
}

ROOM

Use Case Parameters
Request a specific Room by code and/or name   code, name
Include room features, views and class in the response view
{
    "paging": {
        "Size": 1,
        "Total": 1
    },
    "roomList": [{
        "Details": {
            "Description": "",
            "DetailedDescription": "",
            "GuestLimit": {
                "ChildrenIncluded": true,
                "Adults": 2,
                "Children": 2,
                "GuestLimitTotal": 3,
                "Value": 3
            },
            "ImageList": [],
            "Hotel": {
                "Id": 13098
            },
            "Bedding": [{
                "Description": "King",
                "Code": "K",
                "Quantity": "1",
                "Type": "King",
                "IsPrimary": true
            }],
            "Class": {
                "Code": "E",
                "Description": "Superior With Shower"
            },
            "FeatureList": [{
                "Description": "Accessible Baths",
                "Id": "8",
                "OtaCode": "8",
                "SortOrder": 0,
                "OtaType": "Room Services"
            }],
            "ViewList": [],
            "AdaComplaint": false
        },
        "Code": "SUPK",
        "Name": "Superior Room King Bed",
        "SortOrder": 0,
        "PmsCode": "",
        "DisplaySortOrder": 0
    }],
    "contentList": {
        "HotelList": [{
            "Code": "CRSPROD1",
            "Id": 13098,
            "Name": "Sabre Hospitality Hotel"
        }]
    }
}

PRODUCT

The response for a Product search will include Products and associated Rooms and Rates

Use Case Parameters
Request a specific Room by code and/or name code, name
{
    "productList": [{
        "Details": {
            "Description": "",
            "Hotel": {
                "Id": 13098
            }
        },
        "Rate": {
            "Code": "BAR"
        },
        "Room": {
            "Code": "LUXT"
        },
        "Id": "BAR:LUXT"
    }],
    "paging": {
        "Size": 1,
        "Start": 0,
        "Total": 1
    },
    "rateList": [{
        "Details": {
            "AutoEnrollment": {
                "CountryList": []
            },
            "CommissionablePercentage": 0.0,
            "ChannelList": [{
                "Description": "Booking Engine",
                "Code": "WEB",
                "Name": "Booking Engine"
            }],
            "Currency": {
                "CurrencyCode": "USD"
            },
            "Description": "",
            "DetailedDescription": "",
            "Hotel": {
                "Id": 13098
            },
            "Indicators": {
                "AutoEnrollmentEnabled": false,
                "Commissionable": true,
                "Corporate": false,
                "Group": false,
                "Loyalty": false,
                "LoyaltyAccrual": false,
                "Monthly": false,
                "Promotional": false,
                "Redeemable": false,
                "Suppressed": false,
                "TaxInclusive": false,
                "AllowSingleUseCard": false,
                "PointsOnly": false,
                "ManagedInCRSOnly": false
            },
            "CompanyList": []
        },
        "ActiveBlocks": false,
        "CategoryCode": "BAR",
        "CurrencyCode": "USD",
        "Code": "BAR",
        "Name": "Best Available Rate",
        "SortSequenceNumber": 0,
        "PmsCode": ""
    }],
    "roomList": [{
        "Details": {
            "Description": "Deluxe Room Twin Beds-AC-Cable TV-Minibar-Bathroom-Hari Drier-Closet-Balcony-Desk-Internet-Saf",
            "DetailedDescription": "Deluxe Room Twin Beds-AC-Cable TV-Minibar-Bathroom-Hari Drier-Closet-Balcony-Desk-Internet-Safe",
            "GuestLimit": {
                "ChildrenIncluded": true,
                "Adults": 0,
                "Children": 0,
                "GuestLimitTotal": 2,
                "Value": 2
            },
            "ImageList": [],
            "Hotel": {
                "Id": 13098
            },
            "AdaComplaint": false
        },
        "CategoryCode": "Twin",
        "Code": "LUXT",
        "Name": "Deluxe Room Twin Beds",
        "SortOrder": 3,
        "PmsCode": "",
        "DisplaySortOrder": 4
    }],
    "contentList": {
        "HotelList": [{
            "Code": "CRSPROD1",
            "Id": 13098,
            "Name": "Sabre Hopitality Hotel"
        }]
    }
}

Resources