Direct Connect - Hotel Service v4 - Endpoints

Search Hotels

Perform the initial search for hotels.

URI

POST /hotels/search

Parameters

Name Type Format Description
Accept-Language string - -
concur-correlationid string - Required This unique code can be used during troubleshooting as it identifies the API call in the log files.
body SearchCriteria - Required Hotel search criteria.

Examples

Request

{
  "requestorInfo": {
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "loginId": "abc@concur.com",
    "bookingForSelf": true
  },
  "numGuests": 1,
  "guestCountryCode": "CA",
  "locationSearch": {
    "location": {
      "geoLocation": {
        "latitude": 49.246292,
        "longitude": -123.116226
      },
      "locationType": "Hotel",
      "name": "Sheraton DFW Airport Hotel",
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "state": "BC",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      },
      "iataCode": "string"
    },
    "radius": {
      "value": 5,
      "unit": "MILE"
    },
    "maxRadius": {
      "value": 5,
      "unit": "MILE"
    }
  },
  "hotelPropertyRefs": [
    {
      "chainCode": "HH",
      "propertyCode": "HH498949"
    }
  ],
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "customFields": [
    {
      "name": "OrgUnit",
      "value": "Travel Agents"
    }
  ],
  "includeDepositRequired": true,
  "rateCategories": [
    {
      "otaCode": 1,
      "value": "AAA"
    }
  ],
  "maxSearchResults": 100
}

Response

{
  "hotelProperties": [
    {
      "propertyCode": "HH498949",
      "altPropertyCode": {
        "catalogCode": "HH498949",
        "catalogName": "NORTHSTAR"
      },
      "chainCode": "HH",
      "superChainCode": "EM",
      "hotelName": "JW Marriott Parq",
      "contactInfo": {
        "phoneNumbers": [
          "+1-555-555-1234"
        ],
        "faxNumber": "+1-555-555-5678",
        "emails": [
          "user@example.com"
        ]
      },
      "position": {
        "latitude": 49.246292,
        "longitude": -123.116226
      },
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "state": "BC",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      },
      "leadRate": {
        "avgNightlyRate": {
          "amount": 190.95,
          "currencyCode": "USD"
        },
        "isTaxAndFeesInclusive": false
      },
      "availabilityStatus": "AVAILABLE_FOR_SALE",
      "preferenceRank": "PREFERRED",
      "preferenceLevel": "CHAIN",
      "amenities": [
        {
          "amenityCode": 0
        }
      ],
      "leadImageURI": "https://images.samplehost.com/samplepath/leadimage.jpg",
      "rating": {
        "value": 4,
        "source": "NORTHSTAR"
      },
      "sustainabilityAwards": [
        {
          "label": "LEED",
          "level": "Gold"
        }
      ]
    }
  ],
  "searchSessionToken": "b41168ba-7ee1-4b68-9934-47f5c55337d6"
}

Rates

Retrieve rates for specific hotel properties. Please note that /hotels/rate-details is optional if guarantee, cancelPenalties and nightlyPrices are provided as a part of this call and rateDetailsCallRequired flag is not set. Also, the feature of filtering rates by Refundable and Prepay Required during hotel shopping requires refundable and prepayRequired attributes to be present.

URI

POST /hotels/rates

Parameters

Name Type Format Description
Accept-Language string - -
concur-correlationid string - Required This unique code can be used during troubleshooting as it identifies the API call in the log files.
body RatesCriteria - Required Hotel rates criteria.

Examples

Request

{
  "requestorInfo": {
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "loginId": "abc@concur.com",
    "bookingForSelf": true
  },
  "hotelPropertyRefs": [
    {
      "chainCode": "HH",
      "propertyCode": "HH498949"
    }
  ],
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "rateCategories": [
    {
      "otaCode": 1,
      "value": "AAA"
    }
  ],
  "numGuests": 1,
  "guestCountryCode": "CA",
  "searchSessionToken": "b41168ba-7ee1-4b68-9934-47f5c55337d6"
}

Response

{
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "hotelRates": [
    {
      "propertyCode": "HH498949",
      "rates": [
        {
          "bedding": [
            {
              "quantity": 1,
              "bedTypeCode": 3
            }
          ],
          "mealsIncluded": [
            19
          ],
          "roomDescription": [
            "1 bedroom luxury suite",
            "hearing accessible",
            "workspace",
            "garden facing balcony"
          ],
          "roomAmenities": [
            {
              "amenityCode": 0
            }
          ],
          "roomType": 82,
          "roomRate": {
            "rateDescription": [
              "Promotional Rate"
            ],
            "rateCategory": {
              "otaCode": 1,
              "value": "AAA"
            },
            "rateChangesOverStay": true,
            "roomId": "kVNU66KLxuggtu2H",
            "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ",
            "guarantee": {
              "guaranteeType": "DEPOSIT_REQUIRED",
              "acceptedPayments": [
                "VISA"
              ],
              "cvvRequired": true,
              "amountPercent": {
                "taxInclusive": true,
                "feesInclusive": true,
                "numberOfNights": 5,
                "basisType": "FULL_STAY",
                "applyAs": "FIRST_NIGHT_DEPOSIT",
                "percent": 10.05,
                "amount": {
                  "amount": 190.95,
                  "currencyCode": "USD"
                }
              }
            },
            "prepayRequired": true,
            "refundable": true,
            "totalPrice": {
              "totalBeforeTax": 170.95,
              "taxes": 10,
              "fees": 10,
              "totalAfterTax": 190.95,
              "currencyCode": "USD",
              "isTotalBeforeTaxDisplayEligible": true
            },
            "nightlyPrices": [
              {
                "basePrice": 89.95,
                "taxes": {
                  "amount": 5.55,
                  "taxBreakdown": [
                    {}
                  ]
                },
                "fees": {
                  "amount": 10.95,
                  "feeBreakdown": [
                    {}
                  ]
                },
                "totalPrice": 100.05,
                "startDate": "2021-12-01",
                "endDate": "2021-12-31",
                "currencyCode": "USD"
              }
            ],
            "cancelPenalties": {
              "penalties": [
                {
                  "cancelDeadline": "2017-07-21T17:32:28Z",
                  "description": "Free cancellation up to 1 week before checkin",
                  "refundableStatus": "FULLY_REFUNDABLE",
                  "amountPercent": {
                    "taxInclusive": true,
                    "feesInclusive": true,
                    "numberOfNights": 5,
                    "basisType": "FULL_STAY",
                    "applyAs": "FIRST_NIGHT_DEPOSIT",
                    "percent": 10.05,
                    "amount": {}
                  }
                }
              ]
            }
          },
          "source": {
            "name": "Expedia",
            "logo": "https://images.samplehost.com/samplepath/sourceLogo.png",
            "suppress": true
          },
          "rateDetailsCallRequired" : true
        }
      ]
    }
  ]
}

Rate Details

Retrieve hotel rate details for rates of a property. This endpoint is used and required when details including guarantee, cancePenalties and nightlyRates breakdown are missing from /hotels/rates call or rateDetailsCallRequired flag is set to true for a given rate.

URI

POST /hotels/ratedetails

Parameters

Name Type Format Description
Accept-Language string - -
concur-correlationid string - Required This unique code can be used during troubleshooting as it identifies the API call in the log files.
body RateDetailsCriteria - Required Hotel rates criteria.

Examples

Request

{
  "requestorInfo": {
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "loginId": "abc@concur.com",
    "bookingForSelf": true
  },
  "hotelPropertyRef": {
    "chainCode": "HH",
    "propertyCode": "HH498949"
  },
  "ratePlanIds": [
    "44SM3FAsfvgcZs9ehGlNOQ"
  ],
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "rateCategories": [
    {
      "otaCode": 1,
      "value": "AAA"
    }
  ],
  "numGuests": 1,
  "guestCountryCode": "CA",
  "searchSessionToken": "b41168ba-7ee1-4b68-9934-47f5c55337d6"
}

Response

{
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "roomRates": [
    {
      "rateDescription": [
        "Promotional Rate"
      ],
      "rateCategory": {
        "otaCode": 1,
        "value": "AAA"
      },
      "rateChangesOverStay": true,
      "roomId": "kVNU66KLxuggtu2H",
      "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ",
      "guarantee": {
        "guaranteeType": "DEPOSIT_REQUIRED",
        "acceptedPayments": [
          "VISA"
        ],
        "cvvRequired": true,
        "amountPercent": {
          "taxInclusive": true,
          "feesInclusive": true,
          "numberOfNights": 5,
          "basisType": "FULL_STAY",
          "applyAs": "FIRST_NIGHT_DEPOSIT",
          "percent": 10.05,
          "amount": {
            "amount": 190.95,
            "currencyCode": "USD"
          }
        }
      },
      "prepayRequired": true,
      "refundable": true,
      "totalPrice": {
        "totalBeforeTax": 170.95,
        "taxes": 10,
        "fees": 10,
        "totalAfterTax": 190.95,
        "currencyCode": "USD",
        "isTotalBeforeTaxDisplayEligible": true
      },
      "nightlyPrices": [
        {
          "basePrice": 89.95,
          "taxes": {
            "amount": 5.55,
            "taxBreakdown": [
              {
                "amount": 8.05,
                "fttCode": 15,
                "inclusive": true
              }
            ]
          },
          "fees": {
            "amount": 10.95,
            "feeBreakdown": [
              {
                "amount": 8.05,
                "fttCode": 15,
                "inclusive": true
              }
            ]
          },
          "totalPrice": 100.05,
          "startDate": "2021-12-01",
          "endDate": "2021-12-31",
          "currencyCode": "USD"
        }
      ],      
      "cancelPenalties": {
        "penalties": [
          {
            "cancelDeadline": "2017-07-21T17:32:28Z",
            "description": "Free cancellation up to 1 week before checkin",
            "refundableStatus": "FULLY_REFUNDABLE",
            "amountPercent": {
              "taxInclusive": true,
              "feesInclusive": true,
              "numberOfNights": 5,
              "basisType": "FULL_STAY",
              "applyAs": "FIRST_NIGHT_DEPOSIT",
              "percent": 10.05,
              "amount": {
                "amount": 190.95,
                "currencyCode": "USD"
              }
            }
          }
        ]
      }
    }
  ]
}

Hotel Details

Retrieve descriptive details about specified hotels.

URI

POST /hotels/details

Parameters

Name Type Format Description
Accept-Language string - -
concur-correlationid string - Required This unique code can be used during troubleshooting as it identifies the API call in the log files.
body HotelDetailsCriteria - Required Hotel details criteria.

Examples

Request

{
  "requestorInfo": {
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "loginId": "abc@concur.com",
    "bookingForSelf": true
  },
  "hotelCodes": [
    {
      "chainCode": "HH",
      "propertyCode": "HH498949"
    }
  ],
  "searchSessionToken": "b41168ba-7ee1-4b68-9934-47f5c55337d6"
}

Response

{
  "hotelDetailsList": [
    {
      "propertyRef": {
        "chainCode": "HH",
        "propertyCode": "HH498949"
      },
      "hotelDescriptiveInfo": {
        "propertyDescription": "Offering a restaurant and a fitness centre, Hilton Garden Inn Long Island City is located in Long Island City. Free WiFi access is available. Each room here will provide you with a TV. Complete with a microwave, the dining area also has a refrigerator and a coffee machine. Guests will enjoy a full service restaurant and bar with evening room service. Other facilities offered at the property include a shared lounge and luggage storage. LaGuardia Airport is 8 km away. Guests are required to show a photo identification and credit card upon check-in. Please note that all Special Requests are subject to availability and additional charges may apply. Due to Coronavirus (COVID-19), wearing a face mask is mandatory in all indoor common areas. In response to Coronavirus (COVID-19), additional safety and sanitation measures are currently in effect at this property. Food & beverage services at this property may be limited or unavailable due to Coronavirus (COVID-19). Due to Coronavirus (COVID-19), this property is taking steps to help protect the safety of guests and staff. Certain services and amenities may be reduced or unavailable as a result. Please note that the Extra Bed / Crib is subject to availability. The property will be under renovations to the lobby bar and lounge area from 6 January 2020 until 30 March 2020.\n",
        "descriptiveInfos": [
          {
            "otaCode": 8,
            "contents": [
              "Check-in at 3:00PM",
              "Check-out at 11:00AM"
            ],
            "startDate": "2021-10-20",
            "endDate": "2021-11-20"
          }
        ]
      },
      "mediaItems": [
        {
          "url": "https://images.samplehost.com/samplepath/hotelEntrance.jpg",
          "category": 0,
          "description": "Hotel entrance",
          "type": "IMAGE"
        }
      ]
    }
  ]
}

Reservation

Reserve a hotel rate.

URI

POST /hotels/reservation

Parameters

Name Type Format Description
Accept-Language string - -
concur-correlationid string - Required This unique code can be used during troubleshooting as it identifies the API call in the log files.
body ReservationCriteria - Required Reservation criteria.

Examples

Request

{
  "hotelPropertyRef": {
    "chainCode": "HH",
    "propertyCode": "HH498949"
  },
  "requestorInfo": {
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "loginId": "abc@concur.com",
    "bookingForSelf": true
  },
  "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ",
  "guests": [
    {
      "firstname": "Blake",
      "lastname": "Smith",
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "state": "BC",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      },
      "companyName": "SAP Concur",
      "contactInfo": {
        "phoneNumbers": [
          "+1-555-555-1234"
        ],
        "faxNumber": "+1-555-555-5678",
        "emails": [
          "user@example.com"
        ]
      },
      "birthdate": "1990-04-17"
    }
  ],
  "paymentModeIndicator": "PersonalCard",
  "guarantee": {
    "cardType": "VISA",
    "cardNumber": "4242-4242-4242-4242",
    "cardExpiryMonth": 1,
    "cardExpiryYear":2030,
    "cvv": "369",
    "cardHolderName": "John Smith",
    "cardHolderAddress": {
      "addressLines": [
        "910 Mainland Street"
      ],
      "city": "Vancouver",
      "state": "BC",
      "countryCode": "CA",
      "postalCode": "V5K 0A1"
    }
  },
  "loyalty": {
    "programCode": "EM",
    "accountId": "209875030"
  },
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "comments": [
    "Accessible",
    "NonSmoking",
    "Upper floor away from elevator"
  ],
  "customFields": [
    {
      "name": "OrgUnit",
      "value": "Travel Agents"
    }
  ],
  "searchSessionToken": "b41168ba-7ee1-4b68-9934-47f5c55337d6",
  "legalEntity": {
    "name": "My Great Company",
    "taxId": "111-11-1111",
    "address": {
      "addressLines": [
        "910 Mainland Street"
      ],
      "city": "Vancouver",
      "state": "BC",
      "countryCode": "CA",
      "postalCode": "V5K 0A1"
    }
  },
  "threeDSecure": {
    "avv": "string",
    "cavvAlgorithm": "string",
    "messageVersion": "string",
    "transactionId": "string",
    "threeDSServerTransactionId": "string",
    "eci": "string",
    "exemptionCode": "string"
  }
}

Response

{
  "confirmationCodes": [
    {
      "codeType": "SUPPLIER_CONFIRMATION",
      "code": "3704188022P5683"
    }
  ],
  "status": "RESERVED",
  "basicHotelProperty": {
    "propertyCode": "HH498949",
    "chainCode": "HH",
    "hotelName": "JW Marriott Parq",
    "contactInfo": {
      "phoneNumbers": [
        "+1-555-555-1234"
      ],
      "faxNumber": "+1-555-555-5678",
      "emails": [
        "user@example.com"
      ]
    },
    "position": {
      "latitude": 49.246292,
      "longitude": -123.116226
    },
    "address": {
      "addressLines": [
        "910 Mainland Street"
      ],
      "city": "Vancouver",
      "state": "BC",
      "countryCode": "CA",
      "postalCode": "V5K 0A1"
    },
    "cityCode": "DFW"
  },
  "roomRate": {
    "rateDescription": [
      "Promotional Rate"
    ],
    "rateCategory": {
      "otaCode": 1,
      "value": "AAA"
    },
    "rateChangesOverStay": true,
    "roomId": "kVNU66KLxuggtu2H",
    "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ",
    "guarantee": {
      "guaranteeType": "DEPOSIT_REQUIRED",
      "acceptedPayments": [
        "VISA"
      ],
      "cvvRequired": true,
      "amountPercent": {
        "taxInclusive": true,
        "feesInclusive": true,
        "numberOfNights": 5,
        "basisType": "FULL_STAY",
        "applyAs": "FIRST_NIGHT_DEPOSIT",
        "percent": 10.05,
        "amount": {
          "amount": 190.95,
          "currencyCode": "USD"
        }
      }
    },
    "prepayRequired": true,
    "refundable": true,
    "totalPrice": {
      "totalBeforeTax": 170.95,
      "taxes": 10,
      "fees": 10,
      "totalAfterTax": 190.95,
      "currencyCode": "USD",
      "isTotalBeforeTaxDisplayEligible": true
    },
    "nightlyPrices": [
      {
        "basePrice": 89.95,
        "taxes": {
          "amount": 5.55,
          "taxBreakdown": [
            {
              "amount": 8.05,
              "fttCode": 15,
              "inclusive": true
            }
          ]
        },
        "fees": {
          "amount": 10.95,
          "feeBreakdown": [
            {
              "amount": 8.05,
              "fttCode": 15,
              "inclusive": true
            }
          ]
        },
        "totalPrice": 100.05,
        "startDate": "2021-12-01",
        "endDate": "2021-12-31",
        "currencyCode": "USD"
      }
    ],
    "cancelPenalties": {
      "penalties": [
        {
          "cancelDeadline": "2017-07-21T17:32:28Z",
          "description": "Free cancellation up to 1 week before checkin",
          "refundableStatus": "FULLY_REFUNDABLE",
          "amountPercent": {
            "taxInclusive": true,
            "feesInclusive": true,
            "numberOfNights": 5,
            "basisType": "FULL_STAY",
            "applyAs": "FIRST_NIGHT_DEPOSIT",
            "percent": 10.05,
            "amount": {
              "amount": 190.95,
              "currencyCode": "USD"
            }
          }
        }
      ]
    }
  },
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "guests": [
    {
      "firstname": "Blake",
      "lastname": "Smith",
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "state": "BC",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      },
      "companyName": "SAP Concur",
      "contactInfo": {
        "phoneNumbers": [
          "+1-555-555-1234"
        ],
        "faxNumber": "+1-555-555-5678",
        "emails": [
          "user@example.com"
        ]
      },
      "birthdate": "1990-04-17"
    }
  ],
  "roomDescription": [
    "1 bedroom luxury suite",
    "hearing accessible",
    "workspace",
    "garden facing balcony"
  ],
  "comments": [
    "Accessible",
    "NonSmoking",
    "Upper floor away from elevator"
  ],
  "isModifiable": true
}

Read

Read reservation details. This endpoint is utilized for two purposes:

  1. Used by automatic Concur process as part of reserving a hotel to acknowledge receipt of booking confirmation as well as write information to Itinerary.
  2. Used to sync current state of booking (sync offline booking changes) from supplier system as and when needed, e.g. user opening his trip in trip library.

URI

POST /hotels/reservation/read

Parameters

Name Type Format Description
Accept-Language string - -
concur-correlationid string - Required This unique code can be used during troubleshooting as it identifies the API call in the log files.
body ReadCriteria - Required Read itinerary criteria.

Examples

Request

{
  "requestorInfo": {
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "loginId": "abc@concur.com",
    "bookingForSelf": true
  },
  "confirmationCodes": [
    {
      "codeType": "SUPPLIER_CONFIRMATION",
      "code": "3704188022P5683"
    }
  ]
}

Response

{
  "confirmationCodes": [
    {
      "codeType": "SUPPLIER_CONFIRMATION",
      "code": "3704188022P5683"
    }
  ],
  "status": "RESERVED",
  "basicHotelProperty": {
    "propertyCode": "HH498949",
    "chainCode": "HH",
    "hotelName": "JW Marriott Parq",
    "contactInfo": {
      "phoneNumbers": [
        "+1-555-555-1234"
      ],
      "faxNumber": "+1-555-555-5678",
      "emails": [
        "user@example.com"
      ]
    },
    "position": {
      "latitude": 49.246292,
      "longitude": -123.116226
    },
    "address": {
      "addressLines": [
        "910 Mainland Street"
      ],
      "city": "Vancouver",
      "state": "BC",
      "countryCode": "CA",
      "postalCode": "V5K 0A1"
    },
    "cityCode": "DFW"
  },
  "roomRate": {
    "rateDescription": [
      "Promotional Rate"
    ],
    "rateCategory": {
      "otaCode": 1,
      "value": "AAA"
    },
    "rateChangesOverStay": true,
    "roomId": "kVNU66KLxuggtu2H",
    "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ",
    "guarantee": {
      "guaranteeType": "DEPOSIT_REQUIRED",
      "acceptedPayments": [
        "VISA"
      ],
      "cvvRequired": true,
      "amountPercent": {
        "taxInclusive": true,
        "feesInclusive": true,
        "numberOfNights": 5,
        "basisType": "FULL_STAY",
        "applyAs": "FIRST_NIGHT_DEPOSIT",
        "percent": 10.05,
        "amount": {
          "amount": 190.95,
          "currencyCode": "USD"
        }
      }
    },
    "prepayRequired": true,
    "refundable": true,
    "totalPrice": {
      "totalBeforeTax": 170.95,
      "taxes": 10,
      "fees": 10,
      "totalAfterTax": 190.95,
      "currencyCode": "USD"
    },
    "nightlyPrices": [
      {
        "basePrice": 89.95,
        "taxes": {
          "amount": 5.55,
          "taxBreakdown": [
            {
              "amount": 8.05,
              "fttCode": 15,
              "inclusive": true
            }
          ]
        },
        "fees": {
          "amount": 10.95,
          "feeBreakdown": [
            {
              "amount": 8.05,
              "fttCode": 15,
              "inclusive": true
            }
          ]
        },
        "totalPrice": 100.05,
        "startDate": "2021-12-01",
        "endDate": "2021-12-31",
        "currencyCode": "USD"
      }
    ],
    "cancelPenalties": {
      "penalties": [
        {
          "cancelDeadline": "2017-07-21T17:32:28Z",
          "description": "Free cancellation up to 1 week before checkin",
          "refundableStatus": "FULLY_REFUNDABLE",
          "amountPercent": {
            "taxInclusive": true,
            "feesInclusive": true,
            "numberOfNights": 5,
            "basisType": "FULL_STAY",
            "applyAs": "FIRST_NIGHT_DEPOSIT",
            "percent": 10.05,
            "amount": {
              "amount": 190.95,
              "currencyCode": "USD"
            }
          }
        }
      ]
    }
  },
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "guests": [
    {
      "firstname": "Blake",
      "lastname": "Smith",
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "state": "BC",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      },
      "companyName": "SAP Concur",
      "contactInfo": {
        "phoneNumbers": [
          "+1-555-555-1234"
        ],
        "faxNumber": "+1-555-555-5678",
        "emails": [
          "user@example.com"
        ]
      },
      "birthdate": "1990-04-17"
    }
  ],
  "roomDescription": [
    "1 bedroom luxury suite",
    "hearing accessible",
    "workspace",
    "garden facing balcony"
  ],
  "comments": [
    "Accessible",
    "NonSmoking",
    "Upper floor away from elevator"
  ],
  "isModifiable": true
}

Modify

Modify a specific reservation.

URI

POST /hotels/reservation/modify

Parameters

Name Type Format Description
Accept-Language string - -
concur-correlationid string - Required This unique code can be used during troubleshooting as it identifies the API call in the log files.
body ModifyCriteria - Required Modify reservation criteria.

Examples

Request

{
  "reservationCriteria": {
    "hotelPropertyRef": {
      "chainCode": "HH",
      "propertyCode": "HH498949"
    },
    "requestorInfo": {
      "posRequestorId": "abc1234",
      "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
      "loginId": "abc@concur.com",
      "bookingForSelf": true
    },
    "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ",
    "guests": [
      {
        "firstname": "Blake",
        "lastname": "Smith",
        "address": {
          "addressLines": [
            "910 Mainland Street"
          ],
          "city": "Vancouver",
          "state": "BC",
          "countryCode": "CA",
          "postalCode": "V5K 0A1"
        },
        "companyName": "SAP Concur",
        "contactInfo": {
          "phoneNumbers": [
            "+1-555-555-1234"
          ],
          "faxNumber": "+1-555-555-5678",
          "emails": [
            "user@example.com"
          ]
        },
        "birthdate": "1990-04-17"
      }
    ],
    "paymentModeIndicator": "PersonalCard",
    "guarantee": {
      "cardType": "VISA",
      "cardNumber": "4242-4242-4242-4242",
      "cardExpiryMonth": 1,
      "cardExpiryYear":2030,
      "cvv": "369",
      "cardHolderName": "John Smith",
      "cardHolderAddress": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "state": "BC",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      }
    },
    "loyalty": {
      "programCode": "EM",
      "accountId": "209875030"
    },
    "checkin": "2021-10-20",
    "checkout": "2021-10-23",
    "comments": [
      "Accessible",
      "NonSmoking",
      "Upper floor away from elevator"
    ],
    "customFields": [
      {
        "name": "OrgUnit",
        "value": "Travel Agents"
      }
    ],
    "searchSessionToken": "b41168ba-7ee1-4b68-9934-47f5c55337d6",
    "legalEntity": {
      "name": "My Great Company",
      "taxId": "111-11-1111",
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "state": "BC",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      }
    },
    "threeDSecure": {
      "avv": "string",
      "cavvAlgorithm": "string",
      "messageVersion": "string",
      "transactionId": "string",
      "threeDSServerTransactionId": "string",
      "eci": "string",
      "exemptionCode": "string"
    }
  },
  "confirmationCodes": [
    {
      "codeType": "SUPPLIER_CONFIRMATION",
      "code": "3704188022P5683"
    }
  ]
}

Response

{
  "confirmationCodes": [
    {
      "codeType": "SUPPLIER_CONFIRMATION",
      "code": "3704188022P5683"
    }
  ],
  "status": "RESERVED",
  "basicHotelProperty": {
    "propertyCode": "HH498949",
    "chainCode": "HH",
    "hotelName": "JW Marriott Parq",
    "contactInfo": {
      "phoneNumbers": [
        "+1-555-555-1234"
      ],
      "faxNumber": "+1-555-555-5678",
      "emails": [
        "user@example.com"
      ]
    },
    "position": {
      "latitude": 49.246292,
      "longitude": -123.116226
    },
    "address": {
      "addressLines": [
        "910 Mainland Street"
      ],
      "city": "Vancouver",
      "state": "BC",
      "countryCode": "CA",
      "postalCode": "V5K 0A1"
    },
    "cityCode": "DFW"
  },
  "roomRate": {
    "rateDescription": [
      "Promotional Rate"
    ],
    "rateCategory": {
      "otaCode": 1,
      "value": "AAA"
    },
    "rateChangesOverStay": true,
    "roomId": "kVNU66KLxuggtu2H",
    "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ",
    "guarantee": {
      "guaranteeType": "DEPOSIT_REQUIRED",
      "acceptedPayments": [
        "VISA"
      ],
      "cvvRequired": true,
      "amountPercent": {
        "taxInclusive": true,
        "feesInclusive": true,
        "numberOfNights": 5,
        "basisType": "FULL_STAY",
        "applyAs": "FIRST_NIGHT_DEPOSIT",
        "percent": 10.05,
        "amount": {
          "amount": 190.95,
          "currencyCode": "USD"
        }
      }
    },
    "prepayRequired": true,
    "refundable": true,
    "totalPrice": {
      "totalBeforeTax": 170.95,
      "taxes": 10,
      "fees": 10,
      "totalAfterTax": 190.95,
      "currencyCode": "USD"
    },
    "nightlyPrices": [
      {
        "basePrice": 89.95,
        "taxes": {
          "amount": 5.55,
          "taxBreakdown": [
            {
              "amount": 8.05,
              "fttCode": 15,
              "inclusive": true
            }
          ]
        },
        "fees": {
          "amount": 10.95,
          "feeBreakdown": [
            {
              "amount": 8.05,
              "fttCode": 15,
              "inclusive": true
            }
          ]
        },
        "totalPrice": 100.05,
        "startDate": "2021-12-01",
        "endDate": "2021-12-31",
        "currencyCode": "USD"
      }
    ],
    "cancelPenalties": {
      "penalties": [
        {
          "cancelDeadline": "2017-07-21T17:32:28Z",
          "description": "Free cancellation up to 1 week before checkin",
          "refundableStatus": "FULLY_REFUNDABLE",
          "amountPercent": {
            "taxInclusive": true,
            "feesInclusive": true,
            "numberOfNights": 5,
            "basisType": "FULL_STAY",
            "applyAs": "FIRST_NIGHT_DEPOSIT",
            "percent": 10.05,
            "amount": {
              "amount": 190.95,
              "currencyCode": "USD"
            }
          }
        }
      ]
    }
  },
  "checkin": "2021-10-20",
  "checkout": "2021-10-23",
  "guests": [
    {
      "firstname": "Blake",
      "lastname": "Smith",
      "address": {
        "addressLines": [
          "910 Mainland Street"
        ],
        "city": "Vancouver",
        "state": "BC",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      },
      "companyName": "SAP Concur",
      "contactInfo": {
        "phoneNumbers": [
          "+1-555-555-1234"
        ],
        "faxNumber": "+1-555-555-5678",
        "emails": [
          "user@example.com"
        ]
      },
      "birthdate": "1990-04-17"
    }
  ],
  "roomDescription": [
    "1 bedroom luxury suite",
    "hearing accessible",
    "workspace",
    "garden facing balcony"
  ],
  "comments": [
    "Accessible",
    "NonSmoking",
    "Upper floor away from elevator"
  ]
}

Cancel

Cancel a specified reservation.

URI

POST /hotels/reservation/cancel

Parameters

Name Type Format Description
Accept-Language string - -
concur-correlationid string - Required This unique code can be used during troubleshooting as it identifies the API call in the log files.
body CancelCriteria - Required Cancel reservation criteria.

Examples

Request

{
  "requestorInfo": {
    "posRequestorId": "abc1234",
    "travelerUuid": "123e4567-e89b-12d3-a456-426614174000",
    "loginId": "abc@concur.com",
    "bookingForSelf": true
  },
  "confirmationCodes": [
    {
      "codeType": "SUPPLIER_CONFIRMATION",
      "code": "3704188022P5683"
    }
  ]
}

Response

{
  "confirmationCodes": [
    {
      "codeType": "SUPPLIER_CONFIRMATION",
      "code": "3704188022P5683"
    },
    {
      "codeType": "CANCELLATION",
      "code": "24212411"
    }
  ],
  "cancellationRemarks": "Reservation cancelled with no penalty"
}

Schemas

SearchCriteria

Search by either location or exact property reference, if available.

Name Type Format Description
requestorInfo RequestorInfo - Required Information about Point of Sale (POS), traveler, and user associated with this request.
numGuests integer int32 Number of guests for accommodation as entered by traveler.
guestCountryCode string ISO ALPHA-2 Two-character ISO code for country.
locationSearch LocationSearch - Reference to location details for search.
hotelPropertyRefs HotelPropertyRef - Reference IDs to hotel properties, if available. When provided, locationSearch will not be used and may not be set.
checkin string date Required Check in date as entered by traveler.
checkout string date Required Check out date as entered by traveler.
customFields CustomField - Custom fields that are supported by vendor. Example: CostCenter
includeDepositRequired boolean true \ false Required If true, properties where deposits are required are displayed.
rateCategories RateCategory - Special rate categories requested, if applicable.
maxSearchResults integer - Maximum number of properties allowed to be included in search results.

LocationSearch

Reference to location details for search.

Name Type Format Description
location Location - Required Defines geographic location for search.
radius Radius - Required Radius to restrict the search for hotels.
maxRadius Radius - Required Allows extended search radius for preferred hotel properties and can be more than radius defined by traveler.

RatesCriteria

Name Type Format Description
requestorInfo RequestorInfo - Required Information about POS (Point Of Sale), traveler, and user associated with this request.
hotelPropertyRefs HotelPropertyRef - Required Reference IDs for hotel properties where the rate is requested.
checkin string date Required Check in date as entered by traveler.
checkout string date Required Check out date as entered by traveler.
rateCategories RateCategory - Special rate categories requested, if applicable
numGuests integer int32 Number of guests for accommodation.
guestCountryCode string ISO ALPHA-2 Two-character ISO code for country.
searchSessionToken SearchSessionToken - Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.

RateDetailsCriteria

Name Type Format Description
requestorInfo RequestorInfo - Required Information about POS (Point Of Sale), traveler, and user associated with this request.
hotelPropertyRefs HotelPropertyRef - Required Reference IDs for hotel properties where the rate is requested.
ratePlanIds string - Required Rate product IDs for which detail rates are requested.
checkin string date Required Check in date as entered by traveler.
checkout string date Required Check out date as entered by traveler.
rateCategories RateCategory - Special rate categories requested, if applicable
numGuests integer int32 Number of guests for accommodation.
guestCountryCode string ISO ALPHA-2 Two-character ISO code for country.
searchSessionToken SearchSessionToken - Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.

HotelDetailsCriteria

Name Type Format Description
requestorInfo RequestorInfo - Required Information about POS (Point Of Sale), traveler, and user associated with this request.
hotelCodes HotelPropertyRef - Required Reference IDs for hotel properties where the rate is requested.
searchSessionToken SearchSessionToken - Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.

CustomField

Vendor supported custom field.

Name Type Format Description
name string - Required Name of the custom field.
value string - Required Value of the custom field

HotelPropertyRef

Reference to hotel property using provider specific property code.

Name Type Format Description
chainCode string - Chain code associated with hotel, if available.
propertyCode string - Required Provider’s property code as given in search response.

HotelProperty

Hotel property object returned by hotel search

Name Type Format Description
propertyCode PropertyCode - Required
altPropertyCode object - Alternate property code.
» catalogCode PropertyCode - Required Catalog code of property.
» catalogName CatalogName - Required NORTHSTAR, GIATA, and GDS (SABRE, AMADEUS, GALILEO) are preferred. Supported values: NORTHSTAR, GIATA, LEONARDO, AMADEUS, SABRE, GALILEO, CWT, EXPEDIA, HRS, BOOKING.COM
chainCode string - Chain code associated with hotel, if available.
superChainCode string - Super chain code for property.
hotelName string - Required Name of hotel.
contactInfo ContactInfo - Required Contact information for property.
position Geolocation - Geolocation of property.
address Address - Required Address of property.
leadRate LeadRate - Required The lowest nightly rate averaged over the stay.
availabilityStatus AvailabilityStatus - Required Supported values: AVAILABLE_FOR_SALE, CLOSED_OUT
preferenceRank PreferenceRank - Supported values: PREFERRED, MORE_PREFERRED, MOST_PREFERRED. This value will override any preferences set by company admins.
preferenceLevel preferenceLevel - Supported values: CHAIN, PROPERTY. Note that value can be set to CHAIN for hotels preferred at both chain or superchain level and this is what is displayed to user as UI as Preferred Chain.
amenities HotelAmenity - Required Hotel amenity containing code as described in OTA code list Hotel Amenity Code (HAC).
leadImageURI string URI Required Contains an HTTPS URL pointing to a .png or .jpg hotel image file. The image will be used as a thumbnail and should be limited to 70x70 pixels to prevent image artifacts by scaling.
rating HotelRating - Hotel rating details along with source.
sustainabilityAwards SustainabilityAward - Award/Certification related to sustainability awarded to the hotel.

HotelRating

Hotel rating details along with source.

Name Type Format Description
value integer - Required Hotel rating value should be an integer number from 1 to 5, representing the star rating.
source string - Required Source of rating. Supported values: NORTHSTAR, AAA_DIAMONDS, HOTELSTAR, STAR_RATING_AUSTRALIA

BasicHotelProperty

Name Type Format Description
propertyCode PropertyCode - Required
chainCode string - Chain code associated with hotel, if available.
hotelName string - Required Name of hotel.
contactInfo ContactInfo - Required Contact information for property.
position Geolocation - Geolocation property.
address Address - Address of property.
cityCode string IATA 3-character city code Required for adding passing segments City code for the property.

HotelMedia

Name Type Format Description
url string uri Required URL of hotel property.
category integer int32 OTA code describing the image as defined in OTA Picture Category Code (PIC) list.
description string - Description of the hotel media.
type MediaType - Required Type of media. Supported values: IMAGE

Location

Defines geolocation for search.

Name Type Format Description
geoLocation Geolocation - Required Geolocation of property.
locationType LocationType - Required Type of location associated with this search. Supported values: COMPANY_LOCATION, HOTEL, ADDRESS, PLACE, AIRPORT
name string - Required
address Address - -
iataCode string - IATA code of airport, if location type searched is AIRPORT

Geolocation

Name Type Format Description
latitude number - Required
longitude number - Required

Address

Name Type Format Description
addressLines string - Required Address of the property.
city string - Required City name.
state string - 2-character state code.
countryCode string ISO ALPHA-2 Required ISO code for country.
postalCode string - Postal or zip code of the property.

HotelRates

Name Type Format Description
propertyCode PropertyCode - Required Property code of the hotel
rates HotelRate - Required Applicable rates for the property.

HotelRate

Name Type Format Description
bedding Bedding - Details about bedding associated with the room.
mealsIncluded integer - Code based on OTA Meal Plan Type (MPT).
roomDescription string - Required Room description information.
roomAmenities RoomAmenity - Room amenity containing code as described in OTA code list Room Amenity Type (RMA).
roomType integer int32 OTA code of GRI (Guest Room Info) type providing guest room type details.
roomRate RoomRate - Required
source object - Details about the source attributed to this rate. NOTE: name must also be provided along with logo. logo - if provided is displayed as source while name is used as title/label. Nothing is displayed as source if suppress is true.
» name string - Name of the supplier for the source that can be shown in user interface.
» logo string uri URI to logo image of the supplier for the source that can be shown in user interface. Size should be at-least 84x16.
» suppress boolean true / false If true, all source attributions for this rate will be suppressed.

RateCategory

Name Type Format Description
otaCode integer int32 Required Code based on OTA Rate Plan Type (RPT).
value string - The given rate plan type code.

TotalPrice

Details about the total pricing associated with stay.

Name Type Format Description
totalBeforeTax number - Required Total price before tax.
taxes number - Additional taxes to be added to rate.
fees number - Additional fees to be added to rate.
totalAfterTax number - Total price after tax is included.
currencyCode CurrencyCode ISO 4217 Required Currency code.
isTotalBeforeTaxDisplayEligible boolean - Controls what value is shown on property details page for rates. Displays totalBeforeTax if set to true otherwise display totalAftertax. Note that totalAfterTax will be required if this is set false.

Price

Name Type Format Description
amount number - Required
currencyCode CurrencyCode ISO 4217 Required Currency code.

RoomRate

Name Type Format Description
rateDescription string - Description of the rate.
rateCategory RateCategory - -
rateChangesOverStay boolean true / false Required
roomId string - -
ratePlanId string - Required
guarantee object - Required to be part of rate call for applying travel policies
» guaranteeType GuaranteeType - Required Supported values: DEPOSIT_REQUIRED, GUARANTEE_REQUIRED, NONE
» acceptedPayments AcceptedPayments - Supported values: AMERICAN_AIRLINES, ALASKA_BARTER, AMEX, AWARD_CREDIT, CANADIAN, CARTE_BLANCHE, CHINA_UNION_PAY, CONFERMA, DELTA, DINERS_CLUB, DISCOVER, ENROUTE, EURO_CARD, JCB, MC, NORTHWEST, TWA, UATP, UNITED_TRAVEL, UNITED_CREDIT, VENDOR_PROVIDED,VISA
» cvvRequired boolean true / false -
» amountPercent AmountPercent - -
prepayRequired boolean true / false If true, prepayment is required for booking this rate.
refundable boolean true / false If true, this rate is refundable (based on all cancel penalties).
totalPrice TotalPrice - Required Details about total pricing associated with the stay.
nightlyPrices NightlyPrice - Details about nightly price for a given date range.
cancelPenalties CancelPenalties - Information about cancellation penalties.
rateDetailsCallRequired boolean true / false If true, this rate requires a call to RateDetails before being booked. Default: false

RoomRateDetails

Name Type Format Description
rateDescription string - Description of the rate.
rateCategory RateCategory - -
rateChangesOverStay boolean true / false Required
roomId string - -
ratePlanId string - Required
guarantee object - Required
» guaranteeType GuaranteeType - Required Supported values: DEPOSIT_REQUIRED, GUARANTEE_REQUIRED, NONE
» acceptedPayments AcceptedPayments - Supported values: AMERICAN_AIRLINES, ALASKA_BARTER, AMEX, AWARD_CREDIT, CANADIAN, CARTE_BLANCHE, CHINA_UNION_PAY, CONFERMA, DELTA, DINERS_CLUB, DISCOVER, ENROUTE, EURO_CARD, JCB, MC, NORTHWEST, TWA, UATP, UNITED_TRAVEL, UNITED_CREDIT, VENDOR_PROVIDED, VISA
» cvvRequired boolean true / false -
» amountPercent AmountPercent - -
prepayRequired boolean true / false If true, prepayment is required for booking this rate.
refundable boolean true / false If true, this rate is refundable (based on all cancel penalties).
totalPrice TotalPrice - Required Details about total pricing associated with the stay.
nightlyPrices NightlyPrice - Required Details about nightly price for a given date range.
cancelPenalties CancelPenalties - Required Information about cancellation penalties.

CancelPenalties

Name Type Format Description
penalties CancelPenalty - Required Cancellation penalties associated with rate. Should be empty array for non-refundable rate.

NightlyPrice

Details about nightly price for a given date range.

Name Type Format Description
basePrice number - Required
taxes Taxes - Required Representation of nightly tax amount associated with a rate along with optional breakdown.
fees Fees - Required Representation of nightly fees associated with a rate for given dates along with optional breakdown.
totalPrice number - Required Total price including taxes and fees per night
startDate string date Required
endDate string date Required
currencyCode CurrencyCode ISO 4217 Required Currency code.

CancelPenalty

Name Type Format Description
cancelDeadline string YYYY-MM-DDThh:mm:ssZ Required Date string in date-time notation as defined by RFC 3339 with time representing local time at property and corresponding timezone.
description string - Required
refundableStatus RefundableStatus - Required Supported values: FULLY_REFUNDABLE, PARTIALLY_REFUNDABLE, NON-REFUNDABLE
amountPercent AmountPercent - -

AmountPercent

Name Type Format Description
taxInclusive boolean true / false If true, all taxes are included in the returned rate.
feesInclusive boolean true / false If true, all fees are included in the returned rate.
numberOfNights integer - The number of nights that are to be spent on the property.
basisType AmountPercentBasisType - Supported values: FULL_STAY, NIGHTS, FIRST_LAST
applyAs AmountPercentApplyAs - Supported values: FIRST_NIGHT_DEPOSIT, LAST_NIGHT_DEPOSIT, FIRST_AND_LAST_NIGHT_DEPOSIT
percent number - The percentage used to calculate the amount of the cancellation fee.
amount Price - -

RequestorInfo

Information about Point of Sale (POS), traveler, and user associated with the request.

Name Type Format Description
posRequestorId string - Required The identifier of the entity making the request (e.g. ATA/IATA/ID number).
travelerUuid string - Required UUID that identifies the traveler within SAP Concur systems.
loginId string - Login ID of traveler within SAP Concur systems, if available.
bookingForSelf boolean - If true, the person logged in is making a booking for themselves.

Radius

Name Type Format Description
value integer int32 Required
unit DistanceUnit - Required Unit of distance. Supported values: MILE, KM

HotelDetails

Name Type Format Description  
propertyRef HotelPropertyRef - Required Reference to hotel property using provider specific property code.  
hotelDescriptiveInfo object - -  
» propertyDescription string - Required  
» descriptiveInfos HotelDescriptiveInfo - Required  
mediaItems HotelMedia - Hotel media items. Required

HotelDescriptiveInfo

Name Type Format Description
otaCode integer int32 Required Code based on OTA Additional Detail Type (ADT).
contents string - Required
startDate string date Start date for descriptive info, if applicable. Only for specific dates (e.g. for alerts or special events).
endDate string date End date for descriptive info, if applicable. Only for specific dates (e.g. for alerts or special events).

ReservationCriteria

Name Type Format Description
hotelPropertyRef HotelPropertyRef - Required Reference to hotel property using provider specific property code.
requestorInfo RequestorInfo - Required Information about POS, traveler, and user associated with this request.
ratePlanId string - Required
guests Guest - Required Number of guests the reservation is for.
paymentModeIndicator PaymentModeIndicator - Supported values: PERSONAL_CARD, CORPORATE_CARD, CONCUR_VIRTUAL_CARD, VENDOR_VIRTUAL_CARD
guarantee object - -
» cardType PaymentCardType - Required Supported values: AMERICAN_AIRLINES, ALASKA_BARTER, AMEX, AWARD_CREDIT, CANADIAN, CARTE_BLANCHE, CHINA_UNION_PAY, CONFERMA, DELTA, DINERS_CLUB, DISCOVER, ENROUTE, EURO_CARD, JCB, MC, NORTHWEST, TWA, UATP, UNITED_TRAVEL, UNITED_CREDIT, VISA
» cardNumber string - Required
» cardExpiryMonth integer - Expiration month for payment card
» cardExpiryYear integer - 4 digit expiration year for payment card
» cvv string - Card verification value. The three or four-digit number on the credit card for security.
» cardHolderName string - Name of the payment card holder.
» cardHolderAddress Address - Address of the payment card holder.
loyalty object - -
» programCode string - Required Loyalty program code.
» accountId string - Required Loyalty program ID.
checkin string date Required Check in date as entered by traveler.
checkout string date Required Check out date as entered by traveler.
comments string - Comments for special requests.
customFields CustomField - Required Vendor specific fields, if set up for vendor integration.
searchSessionToken SearchSessionToken - Session token to be generated and provided by server on initial search call. Can be referenced back for future calls in the same session.
legalEntity LegalEntity - Provides details about the legal entity associated with this booking, if available.
threeDSecure ThreeDSecure - 3D Secure Strong Customer Authentication payment verification parameters.

ReservationDetails

Name Type Format Description
confirmationCodes ConfirmationCode - Required
status ReservationStatus - Required Supported values: RESERVED, CANCELLED
basicHotelProperty BasicHotelProperty - Required
roomRate RoomRateDetails - Required
checkin string date Required Check in date as entered by traveler.
checkout string date Required Check out date as entered by traveler.
guests Guest - Required
roomDescription string - Required
comments string - Comments about special requests for the booking.
isModifiable boolean - Whether or not this reservation can be modified.

ConfirmationCode

Name Type Format Description
codeType ConfirmationCodeType - Required Confirmation code type that maps to OTA codes for unique ID types. Supported values: RESERVATION, SUPPLIER_CONFIRMATION, CANCELLATION, HOTEL_CONFIRMATION, CONCUR_GDS_REFERENCE, PASSIVE_CONFIRMATION
code string - Required

For details on usage of confirmation codes, please refer to Confirmation Codes section of the documentation.

Guest

Name Type Format Description
firstname string - Required
lastname string - Required
address Address - -
companyName string - Required
contactInfo ContactInfo - Required
birthdate string date -

ReadCriteria

Name Type Format Description
requestorInfo RequestorInfo - Required Information about POS, traveler, and user associated with this request.
confirmationCodes ConfirmationCode - Required

ModifyCriteria

Name Type Format Description
reservationCriteria ReservationCriteria - Required
confirmationCodes ConfirmationCode - Required

CancelCriteria

Name Type Format Description
requestorInfo RequestorInfo - Required Information about POS, traveler, and user associated with this request.
confirmationCodes ConfirmationCode - Required

CancelDetails

Name Type Format Description
confirmationCodes ConfirmationCode - Required
cancellationRemarks string - -

ContactInfo

Name Type Format Description
phoneNumbers string - Required
faxNumber string - -
emails string - Required

LeadRate

The lowest nightly rate averaged over the stay.

Name Type Format Description
avgNightlyRate Price - Required
isTaxAndFeesInclusive boolean - Whether or not tax and fees are included.

HotelAmenity

Hotel amenity containing code as described in OTA code list Hotel Amenity Code.

Name Type Format Description
amenityCode integer int32 Required

RoomAmenity

Room amenity containing code as described in OTA code list Room Amenity Type.

Name Type Format Description
amenityCode integer int32 Required

Error

Error with OTA code and description.

Name Type Format Description
otaCode integer int32 Code based on OTA Error Codes list.
message string - Required

SearchResponse

Name Type Format Description
hotelProperties HotelProperty - Required Hotel property object returned by hotel search.
searchSessionToken SearchSessionToken - Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.

RatesResponse

Name Type Format Description
checkin string date Required Check in date as entered by traveler.
checkout string date Required Check out date as entered by traveler.
hotelRates HotelRates date Required

RateDetailsResponse

Name Type Format Description
checkin string date Required Check in date as entered by traveler.
checkout string date Required Check out date as entered by traveler.
roomRates RoomRateDetails - Required

HotelDetailsResponse

Name Type Format Description
hotelDetailsList HotelDetails - Required

Bedding

Details about bedding associated with the room.

Name Type Format Description
quantity integer - Required Number of beds.
bedTypeCode integer int32 Code based on OTA Bed Type (BED) list.

Taxes

Representation of nightly tax amount associated with a rate along with optional breakdown.

Name Type Format Description
amount number - Required Amount of the taxes.
taxBreakdown FeeTaxType - Fee or tax associated with rate. Can be either included or excluded from total rate as marked with inclusive field.

Fees

Representation of nightly fees associated with a rate for given dates along with optional breakdown.

Name Type Format Description
amount number - Required Amount of the fees.
taxBreakdown FeeTaxType - Fee or tax associated with rate. Can be either included or excluded from total rate as marked with inclusive field.

FeeTaxType

Name Type Format Description
amount number - Required
fttCode integer int32 Required Code based on OTA’s Fee Tax Type (FTT) list.
inclusive boolean true / false Required If true, this tax/fee is included in totalAmountAfterTax amount.

SustainabilityAward

Award or certification related to sustainability awarded to the hotel. If certification name is not known, it is possible to use OTHER as label and provide additional name attribute.

Name Type Format Description
label SustainabilityProvider - Required Name or label of the award/certification. Supported values: GSTC,EARTH_CHECK,GREEN_GLOBE,GREEN_KEY,TRAVELIFE,GREEN_LEAF,LEED,GREEN_GROWTH_2050,GREEN_SEAL, OTHER
level string - Optional level of certification.
name string - Name of certification in case when not possible to map to currently supported labels (OTHER is used).

LegalEntity

Provides details about the legal entity associated with this booking, if available.

Name Type Format Description
name string - Required Name of the legal entity.
taxId string - Required Tax identity of the legal entity.
address Address - Address of legal entity.

ThreeDSecure

3D Secure strong customer authentication payment verification parameters.

Name Type Format Description
avv string - Required For 3DS1, this is the CAVV. For 3DS2, this is the AVV.
cavvAlgorithm string - Identifies the algorithm used to generate the CAVV for 3DS1.
messageVersion string - Required 3D Secure version.
transactionId string - Unique transaction identifier assigned by the 3DS Server to identify a single transaction.
threeDSServerTransactionId string - For 3DS1, this identifies the XID. For 3DS2, this identifies the dsTransactionId.
eci string - Required Electronic Commerce Indicator.
exemptionCode string - Identifies SCA exemption type.

On this page