Modify

This operation allows you to modify a previously confirmed reservation.

The following types of modifications are permitted:

  1. Add a new room to an existing booking
  2. Modify a room in an existing booking
    • Critical modifications - This includes changes in rateplan / roomtype / date changes that may lead to pricing changes
    • Non-critical modifications - This includes changes like adding a comment or changing a guest name that does not involve any change in pricing
  3. Cancel a room in an existing booking without affecting other active rooms in the reservation

See the DOCS tab on the Reservation GraphQL Docs for detailed information about the type definitions.

For Critical Modifications, we currently do a cancel/rebook. For example, if a date change modification request is sent for a room, the response object will contain 2 room nodes - one for the original canceled room, and the second for the rebooking of the new room on different dates.

Schema

mutation modify($Modify: ModifyRequestInput) {
  modify(modifyRequest: $Modify) {
    htConfirmationCode
    clientConfirmationCode
    otaConfirmationCode
    consolidatedComments
    consolidatedHTMLComments
    bookingDate
    specialRequests
    propertyDetails {
      ...propertyDetails
    }
    aggregateGrossPrice
    aggregateNetPrice
    aggregateTax
    aggregatePayAtProperty
    rooms {
      ...roomDetails
    }
  }
}

fragment addressDetails on Address {
  address1
  address2
  cityName
  countryCode
  stateName
  zipCode
}

fragment propertyDetails on PropertyResponseEntity {
  address {
    ...addressDetails
  }
  checkInTime
  checkOutTime
  city
  hotelImageUrl
  latitude
  longitude
  propertyId
  propertyName
  starRating
  shortDescription
  longDescription
  timeZone
  checkInPolicy
}

fragment roomDetails on RoomResponse {
  cancellationDate
  cancellationFee
  cancelled
  cancellationPolicies {
    ...cancelPolicyDetails
  }
  checkInDate
  checkOutDate
  clientRoomConfirmationCode
  htRoomConfirmationCode
  crsConfirmationCode
  crsCancelConfirmationCode
  pmsConfirmationCode
  refundable
  roomName
  mealplanOptions {
    ...mealPlanOptions
  }
  rates {
    ...ratesDetails
  }
  occupancy {
    guestAges
  }
  guests {
    ...guestDetails
  }
  roomSpecialRequests
}

fragment mealPlanOptions on MealplanOptions {
  mealplanDescription
  mealplanCode
  mealplanName
}

fragment cancelPolicyDetails on HtCancellationPolicy {
  startWindowTime
  endWindowTime
  currency
  cancellationCharge
  timeZone
  timeZoneUTC
}

fragment ratesDetails on RoomRatesResponseEntity {
  currency
  netPrice
  tax
  grossPrice
  dailyPrice
  dailyTax
  payAtProperty
  aggregateTaxInfo {
    payAtBooking {
      description
      name
      currency
      value
    }
    payAtProperty {
      description
      name
      currency
      value
    }
  }
}

fragment guestDetails on RoomGuestResponseEntity {
  adult
  age
  email
  firstName
  lastName
  phone
  primary
}

Samples

Based on the type of modification requested, certain parameters are mandatory while others are not. See the examples below to understand how to send a modification request.

  1. All-in-one Modifications
  2. Adding a Room
  3. Cancelling a Room
  4. Modifying a Room
In all cases, clientRoomConfirmationCode, htRoomConfirmationCode, and status are mandatory at rooms room-level node.

All-in-one Modifications

Request

{
  "Modify": {
    "htConfirmationCode": "HT-VFBLEY",
    "clientConfirmationCode": "tc-test-1406",
    "otaConfirmationCode": "test-client-3286",
    "otaClientName": "test-htrader-graphql",
    "specialRequests": [
      "reservation test comment"
    ],
    "rooms": [
      {
        "htRoomConfirmationCode": "HT-VFBLEY-1",
        "clientRoomConfirmationCode": "tc-test-1406-1",
        "roomSpecialRequests": [
          "cancelling room to book a new one again"
        ],
        "status": "CANCEL"
      },
      {
        "htRoomConfirmationCode": "HT-VFBLEY-2",
        "clientRoomConfirmationCode": "tc-test-1406-2",
        "roomSpecialRequests": [
          "changing guest name"
        ],
        "guests": [
          {
            "firstName": "test",
            "lastName": "new name change",
            "email": "test@hoteltrader.com",
            "adult": true,
            "age": 24,
            "phone": "1234567890",
            "primary": true
          }
        ],
        "status": "MODIFY"
      },
      {
        "htIdentifier": "11019171|1117101511101|111416142|121012141-10111-10151|121012141-10111-10181|1e1d1312141d11131-141a16141-141718121-1b1f12141-1e1128151912171118131f1|1116181617111716151215271",
        "clientRoomConfirmationCode": "tc-test-1406-3",
        "roomSpecialRequests": [
          "adding 3rd room to booking"
        ],
        "rates": {
          "netPrice": 690,
          "tax": 41.49,
          "grossPrice": 731.49,
          "payAtProperty": 90,
          "dailyPrice": [
            230,
            230,
            230
          ],
          "dailyTax": [
            13.83,
            13.83,
            13.83
          ]
        },
        "occupancy": {
          "guestAges": "30,5"
        },
        "guests": [
          {
            "firstName": "test",
            "lastName": "booking",
            "email": "test@hoteltrader.com",
            "adult": true,
            "age": 24,
            "phone": "1234567890",
            "primary": true
          }
        ],
        "status": "BOOK"
      }
    ]
  }
}

Response

{
  "data": {
    "modify": {
      "htConfirmationCode": "HT-VFBLEY",
      "clientConfirmationCode": "tc-test-1406",
      "otaConfirmationCode": "test-client-3286",
      "consolidatedComments": "Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years.  Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#3: Free Breakfast.  Room#2: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city..  Room#3: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. ",
      "consolidatedHTMLComments": "<ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li><li> Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#3: Free Breakfast. </li><li> Room#2: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city..  Room#3: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. </li></ul>",
      "bookingDate": "2024-06-14T04:40:00.000-0400",
      "specialRequests": [
        "reservation test comment"
      ],
      "propertyDetails": {
        "address": {
          "address1": "3820 North Roosevelt Blvd",
          "address2": "",
          "cityName": "Key West",
          "countryCode": "US",
          "stateName": "Florida",
          "zipCode": "33040"
        },
        "checkInTime": "4:00 PM",
        "checkOutTime": "12:00 PM",
        "city": "Key West",
        "hotelImageUrl": null,
        "latitude": "24.571342",
        "longitude": "-81.75515999999999",
        "propertyId": 553402,
        "propertyName": "24 North Hotel Key West",
        "starRating": 3.5,
        "shortDescription": "24 North Hotel is Key West's answer to a casual-resort luxury",
        "longDescription": "24 North Hotel offers guests a genuine island getaway experience. With 145 guest rooms, views of the ocean, and a lively pool scene, guests can embrace the Key West culture. ",
        "timeZone": "America/New_York",
        "checkInPolicy": "Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest."
      },
      "aggregateGrossPrice": 2194.47,
      "aggregateNetPrice": 2070,
      "aggregateTax": 124.47,
      "aggregatePayAtProperty": 180,
      "rooms": [
        {
          "cancellationDate": "2024-06-14T04:44:16.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-04 16:00:00",
              "endWindowTime": "2025-01-05 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",                       "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-05",
          "checkOutDate": "2025-01-08",
          "clientRoomConfirmationCode": "tc-test-1406-1",
          "htRoomConfirmationCode": "HT-VFBLEY-1",
          "crsConfirmationCode": "KEY24N107415359",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              0,
              0,
              0
            ],
            "dailyTax": [
              0,
              0,
              0
            ],
            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "booking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room test comment"
          ]
        },
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-14 16:00:00",
              "endWindowTime": "2025-01-15 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-15",
          "checkOutDate": "2025-01-18",
          "clientRoomConfirmationCode": "tc-test-1406-2",
          "htRoomConfirmationCode": "HT-VFBLEY-2",
          "crsConfirmationCode": "KEY24N107415360",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
            },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              202.4,
              202.4,
              202.4
            ],
            "dailyTax": [
              12.17,
              12.17,
              12.17
            ],
            "payAtProperty": 90,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.09
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 41.4
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "new name change",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "changing guest name"
          ]
        },
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-04 16:00:00",
              "endWindowTime": "2025-01-05 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-05",
          "checkOutDate": "2025-01-08",
          "clientRoomConfirmationCode": "tc-test-1406-3",
          "htRoomConfirmationCode": "HT-VFBLEY-3",
          "crsConfirmationCode": null,
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              230,
              230,
              230
            ],
            "dailyTax": [
              13.83,
              13.83,
              13.83
            ],
            "payAtProperty": 90,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.09
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 41.4
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "booking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "adding 3rd room to booking"
          ]
        }
      ]
    }
  }
}

Adding a Room

For this type of modification request, all fields that are part of the Rooms object for a regular booking request are needed along with status = "BOOK" (case insensitive) at Rooms level node.

Request

{
  "Modify": {
    "htConfirmationCode": "HT-NI8M5B",
    "clientConfirmationCode": "tc-test-1206",
    "otaConfirmationCode": "test-client-3286",
    "otaClientName": "test-htrader-graphql",
    "specialRequests": [
      "test comment",
      "2 test comment"
    ],
    "rooms": [
      {
        "htIdentifier": "11019171|1117101511101|111416142|121012141-10111-10111|121012141-10111-10121|1c101415131f18191-191310131-14131e191-1a1c19131-171e161d1e101912171519111|111618162418211018192",
        "clientRoomConfirmationCode": "tc-test-1206-2",
        "roomSpecialRequests": [
          "room 2 test comment",
          "room 2 test comment again"
        ],
        "rates": {
          "netPrice": 242.42,
          "tax": 14.64,
          "grossPrice": 257.06,
          "payAtProperty": 30,
          "dailyPrice": [
            242.42
          ],
          "dailyTax": [
            14.64
          ]
        },
        "occupancy": {
          "guestAges": "30,5"
        },
        "guests": [
          {
            "firstName": "test",
            "lastName": "newbooking",
            "email": "test@hoteltrader.com",
            "adult": true,
            "age": 24,
            "phone": "1234567890",
            "primary": true
          }
        ],
        "status": "BOOK"
      }
    ]
  }
}

Response

{
  "data": {
    "modify": {
      "htConfirmationCode": "HT-NI8M5B",
      "clientConfirmationCode": "tc-test-1206",
      "otaConfirmationCode": "test-client-3286",
      "consolidatedComments": "Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years.  Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#1: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city..  Room#2: A Resort Fee totaling $30.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. ",
      "consolidatedHTMLComments": "<ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li><li> Room#1: Free Breakfast.  Room#2: Free Breakfast. </li><li> Room#1: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city..  Room#2: A Resort Fee totaling $30.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. </li></ul>",
      "bookingDate": "2024-06-12T12:32:06.000-0400",
      "specialRequests": [
        "test comment",
        "2 test comment"
      ],
      "propertyDetails": {
        "address": {
          "address1": "3820 North Roosevelt Blvd",
          "address2": "",
          "cityName": "Key West",
          "countryCode": "US",
          "stateName": "Florida",
          "zipCode": "33040"
        },
        "checkInTime": "4:00 PM",
        "checkOutTime": "12:00 PM",
        "city": "Key West",
        "hotelImageUrl": null,
        "latitude": "24.571342",
        "longitude": "-81.75515999999999",
        "propertyId": 553402,
        "propertyName": "24 North Hotel Key West",
        "starRating": 3.5,
        "shortDescription": "24 North Hotel is Key West's answer to a casual-resort luxury",
        "longDescription": "24 North Hotel offers guests a genuine island getaway experience. With 145 guest rooms, views of the ocean, and a lively pool scene, guests can embrace the Key West culture. ",
        "timeZone": "America/New_York",
        "checkInPolicy": "Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest."
      },
      "aggregateGrossPrice": 988.55,
      "aggregateNetPrice": 932.42,
      "aggregateTax": 56.13,
      "aggregatePayAtProperty": 120,
      "rooms": [
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-14 16:00:00",
              "endWindowTime": "2025-01-15 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-15",
          "checkOutDate": "2025-01-18",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-1",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              202.4,
              202.4,
              202.4
            ],
            "dailyTax": [
              12.17,
              12.17,
              12.17
            ],
            "payAtProperty": 90,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.09
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 41.4
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "guestnamechange",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room test comment new one to test special requests again"
          ]
        },
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2024-12-31 16:00:00",
              "endWindowTime": "2025-01-01 16:00:00",
              "currency": "USD",
              "cancellationCharge": 257.06,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-01",
          "checkOutDate": "2025-01-02",
          "clientRoomConfirmationCode": "tc-test-1206-2",
          "htRoomConfirmationCode": "HT-NI8M5B-2",
          "crsConfirmationCode": null,
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 242.42,
            "tax": 14.64,
            "grossPrice": 257.06,
            "dailyPrice": [
              242.42
            ],
            "dailyTax": [
              14.64
            ],
            "payAtProperty": 30,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.1
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 14.54
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 30
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "newbooking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room 2 test comment",
            "room 2 test comment again"
          ]
        }
      ]
    }
  }
}

Cancelling a Room

This type of modification requires minimal data - htRoomConfirmationCode and clientRoomConfirmationCode. This is to identify and cancel the specified room and not modify other active rooms in the reservation.

The rooms level status node should be set to CANCEL.

Request

{
  "Modify": {
    "htConfirmationCode": "HT-NI8M5B",
    "clientConfirmationCode": "tc-test-1206",
    "otaConfirmationCode": "test-client-3286",
    "otaClientName": "test-htrader-graphql",
    "specialRequests": [
      "test cancel room",
      "2 test cancel"
    ],
    "rooms": [
      {
        "clientRoomConfirmationCode": "tc-test-1206-2",
        "htRoomConfirmationCode": "HT-NI8M5B-2",
        "roomSpecialRequests": [
          "cancelling room to book a new one again"
        ],
        "status": "CANCEL"
      }
    ]
  }
}

Response

{
  "data": {
    "modify": {
      "htConfirmationCode": "HT-NI8M5B",
      "clientConfirmationCode": "tc-test-1206",
      "otaConfirmationCode": "test-client-3286",
      "consolidatedComments": "Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years.  Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#1: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. ",
      "consolidatedHTMLComments": "<ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li><li> Room#1: Free Breakfast.  Room#2: Free Breakfast. </li><li> Room#1: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. </li></ul>",
      "bookingDate": "2024-06-12T12:32:06.000-0400",
      "specialRequests": [
        "test cancel room",
        "2 test cancel"
      ],
      "propertyDetails": {
        "address": {
          "address1": "3820 North Roosevelt Blvd",
          "address2": "",
          "cityName": "Key West",
          "countryCode": "US",
          "stateName": "Florida",
          "zipCode": "33040"
        },
        "checkInTime": "4:00 PM",
        "checkOutTime": "12:00 PM",
        "city": "Key West",
        "hotelImageUrl": null,
        "latitude": "24.571342",
        "longitude": "-81.75515999999999",
        "propertyId": 553402,
        "propertyName": "24 North Hotel Key West",
        "starRating": 3.5,
        "shortDescription": "24 North Hotel is Key West's answer to a casual-resort luxury",
        "longDescription": "24 North Hotel offers guests a genuine island getaway experience. With 145 guest rooms, views of the ocean, and a lively pool scene, guests can embrace the Key West culture. ",
        "timeZone": "America/New_York",
        "checkInPolicy": "Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest."
      },
      "aggregateGrossPrice": 988.55,
      "aggregateNetPrice": 932.42,
      "aggregateTax": 56.13,
      "aggregatePayAtProperty": 90,
      "rooms": [
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-14 16:00:00",
              "endWindowTime": "2025-01-15 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-15",
          "checkOutDate": "2025-01-18",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-1",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              202.4,
              202.4,
              202.4
            ],
            "dailyTax": [
              12.17,
              12.17,
              12.17
            ],
            "payAtProperty": 90,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.09
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 41.4
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "guestnamechange",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room test comment new one to test special requests again"
          ]
        },
        {
          "cancellationDate": "2024-06-13T09:37:46.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2024-12-31 16:00:00",
              "endWindowTime": "2025-01-01 16:00:00",
              "currency": "USD",
              "cancellationCharge": 257.06,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-01",
          "checkOutDate": "2025-01-02",
          "clientRoomConfirmationCode": "tc-test-1206-2",
          "htRoomConfirmationCode": "HT-NI8M5B-2",
          "crsConfirmationCode": "KEY24N107415314",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 242.42,
            "tax": 14.64
            "grossPrice": 257.06,
            "dailyPrice": [
              0
            ],
            "dailyTax": [
              0
            ],
            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "newbooking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room 2 test comment",
            "room 2 test comment again"
          ]
        }
      ]
    }
  }
}

Modifying a Room

As described above, modifications are further divided into 2 categories based on whether the request results in a price change for the booking. The 2 types of modifications are as follows:

  1. Critical Modifications
    1. Date change 
    2. Occupancy change
    3. Rateplan/Roomtype change
  2. Non-Critical Modifications
    1. Add a special request for a room
    2. Modify the guest name of an existing room

Critical Modifications

This type of modification request requires all the fields that are sent as a part of a new room reservation request, along with htConfirmationCode and Rooms level status = "MODIFY".

Date Change Modification

Request

{
  "Modify": {
    "htConfirmationCode": "HT-NI8M5B",
    "clientConfirmationCode": "tc-test-1206",
    "otaConfirmationCode": "test-client-3286",
    "otaClientName": "test-htrader-graphql",
    "specialRequests": [
      "test comment",
      "2 test comment"
    ],
    "rooms": [
      {
        "htIdentifier": "11019171|1117101511101|111416142|121012141-10111-10151|121012141-10111-10181|1211141d1a1e111b1-1d1e281-141d11121-1b10151c1-1a241b121e261d2b1e1|1116181624191415161417161",
        "htRoomConfirmationCode": "HT-NI8M5B-1",
        "clientRoomConfirmationCode": "tc-test-1206-1",
        "roomSpecialRequests": [
          "changing checkIn, CheckOut dates for room, new stay from 5-8 jan"
        ],
        "rates": {
          "currencyCode": "USD",
          "netPrice": 690,
          "tax": 41.49,
          "grossPrice": 731.49,
          "payAtProperty": 90,
          "dailyPrice": [
            230,
            230,
            230
          ],
          "dailyTax": [
            13.83,
            13.83,
            13.83
          ]
        },
        "occupancy": {
          "guestAges": "30,5"
        },
        "guests": [
          {
            "firstName": "test",
            "lastName": "booking",
            "email": "test@hoteltrader.com",
            "adult": true,
            "age": 24,
            "phone": "1234567890",
            "primary": true
          }
        ],
        "status": "MODIFY"
      }
    ]
  }
}

Response

{
  "data": {
    "modify": {
      "htConfirmationCode": "HT-NI8M5B",
      "clientConfirmationCode": "tc-test-1206",
      "otaConfirmationCode": "test-client-3286",
      "consolidatedComments": "Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years.  Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#3: Free Breakfast.  Room#3: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. ",
      "consolidatedHTMLComments": "<ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li><li> Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#3: Free Breakfast. </li><li> Room#3: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and our packages delivered to the hotel while you explore the city.. </li></ul>",
      "bookingDate": "2024-06-12T12:32:06.000-0400",
      "specialRequests": [
        "test comment",
        "2 test comment"
      ],
      "propertyDetails": {
        "address": {
          "address1": "3820 North Roosevelt Blvd",
          "address2": "",
          "cityName": "Key West",
          "countryCode": "US",
          "stateName": "Florida",
          "zipCode": "33040"
        },
        "checkInTime": "4:00 PM",
        "checkOutTime": "12:00 PM",
        "city": "Key West",
        "hotelImageUrl": null,
        "latitude": "24.571342",
        "longitude": "-81.75515999999999",
        "propertyId": 553402,
        "propertyName": "24 North Hotel Key West",
        "starRating": 3.5,
        "shortDescription": "24 North Hotel is Key West's answer to a casual-resort luxury",
        "longDescription": "24 North Hotel offers guests a genuine island getaway experience. With 145 guest rooms, views of the ocean, and a lively pool scene, guests can embrace the Key West culture. ",
        "timeZone": "America/New_York",
        "checkInPolicy": "Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest."
      },
      "aggregateGrossPrice": 1720.04,
      "aggregateNetPrice": 1622.42,
      "aggregateTax": 97.62,
      "aggregatePayAtProperty": 90,
      "rooms": [
        {
          "cancellationDate": "2024-06-13T09:45:21.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-14 16:00:00",
              "endWindowTime": "2025-01-15 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-15",
          "checkOutDate": "2025-01-18",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-1",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions" : {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              0,
              0,
              0
            ],
            "dailyTax": [
              0,
              0,
              0
            ],
            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "guestnamechange",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room test comment new one to test special requests again"
          ]
        },
        {
          "cancellationDate": "2024-06-13T09:37:46.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2024-12-31 16:00:00",
              "endWindowTime": "2025-01-01 16:00:00",
              "currency": "USD",
              "cancellationCharge": 257.06,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-01",
          "checkOutDate": "2025-01-02",
          "clientRoomConfirmationCode": "tc-test-1206-2",
          "htRoomConfirmationCode": "HT-NI8M5B-2",
          "crsConfirmationCode": "KEY24N107415314",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions" : {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"Free Breakfast
          },
          "rates": {
            "currency": "USD",
            "netPrice": 242.42,
            "tax": 14.64,
            "grossPrice": 257.06,
            "dailyPrice": [
              0
            ],
            "dailyTax": [
              0
            ],
            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "newbooking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room 2 test comment",
            "room 2 test comment again"
          ]
        },
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-04 16:00:00",
              "endWindowTime": "2025-01-05 16:00:00",
              "cancellationCharge": 731.49,
              "currency": "USD",
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-05",
          "checkOutDate": "2025-01-08",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-3",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions" : {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"Free Breakfast
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              230,
              230,
              230
            ],
            "dailyTax": [
              13.83,
              13.83,
              13.83
            ],
            "payAtProperty": 90,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.09
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 41.4
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "booking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "changing checkIn, CheckOut dates for room, new stay from 5-8 jan"
          ]
        }
      ]
    }
  }
}

Occupancy Change Modification

Request

The below example is to add a guest to an existing room 

{
  "Modify": {
    "htConfirmationCode": "HT-NI8M5B",
    "clientConfirmationCode": "tc-test-1206",
    "otaConfirmationCode": "test-client-3286",
    "otaClientName": "test-htrader-graphql",
    "specialRequests": [
      "test comment",
      "2 test comment"
    ],
    "rooms": [
      {
        "htIdentifier": "11019171|1117101511101|111416142|121012141-10111-10151|121012141-10111-10181|121811161a1819151-191813161-141d11101-18191f141-191e1b121d1a181b1c14132|1116181624191712111519121",
        "htRoomConfirmationCode": "HT-NI8M5B-3",
        "clientRoomConfirmationCode": "tc-test-1206-1",
        "roomSpecialRequests": [
          "changing occupancy from 2 adults 1 Child to 3 adults 1 child"
        ],
        "rates": {
          "netPrice": 690,
          "tax": 62.19,
          "grossPrice": 752.19,
          "payAtProperty": 90,
          "dailyPrice": [
            230,
            230,
            230
          ],
          "dailyTax": [
            20.73,
            20.73,
            20.73
          ]
        },
        "occupancy": {
          "guestAges": "30,30,5"
        },
        "guests": [
          {
            "firstName": "test",
            "lastName": "booking",
            "email": "test@hoteltrader.com",
            "adult": true,
            "age": 24,
            "phone": "1234567890",
            "primary": true
          }
        ],
        "status": "MODIFY"
      }
    ]
  }
}

Response

{
  "data": {
    "modify": {
      "htConfirmationCode": "HT-NI8M5B",
      "clientConfirmationCode": "tc-test-1206",
      "otaConfirmationCode": "test-client-3286",
      "consolidatedComments": "Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years.  Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#3: Free Breakfast.  Room#3: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. ",
      "consolidatedHTMLComments": "<ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li><li> Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#3: Free Breakfast. </li><li> Room#3: A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. </li></ul>",
      "bookingDate": "2024-06-12T12:32:06.000-0400",
      "specialRequests": [
        "test comment",
        "2 test comment"
      ],
      "propertyDetails": {
        "address": {
          "address1": "3820 North Roosevelt Blvd",
          "address2": "",
          "cityName": "Key West",
          "countryCode": "US",
          "stateName": "Florida",
          "zipCode": "33040"
        },
        "checkInTime": "4:00 PM",
        "checkOutTime": "12:00 PM",
        "city": "Key West",
        "hotelImageUrl": null,
        "latitude": "24.571342",
        "longitude": "-81.75515999999999",
        "propertyId": 553402,
        "propertyName": "24 North Hotel Key West",
        "starRating": 3.5,
        "shortDescription": "24 North Hotel is Key West's answer to a casual-resort luxury",
        "longDescription": "24 North Hotel offers guests a genuine island getaway experience. With 145 guest rooms, views of the ocean, and a lively pool scene, guests can embrace the Key West culture. ",
        "timeZone": "America/New_York",
        "checkInPolicy": "Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest."
      },
      "aggregateGrossPrice": 1740.74,
      "aggregateNetPrice": 1622.42,
      "aggregateTax": 118.32,
      "aggregatePayAtProperty": 90,
      "rooms": [
        {
          "cancellationDate": "2024-06-13T09:45:21.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-14 16:00:00",
              "endWindowTime": "2025-01-15 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-15",
          "checkOutDate": "2025-01-18",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-1",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              0,
              0,
              0
            ],
            "dailyTax": [
              0,
              0,
              0
            ],
            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges" : "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "guestnamechange",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room test comment new one to test special requests again"
          ]
        },
        {
          "cancellationDate": "2024-06-13T09:37:46.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2024-12-31 16:00:00",
              "endWindowTime": "2025-01-01 16:00:00",
              "currency": "USD",
              "cancellationCharge": 257.06,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-01",
          "checkOutDate": "2025-01-02",
          "clientRoomConfirmationCode": "tc-test-1206-2",
          "htRoomConfirmationCode": "HT-NI8M5B-2",
          "crsConfirmationCode": "KEY24N107415314",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
            "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 242.42,
            "tax": 14.64,
            "grossPrice": 257.06,
            "dailyPrice": [
              0
            ],
            "dailyTax": [
              0
            ],

            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges" : "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "newbooking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room 2 test comment",
            "room 2 test comment again"
          ]
        },
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-04 16:00:00",
              "endWindowTime": "2025-01-05 16:00:00",
              "currency": "USD",
              "cancellationCharge": 752.19,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-05",
          "checkOutDate": "2025-01-08",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-3",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 62.19,
            "grossPrice": 752.19,
            "dailyPrice": [
              230,
              230,
              230
            ],
            "dailyTax": [
              20.73,
              20.73,
              20.73
            ],
            "payAtProperty": 90,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.09
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 62.1
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "booking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "changing occupancy from 2 adults 1 Child to 3 adults 1 child"
          ]
        }
      ]
    }
  }
}

Rateplan/Roomtype Change Modification

Request

{
  "Modify": {
    "htConfirmationCode": "HT-NI8M5B",
    "clientConfirmationCode": "tc-test-1206",
    "otaConfirmationCode": "test-client-3286",
    "otaClientName": "test-htrader-graphql",
    "specialRequests": [
      "test comment",
      "2 test comment"
    ],
    "rooms": [
      {
        "htIdentifier": "11019171|1117101510191|11141614131|121012141-10111-10151|121012141-10111-10181|1b1f192d161d101-121c191e1-141816111-181e101c1-161c1d122a111816121e2|1116181625131814111713151",
        "htRoomConfirmationCode": "HT-NI8M5B-3",
        "clientRoomConfirmationCode": "tc-test-1206-1",
        "roomSpecialRequests": [
          "changing roomtype for room, from 'Standard | Double Queen-S2Q' to 'Standard | King' and changing rateplan from HTPKG to HTOPQ"
        ],
        "rates": {
          "netPrice": 759,
          "tax": 47.55,
          "grossPrice": 806.55,
          "payAtProperty": 106.5,
          "dailyPrice": [
            253,
            253,
            253
          ],
          "dailyTax": [
            15.85,
            15.85,
            15.85
          ]
        },
        "occupancy": {
          "guestAges": "30,5"
        },
        "guests": [
          {
            "firstName": "test",
            "lastName": "booking",
            "email": "test@hoteltrader.com",
            "adult": true,
            "age": 24,
            "phone": "1234567890",
            "primary": true
          }
        ],
        "status": "MODIFY"
      }
    ]
  }
}

Response

{
  "data": {
    "modify": {
      "htConfirmationCode": "HT-NI8M5B",
      "clientConfirmationCode": "tc-test-1206",
      "otaConfirmationCode": "test-client-3286",
      "consolidatedComments": "Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years.  Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#3: Free Breakfast.  Room#4: Free Breakfast.  Room#4: A Resort Fee totaling $106.50 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. test. ",
      "consolidatedHTMLComments": "<ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li><li> Room#1: Free Breakfast.  Room#2: Free Breakfast.  Room#3: Free Breakfast.  Room#4: Free Breakfast. </li><li> Room#4: A Resort Fee totaling $106.50 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. test. </li></ul>",
      "bookingDate": "2024-06-12T12:32:06.000-0400",
      "specialRequests": [
        "test comment",
        "2 test comment"
      ],
      "propertyDetails": {
        "address": {
          "address1": "3820 North Roosevelt Blvd",
          "address2": "",
          "cityName": "Key West",
          "countryCode": "US",
          "stateName": "Florida",
          "zipCode": "33040"
        },
        "checkInTime": "4:00 PM",
        "checkOutTime": "12:00 PM",
        "city": "Key West",
        "hotelImageUrl": null,
        "latitude": "24.571342",
        "longitude": "-81.75515999999999",
        "propertyId": 553402,
        "propertyName": "24 North Hotel Key West",
        "starRating": 3.5,
        "shortDescription": "24 North Hotel is Key West's answer to a casual-resort luxury",
        "longDescription": "24 North Hotel offers guests a genuine island getaway experience. With 145 guest rooms, views of the ocean, and a lively pool scene, guests can embrace the Key West culture. "
        "timeZone": "America/New_York",
        "checkInPolicy": "Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest."
      },
      "aggregateGrossPrice": 2547.29,
      "aggregateNetPrice": 2381.42,
      "aggregateTax": 165.87,
      "aggregatePayAtProperty": 106.5,
      "rooms": [
        {
          "cancellationDate": "2024-06-13T09:45:21.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-14 16:00:00",
              "endWindowTime": "2025-01-15 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-15",
          "checkOutDate": "2025-01-18",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-1",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
            },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              0,
              0,
              0
            ],
            "dailyTax": [
              0,
              0,
              0
            ],
            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5",
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "guestnamechange",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room test comment new one to test special requests again"
          ]
        },
        {
          "cancellationDate": "2024-06-13T09:37:46.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2024-12-31 16:00:00",
              "endWindowTime": "2025-01-01 16:00:00",
              "currency": "USD",
              "cancellationCharge": 257.06,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-01",
          "checkOutDate": "2025-01-02",
          "clientRoomConfirmationCode": "tc-test-1206-2",
          "htRoomConfirmationCode": "HT-NI8M5B-2",
          "crsConfirmationCode": "KEY24N107415314",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 242.42,
            "tax": 14.64,
            "grossPrice": 257.06,
            "dailyPrice": [
              0
            ],
            "dailyTax": [
              0
            ],
            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30, 5",
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "newbooking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room 2 test comment",
            "room 2 test comment again"
          ]
        },
        {
          "cancellationDate": "2024-06-13T11:00:34.000-0400",
          "cancellationFee": 0,
          "cancelled": true,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-04 16:00:00",
              "endWindowTime": "2025-01-05 16:00:00",
              "currency": "USD",
              "cancellationCharge": 752.19,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-05",
          "checkOutDate": "2025-01-08",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-3",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 62.19,
            "grossPrice": 752.19,
            "dailyPrice": [
              0,
              0,
              0
            ],
            "dailyTax": [
              0,
              0,
              0
            ],
            "payAtProperty": 0,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 0
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 0
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,30,5",
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "booking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "changing occupancy from 2 adults 1 Child to 3 adults 1 child"
          ]
        },
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-02 16:00:00",
              "endWindowTime": "2025-01-05 16:00:00",
              "currency": "USD",
              "cancellationCharge": 806.55,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            },
            {
              "startWindowTime": "2024-12-30 16:00:00",
              "endWindowTime": "2025-01-02 16:00:00",
              "currency": "USD",
              "cancellationCharge": 604.91,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            },
            {
              "startWindowTime": "2024-12-26 16:00:00",
              "endWindowTime": "2024-12-30 16:00:00",
              "currency": "USD",
              "cancellationCharge": 201.64,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-05",
          "checkOutDate": "2025-01-08",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-4",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | King",
          "mealplanOptions": {
          "mealplanDescription": "Free Breakfast",
          "mealplanCode": "BBF",
          "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 759,
            "tax": 47.55,
            "grossPrice": 806.55,
            "dailyPrice": [
              253,
              253,
              253
            ],
            "dailyTax": [
              15.85,
              15.85,
              15.85
            ],
            "payAtProperty": 106.5,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 2.01
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 45.54
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                },
                {
                  "description": "test",
                  "name": "Facility Fee 3",
                  "currency": "USD",
                  "value": 16.5
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5",
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "booking",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "changing roomtype for room, from 'Standard | Double Queen-S2Q' to 'Standard | King' and changing rateplan from HTPKG to HTOPQ"
          ]
        }
      ]
    }
  }
}

2. Non-Critical Modifications

This type of modification request requires only the mandatory fields - specialRequests or roomSpecialRequests to send / change/update comments. For a guest name change request, the complete guests node should be sent with the expected occupancy count for the room.

Add Special Request for a Room

Request

{
  "Modify": {
    "htConfirmationCode": "HT-NI8M5B",
    "clientConfirmationCode": "tc-test-1206",
    "otaConfirmationCode": "test-client-3286",
    "otaClientName": "test-htrader-graphql",
    "specialRequests": [
      "test comment new one to test special requests"
    ],
    "rooms": [
      {
        "htRoomConfirmationCode": "HT-NI8M5B-1",
        "clientRoomConfirmationCode": "tc-test-1206-1",
        "roomSpecialRequests": [
          "room test comment new one to test special requests again"
        ],
        "status": "MODIFY"
      }
    ]
  }
}

Response

{
  "data": {
    "modify": {
      "htConfirmationCode": "HT-NI8M5B",
      "clientConfirmationCode": "tc-test-1206",
      "otaConfirmationCode": "test-client-3286",
      "consolidatedComments": "Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years. Free Breakfast. A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. ",
"consolidatedHTMLComments": "<ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li><li>Free Breakfast. </li><li>A Resort Fee totaling $90.00 will be charged for the stay. Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.. </li></ul>",
      "bookingDate": "2024-06-12T12:32:06.000-0400",
      "specialRequests": [
        "test comment new one to test special requests"
      ],
      "propertyDetails": {
        "address": {
          "address1": "3820 North Roosevelt Blvd",
          "address2": "",
          "cityName": "Key West",
          "countryCode": "US",
          "stateName": "Florida",
          "zipCode": "33040"
        },
        "checkInTime": "4:00 PM",
        "checkOutTime": "12:00 PM",
        "city": "Key West",
        "hotelImageUrl": null,
        "latitude": "24.571342",
        "longitude": "-81.75515999999999",
        "propertyId": 553402,
        "propertyName": "24 North Hotel Key West",
        "starRating": 3.5,
        "shortDescription": "24 North Hotel is Key West's answer to a casual-resort luxury",
        "longDescription": "24 North Hotel offers guests a genuine island getaway experience. With 145 guest rooms, views of the ocean, and a lively pool scene, guests can embrace the Key West culture. ",
        "timeZone": "America/New_York",
        "checkInPolicy": "Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest."
      },
      "aggregateGrossPrice": 731.49,
      "aggregateNetPrice": 690,
      "aggregateTax": 41.49,
      "aggregatePayAtProperty": 90,
      "rooms": [
        {
          "cancellationDate": null,
          "cancellationFee": null,
          "cancelled": false,
          "cancellationPolicies": [
            {
              "startWindowTime": "2025-01-14 16:00:00",
              "endWindowTime": "2025-01-15 16:00:00",
              "currency": "USD",
              "cancellationCharge": 731.49,
              "timeZone": "America/New_York",
              "timeZoneUTC" : "-05:00"
            }
          ],
          "checkInDate": "2025-01-15",
          "checkOutDate": "2025-01-18",
          "clientRoomConfirmationCode": "tc-test-1206-1",
          "htRoomConfirmationCode": "HT-NI8M5B-1",
          "crsConfirmationCode": "KEY24N107415281",
          "crsCancelConfirmationCode": null,
          "pmsConfirmationCode": null,
          "refundable": true,
          "roomName": "Standard | Double Queen-S2Q",
          "mealplanOptions": {
            "mealplanDescription": "Free Breakfast",
            "mealplanCode": "BBF",
            "mealplanName": "Free Breakfast"
          },
          "rates": {
            "currency": "USD",
            "netPrice": 690,
            "tax": 41.49,
            "grossPrice": 731.49,
            "dailyPrice": [
              202.4,
              202.4,
              202.4
            ],
            "dailyTax": [
              12.17,
              12.17,
              12.17
            ],
            "payAtProperty": 90,
            "aggregateTaxInfo": {
              "payAtBooking": [
                {
                  "description": "State Tax",
                  "name": "State Tax",
                  "currency": "USD",
                  "value": 0.09
                },
                {
                  "description": "City Tax",
                  "name": "City Tax",
                  "currency": "USD",
                  "value": 41.4
                }
              ],
              "payAtProperty": [
                {
                  "description": "Resort Fee of $30 plus tax per room per night which covers: free local, long distance and international phone calls.  Choice of complimentary wine or water, or both upon check-in.  Complimentary coffee & tea in our lobby each morning. Access to WiFi 24/7 for all devices.  Around the clock access to our fitness center with treadmills, bikes, and weights.  Storage of your luggage and your packages delivered to the hotel while you explore the city.",
                  "name": "Resort Fee Pay at property",
                  "currency": "USD",
                  "value": 90
                }
              ]
            }
          },
          "occupancy": {
            "guestAges": "30,5"
          },
          "guests": [
            {
              "adult": true,
              "age": null,
              "email": "test@hoteltrader.com",
              "firstName": "test",
              "lastName": "guestnamechange",
              "phone": "1234567890",
              "primary": true
            }
          ],
          "roomSpecialRequests": [
            "room test comment new one to test special requests again"
          ]
        }
      ]
    }
  }
}

Modify the Guest Name of an Existing Room

Request

{
    "Modify": {
        "htConfirmationCode": "HT-NZGQNS",
        "clientConfirmationCode": "tc-test-0711013",
        "otaConfirmationCode": "test-client-3286",
        "otaClientName": "htrader",
        "specialRequests": [
            "reservation test commentä"
        ],
        "rooms": [
            {
                "clientRoomConfirmationCode": "tc-test-0711013-1",
                "htRoomConfirmationCode": "HT-NZGQNS-1",
                "guests": [
                    {
                        "firstName": "test",
                        "lastName": "guestnamechangeagain",
                        "email": "test@hoteltrader.com",
                        "adult": true,
                        "age": 24,
                        "phone": "1234567890",
                        "primary": true
                    }
                ],
                "roomSpecialRequests": [
                    "room test commentä"
                ],
                "status": "MODIFY"
            }
        ]
    }
}

Response

{
  "modify": {
    "htConfirmationCode": "HT-NZGQNS",
    "clientConfirmationCode": "tc-test-0711013",
    "otaConfirmationCode": "test-client-3286",
    "consolidatedComments": "Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. Reservation is refundable but nonModifiable. Minimum adult age at check in is 21 years. Free Breakfast. A Resort Fee totaling EUR50.00 will be charged for the stay. Mandatory Charge. Plus applicable taxes.. ",
    "consolidatedHTMLComments": "<ul><li>Hotel Check In Policy: Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest.. </li><li>Reservation is refundable but nonModifiable. </li><li>Minimum adult age at check in is 21 years. </li><li>Free Breakfast. </li><li>A Resort Fee totaling EUR50.00 will be charged for the stay. Mandatory Charge. Plus applicable taxes.. </li></ul>",
    "bookingDate": "2024-11-07T10:12:57.000+0200",
    "specialRequests": [
      "reservation test commentä"
    ],
    "propertyDetails": {
      "address": {
        "address1": "Sarigerme Tourism Center, PO11",
        "address2": null,
        "cityName": "Mugla",
        "countryCode": "TR",
        "stateName": null,
        "zipCode": "48610"
      },
      "checkInTime": "3:00 PM",
      "checkOutTime": "12:00 PM",
      "city": "Mugla",
      "hotelImageUrl": null,
      "latitude": "36.708",
      "longitude": "28.724",
      "propertyId": 2257146,
      "propertyName": "Hilton Dalaman Sarigerme Resort & Spa",
      "starRating": 4,
      "shortDescription": "Hilton Dalaman Sarigerme is a 10-minute walk to Sarigerme town center and 15 minutes from Dalaman International Airport. The resort provides an Ultra Free Breakfast concept with a total of 23 internationally-inspired dining opportunities, 6,000 sq. m. spa, Turkish bath, skin care and 422 luxury rooms and suites. A total of eleven pools and two aqua parks across the resort complete the experience.\\\\nEnjoy a culinary adventure through the array of restaurants and bars where you may have breakfast, late breakfast, lunch, snacks, tea and coffee, dinner and midnight supper. In addition to an indoor dining area and outdoor terrace the main restaurant offers an adults-only section, children’s section, plus diet and vegetarian corners. 24-hour room service is available. \\\\nIndulge yourself with the finest wellness experiences. The spa center consists of two zones: Byblis SPA and Elysion SPA, offering you holistic, tailored spa treatments. Start your unique wellness journey with Traditional Oriental Hammam, rejuvenate with the latest European developments in beauty and health, unwind in any of our relaxation areas or experience the sauna, steam rooms and indoor pools. \\\\nThe hotel boasts a 650m private sandy beach with pier plus 10 pools and two seasonal heated aquaparks providing fun and relaxation for the whole family. Treat yourself to a Gazebo House and enjoy exclusive service all day long. \\\\nEnergize with our recreation facilities including a diving school, wind surfing, tennis courts, 24/7 fitness center, beach volleyball, archery, yoga, Zumba lessons and more. Daily and nightly events, themed parties and live performances are also included. Capri Kidz offers daily supervised programs for children of all ages. The Kidz Paradise is equipped with an arts and crafts room, game and book corner, baby room, splash pool, and farm!\\\\nExplore local attractions like the ancient town of Dalyan, the harbor town of Göcek, the Dead Sea, Sultaniye Thermal Springs or the tourist resort of Marmaris.",

      "longDescription": "Hilton Dalaman Sarigerme is a 10-minute walk to Sarigerme town center and 15 minutes from Dalaman International Airport. The resort provides an Ultra Free Breakfast concept with a total of 23 internationally-inspired dining opportunities, 6,000 sq. m. spa, Turkish bath, skin care and 422 luxury rooms and suites. A total of eleven pools and two aqua parks across the resort complete the experience.\\\\nEnjoy a culinary adventure through the array of restaurants and bars where you may have breakfast, late breakfast, lunch, snacks, tea and coffee, dinner and midnight supper. In addition to an indoor dining area and outdoor terrace the main restaurant offers an adults-only section, children’s section, plus diet and vegetarian corners. 24-hour room service is available. \\\\nIndulge yourself with the finest wellness experiences. The spa center consists of two zones: Byblis SPA and Elysion SPA, offering you holistic, tailored spa treatments. Start your unique wellness journey with Traditional Oriental Hammam, rejuvenate with the latest European developments in beauty and health, unwind in any of our relaxation areas or experience the sauna, steam rooms and indoor pools. \\\\nThe hotel boasts a 650m private sandy beach with pier plus 10 pools and two seasonal heated aquaparks providing fun and relaxation for the whole family. Treat yourself to a Gazebo House and enjoy exclusive service all day long. \\\\nEnergize with our recreation facilities including a diving school, wind surfing, tennis courts, 24/7 fitness center, beach volleyball, archery, yoga, Zumba lessons and more. Daily and nightly events, themed parties and live performances are also included. Capri Kidz offers daily supervised programs for children of all ages. The Kidz Paradise is equipped with an arts and crafts room, game and book corner, baby room, splash pool, and farm!\\\\nExplore local attractions like the ancient town of Dalyan, the harbor town of Göcek, the Dead Sea, Sultaniye Thermal Springs or the tourist resort of Marmaris.",
      "timeZone": "Europe/Istanbul",
      "checkInPolicy": "Major credit card required at check-in for deposit and incidentals. Any additional fees such as parking, pet fees, etc. are solely at the discretion of the hotel, are subject to change at any point and should be paid directly by the guest."
    },
    "aggregateGrossPrice": 330.18,
    "aggregateNetPrice": 300.17,
    "aggregateTax": 30.01,
    "aggregatePayAtProperty": 50,
    "rooms": [
      {
        "cancellationDate": null,
        "cancellationFee": null,
        "cancelled": false,
        "cancellationPolicies": [
          {
            "startWindowTime": "2024-11-09 23:00:00",
            "endWindowTime": "2024-11-10 15:00:00",
            "currency": "EUR",
            "cancellationCharge": 330.18,
            "timeZone": "Europe/Istanbul",
            "timeZoneUTC" : "+03:00"
          }
        ],
        "checkInDate": "2024-11-10",
        "checkOutDate": "2024-11-11",
        "clientRoomConfirmationCode": "tc-test-0711013-1",
        "htRoomConfirmationCode": "HT-NZGQNS-1",
        "crsConfirmationCode": "360241042",
        "crsCancelConfirmationCode": null,
        "pmsConfirmationCode": "3355390763",
        "refundable": true,
        "roomName": "KING GUEST ROOM WITH GARDEN VIEW",
        "mealplanOptions": {
          "mealplanDescription": "Free Breakfast",
          "mealplanCode": "BBF",
          "mealplanName": "Free Breakfast"
        },
        "rates": {
          "currency": "EUR",
          "netPrice": 300.17,
          "tax": 30.01,
          "grossPrice": 330.18,
          "dailyPrice": [
            300.17
          ],
          "dailyTax": [
            30.01
          ],
          "payAtProperty": 50,
          "aggregateTaxInfo": {
            "payAtBooking": [
              {
                "description": null,
                "name": "percent",
                "currency": "EUR",
                "value": 30.01
              }
            ],
            "payAtProperty": [
              {
                "description": "Mandatory Charge. Plus applicable taxes.",
                "name": "Mandatory Charge",
                "currency": "EUR",
                "value": 50
              }
            ]
          }
        },
        "occupancy": {
          "guestAges": "30,5"
        },
        "guests": [
          {
            "adult": true,
            "age": null,
            "email": "test@hoteltrader.com",
            "firstName": "test",
            "lastName": "guestnamechangeagain",
            "phone": "1234567890",
            "primary": true
          }
        ],
        "roomSpecialRequests": [
          "room test comments"
        ]
      }
    ]
  }
}

Error

For more information on the list of error codes, see the Error Codes page.

{
  "errors": [
    {
      "message": "Reservation Not found",
      "extensions": {
        "errorCode": 1011
      }
    }
  ],
  "data": {
    "modify": null
  }
}