Reservation Utilities | SynXis Developer Portal

What is it?

With the Reservation Utilities API, you can use the endpoints to manage supplemental information that can be included with reservations on the SynXis Platform. You can use the data from these endpoints to enable a custom booking engine, call center application, property management system, or other application to manage reservations for a hotel in the SynXis Enterprise Platform.

You can use these endpoints in conjunction with the Reservation Services API.

Before You Begin

You must authenticate before you can use this API. For full instructions, see Get a Token for REST APIs.
At any time, you can go to this API's Reference Documentation tab, where you can make test calls with the following endpoints.

How to use

This section covers the endpoints for this API and examples of how to use them.

GET booking preferences

This endpoint enables you to retrieve a list of booking preferences to use when you create or modify a group, so that the system can track how the group was booked.

[GET] /v1/api/reservation/lists/bookingPreferences

Response in JSON

{
  "BookingMethodList": [
    {
      "code": "IBIZ",
      "name": "International business travel",
      "level": "Hotel"
    }
  ]
}

GET reservation reasons

This endpoint enables you to retrieve Cancel Reasons, Rate Override Reasons, Room Upgrade Reasons, and Tax Exemption Reasons in a single response, instead of calling the individual operations.

[GET] /v1/api/reservation/lists/reservationReasons

Response in JSON

{
  "cancelreasons": {
    "cancelReasons": [
      {
        "code": "FAM",
        "description": "Family Issues",
        "hotel": {
          "id": 13098,
          "code": "CHANCON2",
          "name": "SynXis Test Hotel"
        }
      }
    ]
  },
  "rateoverridereasons": {
    "rateoverridereasons": [
      {
        "code": "MGR",
        "description": "Manager Approval",
        "isdefault": false
      }
    ]
  },
  "roomupgradereasons": {
    "roomupgradereasons": [
      {
        "code": "VIP",
        "description": "VIP Guest",
        "isdefault": false
      }
    ]
  },
  "taxexemptionreasons": {
    "taxexemptreasons": [
      {
        "exemptReasonType": "FederalTaxExempt",
        "code": "FEDERAL",
        "description": "Federal Exemption",
        "sortOrder": 1
      }
    ]
  }
}

GET cancel reasons

This endpoint enables you to retrieve a list of standardized reasons that customers can select when they cancel reservations.

[GET] /v1/api/reservation/lists/cancelReasons

Response in JSON

{
  "cancelReasons": [
    {
      "code": "FAM",
      "description": "Family Issues",
      "hotel": {
        "id": 13098,
        "code": "CHANCON2",
        "name": "SynXis Test Hotel"
      },
      "level": "Hotel",
      "type": "Property"
    }
  ]
}

GET room upgrade reasons

This endpoint enables you to retrieve a list of standardized reasons that customers can select when they upgrade a room.

[GET] /v1/api/reservation/lists/roomUpgradeReasons

Response in JSON

{
  "roomupgradereasons": [
    {
      "code": "VIP",
      "description": "VIP Guest",
      "isdefault": false
    }
  ]
}

GET rate override reasons

This endpoint enables you to retrieve a list of standardized reasons that agents can select when they perform a rate override.

[GET] /v1/api/reservation/lists/rateOverrideReasons

Response in JSON

{
  "rateoverridereasons": [
    {
      "code": "MGR",
      "description": "Manager Approval",
      "isdefault": false
    }
  ]
}

GET tax exemption reasons

This endpoint enables you to retrieve a list of standardized tax exemption reasons.

[GET] /v1/api/reservation/lists/taxExemptionReasons

Response in JSON

{
  "taxexemptreasons": [
    {
      "exemptReasonType": "MilitaryEmployeeTaxExempt",
      "code": "MILITARY",
      "description": "Military Staff Exemption",
      "sortOrder": 0
    },
    {
      "exemptReasonType": "FederalTaxExempt",
      "code": "FEDERAL",
      "description": "Federal Exemption",
      "sortOrder": 1
    }
  ]
}

GET market sources

This endpoint enables you to retrieve a list of market sources for a hotel. The market sources are based on the content management strategy defined by the primary chain.

[GET] /v1/api/reservation/lists/marketSources

Response in JSON

{
  "marketSources": [
    {
      "code": "Meta",
      "level": "Brand",
      "name": "META search engines",
      "isdefault": false
    }
  ]
}

GET market segments

This endpoint enables you to retrieve a list of market segments for a hotel. Market segments are used to track geographic, demographic, or other customer classifications targeted by a hotel or chain for the purchase and use of products and services. For example, a hotel can determine its use of advertising dollars based on the type of travelers who stay in the hotel.

[GET] /v1/api/reservation/lists/marketSegments

Response in JSON

{
  "marketSegments": [
    {
      "code": "MS1",
      "businessCode": "BS1",
      "leisureCode": "LS1",
      "level": "Hotel",
      "name": "Local Promotion",
      "isdefault": false
    }
  ]
}