Reservation Utilities

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

Header Parameters

The following table describes the header parameters for this endpoint:

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

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

Response Elements

The following table explains the elements you receive in the response:

▲ Back to top

GET reservation reasons

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

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "links":[
    {
      "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
      "rel":"self"
    }
  ],
  "cancelreasons":{
    "links":[
      {
        "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
        "rel":"self"
      }
    ],
    "cancelReasons":[
      {
        "code":"FAM",
        "description":"Family Issues",
        "level":"Hotel",
        "type":"Property",
        "hotel":{
          "id":13098,
          "code":"CHANCON2",
          "name":"SynXis Test Hotel"
        },
        "chain":{
          "id":"9139",
          "code":"SYDCTEST",
          "name":"Synxis Chain hotels"
        }
      }
    ]
  },
  "rateoverridereasons":{
    "links":[
      {
        "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
        "rel":"self"
      }
    ],
    "rateoverridereasons":[
      {
        "code":"MGR",
        "description":"Manager Approval",
        "isdefault":false
      }
    ]
  },
  "roomupgradereasons":{
    "links":[
      {
        "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
        "rel":"self"
      }
    ],
    "roomupgradereasons":[
      {
        "code":"VIP",
        "description":"VIP Guest",
        "isdefault":false
      }
    ]
  },
  "taxexemptionreasons":{
    "links":[
      {
        "href":"https://[ENDPOINT]/api/v1.0/reservation/lists/taxExemptionReasons?hotelId=11113",
        "rel":"self"
      }
    ],
    "taxexemptreasons":[
      {
        "exemptReasonType":"MilitaryEmployeeTaxExempt",
        "exemptReasonLevel":"Hotel",
        "code":"MILITARY",
        "description":"Military Staff Exemption",
        "sortOrder":0
      },
      {
        "exemptReasonType":"FederalTaxExempt",
        "exemptReasonLevel":"Chain",
        "code":"FEDERAL",
        "description":"Federal Exemption",
        "sortOrder":1
      }
    ]
  }
}

Response Elements

The following table explains the elements you receive in the response.

To make the response structure easier to follow, this table prefixes every element with the object and array structure that contains it, like this: ArrayOne.ArrayTwo.ArrayThree.Element

▲ Back to top

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "links":[
    {
      "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
      "rel":"self"
    }
  ],
  "cancelReasons":[
    {
      "code":"FAM",
      "description":"Family Issues",
      "level":"Hotel",
      "type":"Property",
      "hotel":{
        "id":13098,
        "code":"CHANCON2",
        "name":"SynXis Test Hotel"
      },
      "chain":{
        "id":"9139",
        "code":"SYDCTEST",
        "name":"Synxis Chain hotels"
      }
    }
  ]
}			

Response Elements

The following table explains the elements you receive in the response:

▲ Back to top

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "links":[
    {
      "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
      "rel":"self"
    }
  ],
  "roomupgradereasons":[
    {
      "code":"VIP",
      "description":"VIP Guest",
      "isdefault":false
    }
  ]
}             

Response Elements

The following table explains the elements you receive in the response:

▲ Back to top

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "links":[
    {
      "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
      "rel":"self"
    }
  ],
  "rateoverridereasons":[
    {
      "code":"MGR",
      "description":"Manager Approval",
      "isdefault":false
    }
  ]
}			

Response Elements

The following table explains the elements you receive in the response:

▲ Back to top

GET tax exemption reasons

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

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

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "links":[
    {
      "href":"https://[ENDPOINT]/api/v1.0/reservation/lists/taxExemptionReasons?hotelId=11113",
      "rel":"self"
    }
  ],
  "taxexemptreasons":[
    {
      "exemptReasonType":"MilitaryEmployeeTaxExempt",
      "exemptReasonLevel":"Hotel",
      "code":"MILITARY",
      "description":"Military Staff Exemption",
      "sortOrder":0
    },
    {
      "exemptReasonType":"FederalTaxExempt",
      "exemptReasonLevel":"Chain",
      "code":"FEDERAL",
      "description":"Federal Exemption",
      "sortOrder":1
    }
  ]
}			

Response Elements

The following table explains the elements you receive in the response:

▲ Back to top

POST to send a notification email

This endpoint enables you to send an email to the primary, secondary, or additional guest email addresses to notify guests that the reservation is booked.

[POST] /v1/api/reservation/notifyReservation

Header Parameters

The following table describes the header parameters for this endpoint.

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Format your post request with query parameters (without a post body), like this example (for curl):

curl -X 'POST' 'https://services-c1.synxis.com' \
  -G \
  -d 'crsConfirmationNumber=11113' \
  -d 'primaryGuest=true' \
  -d 'secondaryGuest=true' \
  -d 'additionalEmail=customer%40domain.com' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Context: WBSVC' \
  -H 'ActivityId: alkj5df-48nsn836-sjkknii' \
--data-raw ''

			

Response in JSON

{
  "links":[
    {
      "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
      "rel":"self"
    }
  ]
}			

Response Elements

The following table explains the elements you receive in the response:

▲ Back to top

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

To request the market sources, you specify a Hotel ID and (optionally) a rate code. If you specify a rate code, all the market sources in the response that are assigned to the rate will have a default value set to true.

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "links":[
    {
      "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
      "rel":"self"
    }
  ],
  "marketSources":[
    {
      "code":"Meta",
      "level":"Brand",
      "name":"META search engines",
      "isdefault":false
    }
  ],
  "pagination":{
    "total":1,
    "start":0,
    "size":0
  }
}		

Response Elements

The following table explains the elements you receive in the response:

▲ Back to top

GET market segments

This endpoint enables you to retrieve a list of market segments for a hotel.

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

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.

Query Parameters

The following table describes the elements that you can include when you query this endpoint:

Response in JSON

{
  "links":[
    {
      "href":"https://[ENDPOINT]]/reservation/api/v1.0/reservation",
      "rel":"self"
    }
  ],
  "marketSegments":[
    {
      "code":"MS1",
      "businessCode":"BS1",
      "leisureCode":"LS1",
      "level":"Hotel",
      "name":"Local Promotion",
      "isdefault":false
    }
  ],
  "pagination":{
    "total":1,
    "start":0,
    "size":0
  }
}		

Response Elements

The following table explains the elements you receive in the response:

▲ Back to top