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",
        "stateName": "British Columbia",
        "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",
        "stateName": "British Columbia",
        "countryCode": "CA",
        "postalCode": "V5K 0A1"
      },
      "leadRate": {
        "avgNightlyRate": {
          "amount": 190.95,
          "currencyCode": "USD"
        },
        "isTaxAndFeesInclusive": false
      },
      "availabilityStatus": "AVAILABLE_FOR_SALE",
      "onRequest": true,
      "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,
            "rateDetailsCallRequired" : true,
            "totalPrice": {
              "totalBeforeTax": 170.95,
              "taxes": 10,
              "taxesBreakdown": [
                {
                  "amount": 5,
                  "fttCode": 1,
                  "inclusive": true
                },
                {
                  "amount": 5,
                  "fttCode": 2,
                  "inclusive": true
                }
              ],
              "fees": 10,
              "feesBreakdown": [
                {
                  "amount": 5,
                  "fttCode": 5,
                  "inclusive": true
                },
                {
                  "amount": 5,
                  "fttCode": 6,
                  "inclusive": true
                }
              ],              
              "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": {
              "description": "Some fees are not refundable",
              "penalties": [
                {
                  "cancelDeadline": "2017-07-21T17:32:28",
                  "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
          }
        }
      ]
    }
  ]
}

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,
        "taxesBreakdown": [
            {
              "amount": 5,
              "fttCode": 1,
              "inclusive": true
            },
            {
              "amount": 5,
              "fttCode": 2,
              "inclusive": true
            }
        ],
        "feesBreakdown": [
            {
              "amount": 5,
              "fttCode": 5,
              "inclusive": true
            },
            {
              "amount": 5,
              "fttCode": 6,
              "inclusive": true
            }
        ],              
        "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": {
        "description": "Some fees are not refundable",
        "penalties": [
          {
            "cancelDeadline": "2017-07-21T17:32:28",
            "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"
        }
      ],
      "checkInTime": "16:00",
      "checkOutTime": "11:00"
    }
  ]
}

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

{
  "bookingUuid": "123e4567-e89b-12d3-a456-426614174000",
  "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",
        "stateName": "British Columbia",
        "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",
      "stateName": "British Columbia",
      "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",
      "stateName": "British Columbia",
      "countryCode": "CA",
      "postalCode": "V5K 0A1"
    }
  },
  "threeDSecure": {
    "avv": "string",
    "cavvAlgorithm": "string",
    "messageVersion": "string",
    "transactionId": "string",
    "threeDSServerTransactionId": "string",
    "eci": "string",
    "exemptionCode": "string"
  },
  "tripUuid": "123e4567-e89b-12d3-a456-426614174000"
}

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",
      "stateName": "British Columbia",
      "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,
      "taxesBreakdown": [
          {
            "amount": 5,
            "fttCode": 1,
            "inclusive": true
          },
          {
            "amount": 5,
            "fttCode": 2,
            "inclusive": true
          }
      ],
      "feesBreakdown": [
          {
            "amount": 5,
            "fttCode": 5,
            "inclusive": false
          },
          {
            "amount": 5,
            "fttCode": 6,
            "inclusive": false
          }
      ],              
      "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": {
      "description": "Some fees are not refundable",
      "penalties": [
        {
          "cancelDeadline": "2017-07-21T17:32:28",
          "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",
        "stateName": "British Columbia",
        "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",
      "stateName": "British Columbia",
      "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": {
      "description": "Some fees are not refundable",
      "penalties": [
        {
          "cancelDeadline": "2017-07-21T17:32:28",
          "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",
        "stateName": "British Columbia",
        "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",
          "stateName": "British Columbia",
          "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",
        "stateName": "British Columbia",
        "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",
        "stateName": "British Columbia",
        "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",
      "stateName": "British Columbia",
      "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": {
      "description": "Some fees are not refundable",
      "penalties": [
        {
          "cancelDeadline": "2017-07-21T17:32:28",
          "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",
        "stateName": "British Columbia",
        "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"
}

On this page