Skip to main content

Modify Reservation

Reservations can be modified using the PATCH /reservation method.

REST Method/Endpoint

MethodEndpoint
PATCHhttps://[environment]/v1/api/reservation

 

Once a reservation is created and a confirmation number is assigned, it can be used to reference the reservation in order to modify it.

The format of the message is nearly identical to the Create Reservation method with the exception that the message is wrapped in a "Reservations": [{ . . . }] node." Each reservation must also include a CrsConfirmationNumber for the reservation to be modified.

{
    "Reservations":[
        {
             "CrsConfirmationNumber": "CIAOTMH"
          . . .
        }
    ]
}

 

Any modification to a first-level node must include the entire node. For example, any changes to CommissionableAccountProfile, Guests, LoyaltyMemberships, Notification, Overrides, Packages, PurposeOfStay, RoomStay, Transportation, or Upgrade will need to include data for that entire node.

The PATCH operation is a merge to the reservation, meaning items are added or updated but not removed. To remove an item from a reservation such as a package, use the POST operation and provide a full overlay of the reservation.

{
    "Reservations":[
    {
        "CommissionableAccountProfile":{...},
        "Guests": {...},        
        "LoyaltyMemberships": {...},
        "Notification": {...},
        "Overrides": {...},
        "Packages": {...},
        "PurposeOfStay": {...},
        "RoomStay": {...},      
        "Transportation": {...},        
        "Upgrade": {...},       
        "CrsConfirmationNumber": "CIAOTMH",
        "status": "Confirmed"
    }]
}

 

Sample Request

Change the primary guest from Mr. Larry Walker to Mrs. Michelle Walker and include the entire Guests[ ] node.

{
    "Reservations": [{
        "Chain": {
            "Id": 12723
        },
        "Channels": {
            "PrimaryChannel": {
                "Code": "WEB"
            },
            "SecondaryChannel": {
                "Code": "WEB"
            }
        },
        "Hotel": {
            "Id": 13098
        },
        "CrsConfirmationNumber": "CIAOTMH",
        "Guests": [{
            "Role": "Primary",
            "PersonName": {
                "GivenName": "Michelle",
                "MiddleName": "W",
                "Prefix": "Mrs.",
                "Surname": "Walker"
            }
            "Locations": [{
                "Address": {
                    "AddressLine": ["3150 Sabre Dr", "Suite 201"],
                    "City": "Southlake",
                    "Country": {
                        "Code": "US"
                    },
                    "Default": true,
                    "PostalCode": "76093",
                    "StateProv": {
                        "Code": "TX"
                    },
                    "Type": "Business"
                },
                "Name": "Work Address"
            }],
            "ContactNumbers": [{
                "Number": "555-123-4567",
                "Role": "Business",
                "Type": "Voice"
            }],
            "EmailAddress": [{
                "Type": "Primary",
                "Value": "MLWalker@email.com "
            }]
        }],
        "status": "Confirmed"
    }]
}