Skip Navigation

Modify Booking - Examples

Below are some common use cases on how to modify a booking:

CSL hotel booking - add a new corporate ID number

To ensure successful booking modification, the request should contain the below information:

  1. Add confirmationId (PNR Locator) and bookingSignature elements to verify the booking status and prevent applying any unexpected changes.

    Important! You can obtain bookingSignature value and other booking details by using the Get Booking method.

  2. Add hotel details under before (original booking details) and after (desired booking details) properties to determine the scope of changes.

  3. Add the hotel itemId element to indicate the desired item to change.

  4. Make sure that traveler data travelers is specified in the Modify Booking Request and associated with the hotel booking (travelerIndices, leadTravelerIndex, numberOfGuests), to fulfill requirements regarding lead guest information.

  5. Add paymentPolicy information.

{
    "bookingSignature": "0a52276659a660d3b7b1ba04e46bd03764638302bd183a25a3a35a55ca49d3abeb640be09f5f50822f0abd652bf58e7a5f7c4ad467d291f6f78d2170e8ace7ff",
    "confirmationId": "BFJXWT",
    "before": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "23",
                "checkInDate": "2022-05-20",
                "checkOutDate": "2022-05-23",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    },
    "after": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "23",
                "checkInDate": "2022-05-20",
                "checkOutDate": "2022-05-23",
                "corporateDiscountCode": 6878700,
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    }
}

The successful operation will result in no errors and a normalized view of the reservation will be provided in the API response (if specified in the request). In this case, new property "corporateDiscountCode": 6878700, will be added to the hotel booking.

CSL hotel booking - change the check-in/check-out date

To ensure successful booking modification, the request should contain the below information:

  1. Add confirmationId (PNR Locator) and bookingSignature elements to verify the booking status and prevent applying any unexpected changes.

    Important! You can obtain bookingSignature value and other booking details by using Get Booking method.

  2. Add hotel details under before (original booking details) and after (desired booking details) properties to determine the scope of changes.
  3. Add the hotel itemId element to indicate the desired item to change.
  4. Make sure that traveler data travelers is specified in the Modify Booking Request and associated with the hotel booking (travelerIndices, leadTravelerIndex, numberOfGuests), to fulfill requirements regarding lead guest information.
  5. Add paymentPolicy information.
{
    "bookingSignature": "8240f793f1f3e3a7748e925835b0b7ae2ab6e191faf02d18cafafcd73796040b2770353ba38934c92e11c4c62f180a2db472b843e19c7ac7a15b7166b7e617ee",
    "confirmationId": "KNSNZC",
    "before": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "23",
                "checkInDate": "2022-05-20",
                "checkOutDate": "2022-05-23",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    },
    "after": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "23",
                "checkInDate": "2022-05-21",
                "checkOutDate": "2022-05-23",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    }
}

The successful operation will result in no errors, and a normalized view of the reservation will be provided in the API response (if specified in the request). In this case, the modified value of the checkOutDate": "2022-05-21 will be updated in the hotel booking.

Date modification outside of the original date range requires an additional step regarding a re-shop operation.

  1. Add valid bookingKey property for change that requires a re-shop step.

Modify Booking will automatically verify whether this information is present in the request. If not, you will receive an error in the response:

{
    "errors": [
        {
            "category": "BAD_REQUEST",
            "type": "MANDATORY_DATA_MISSING",
            "description": "The request is missing mandatory data.",
            "fieldPath": "ModifyBookingRequest.after.hotels[0]",
            "fieldName": "bookingKey"
        }
    ],
    "request": {
        "bookingSignature": "9a53b216ea712016e5639dcb5895413dab8792cc026336eec9284d2a9565e930475a1747e1622c0b7bdfe01721ae164fc57256154d0f1e8b619b72e2345a6c9a",
        "confirmationId": "KNSNZC",
        "retrieveBooking": false,
        "receivedFrom": "Modify Booking",
        "before": {
            "creationDetails": {
                "agencyIataNumber": "63211116"
            },
            "hotels": [
                {
                    "itemId": "82",
                    "checkInDate": "2022-05-21",
                    "checkOutDate": "2022-05-23",
                    "leadTravelerIndex": 1,
                    "room": {
                        "travelerIndices": [
                            1
                        ]
                    },
                    "numberOfGuests": 1,
                    "paymentPolicy": "GUARANTEE"
                }
            ],
            "payments": {
                "formsOfPayment": [
                    {
                        "type": "PAYMENTCARD",
                        "cardTypeCode": "VI",
                        "cardNumber": "4487971000000006",
                        "expiryDate": "2022-10"
                    }
                ]
            },
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "SMITH",
                    "passengerCode": "ADT",
                    "phones": [
                        {
                            "number": "+123456"
                        }
                    ]
                }
            ]
        },
        "after": {
            "creationDetails": {
                "agencyIataNumber": "63211116"
            },
            "hotels": [
                {
                    "itemId": "82",
                    "checkInDate": "2022-05-24",
                    "checkOutDate": "2022-05-28",
                    "leadTravelerIndex": 1,
                    "room": {
                        "travelerIndices": [
                            1
                        ]
                    },
                    "numberOfGuests": 1,
                    "paymentPolicy": "GUARANTEE"
                }
            ],
            "payments": {
                "formsOfPayment": [
                    {
                        "type": "PAYMENTCARD",
                        "cardTypeCode": "VI",
                        "cardNumber": "4487971000000006",
                        "expiryDate": "2022-10"
                    }
                ]
            },
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "SMITH",
                    "passengerCode": "ADT",
                    "phones": [
                        {
                            "number": "+123456"
                        }
                    ]
                }
            ]
        }
    }
}

A proper request:

{
    "bookingSignature": "9a53b216ea712016e5639dcb5895413dab8792cc026336eec9284d2a9565e930475a1747e1622c0b7bdfe01721ae164fc57256154d0f1e8b619b72e2345a6c9a",
    "confirmationId": "KNSNZC",
    "before": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "82",
                "checkInDate": "2022-05-21",
                "checkOutDate": "2022-05-23",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    },
    "after": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "82",
                "bookingKey": "42d24a3b-04f7-494f-a362-a385bbd8d62c" ,
                "checkInDate": "2022-05-24",
                "checkOutDate": "2022-05-28",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    }
}

The successful operation will result in no errors, and a normalized view of the reservation will be provided in the API response (if specified in the request). In this case the modified value of the checkInDate": "2022-05-24 and checkOutDate": "2022-05-28 be updated in the hotel booking.

CSL hotel booking - delete guest loyalty information

To ensure successful booking modification, the request should contain the below information:

  1. Add confirmationId (PNR Locator) and bookingSignature elements to verify the booking status and prevent applying any unexpected changes.

    Important! You can obtain bookingSignature value and other booking details by using the Get Booking method.

  2. Add hotel details under before (original booking details) and after (desired booking details) properties to determine the scope of changes.
  3. Add the hotel itemId element to indicate the desired item to change.
  4. Make sure that traveler data travelers is specified in the Modify Booking Request and associated with the hotel booking (travelerIndices, leadTravelerIndex, numberOfGuests), to fulfill requirements regarding lead guest information.
  5. Add paymentPolicy information.
{
    "bookingSignature": "4a5a421ada0a2e782967bfca19b646534b8654e89be43f4bec29b1d07179564dfa16159cd3f0c7789b3453bfa8e64b0401da6d63ad1087d30d6090a85ef0ee94",
    "confirmationId": "WVLRLA",
    "before": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "22",
                "checkInDate": "2022-05-24",
                "checkOutDate": "2022-05-28",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ],
                "loyaltyPrograms": [
                    {
                        "programType": "LOYALTY_ID",
                        "programNumber": "987654321"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    },
    "after": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "22",
                "checkInDate": "2022-05-24",
                "checkOutDate": "2022-05-28",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    }
}

The successful operation will result in no errors, and a normalized view of the reservation will be provided in the API response (if specified in the request). In this case, loyaltyPrograms property will not be present in the hotel booking anymore.

CSL hotel booking - change number of guests

To ensure successful booking modification, the request should contain the below information:

  1. Add confirmationId (PNR Locator) and bookingSignature elements to verify the booking status and prevent applying any unexpected changes.

    Important! You can obtain bookingSignature value and other booking details by using the Get Booking method.

  2. Add hotel details under before (original booking details) and after (desired booking details) properties to determine the scope of changes.
  3. Add the hotel itemId element to indicate the desired item to change.
  4. Make sure that traveler data travelers is specified in the Modify Booking Request and associated with the hotel booking (travelerIndices, leadTravelerIndex, numberOfGuests), to fulfill requirements regarding lead guest information.
  5. Add paymentPolicy information.
  6. Add valid bookingKey property for change that requires a re-shop step.

Scenario 1: Modification of number of guests without altering guest personal information

Update numberOfGuests to reflect information stored in the newly generated bookingKey.

{
    "bookingSignature": "2ec155861bda798b84c731784088b5309fca3e772bef655976f5780d3f5a309eef4a8c492784f392da583911d78f5d3f4c48501f40fd7a82deafb99036ed4666",
    "confirmationId": "WVLRLA",
    "before": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "79",
                "checkInDate": "2022-05-24",
                "checkOutDate": "2022-05-28",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ],
                "loyaltyPrograms": [
                    {
                        "programType": "LOYALTY_ID",
                        "programNumber": "987654321"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    },
    "after": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "79",
                "bookingKey":"16cbceaf-4bc4-4835-8b7b-5d86f164c01b",
                "checkInDate": "2022-05-24",
                "checkOutDate": "2022-05-28",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 2,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    }
}

The successful operation will result in no errors and a normalized view of the reservation will be provided in the API response (if specified in the request). In this case, numberOfGuests property will change the value from 1 to 2.

Scenario 2: Modification of number of guests including a change of guest personal information

Update numberOfGuests to reflect information stored in the newly generated bookingKey. You can modify hotel guest association by using travelerIndices property. Sample request containing:

  • increasing the number of guests
  • altering traveler details
  • changing lead guest
  • new loyalty information
  • updating typos in the original traveler name
    {
        "bookingSignature": "9ee349dccc46231954b80367fabb9f7c644f9226ec6dff9079906262b9a24f8f995f3db63e0ed47a31e291cb9256e9237e8ad7969ccfb249f1be69af73f2d9d1",
        "confirmationId": "BGLGVG",
        "retrieveBooking": true,
        "before": {
            "creationDetails": {
                "agencyIataNumber": "63211116"
            },
            "hotels": [
                {
                    "itemId": "22",
                    "checkInDate": "2022-05-24",
                    "checkOutDate": "2022-05-28",
                    "leadTravelerIndex": 1,
                    "room": {
                        "travelerIndices": [
                            1
                        ]
                    },
                    "numberOfGuests": 1,
                    "paymentPolicy": "GUARANTEE"
                }
            ],
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "SMITHHH",
                    "passengerCode": "ADT",
                    "phones": [
                        {
                            "number": "+123456"
                        }
                    ],
                    "loyaltyPrograms": [
                        {
                            "programType": "LOYALTY_ID",
                            "programNumber": "987654321"
                        }
                    ]
                }
            ],
            "payments": {
                "formsOfPayment": [
                    {
                        "type": "PAYMENTCARD",
                        "cardTypeCode": "VI",
                        "cardNumber": "4487971000000006",
                        "expiryDate": "2022-10"
                    }
                ]
            }
        },
        "after": {
            "creationDetails": {
                "agencyIataNumber": "63211116"
            },
            "hotels": [
                {
                    "itemId": "22",
                    "bookingKey": "e3ce2acd-4e09-4223-ab7c-f982f0013163",
                    "checkInDate": "2022-05-24",
                    "checkOutDate": "2022-05-28",
                    "leadTravelerIndex": 2,
                    "room": {
                        "travelerIndices": [
                            1,2
                        ]
                    },
                    "numberOfGuests": 2,
                    "paymentPolicy": "GUARANTEE"
                }
            ],
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "SMITH",
                    "passengerCode": "ADT"
                },
                {
                    "givenName": "MARY",
                    "surname": "SMITH",
                    "passengerCode": "ADT",
                    "phones": [
                        {
                            "number": "+676767"
                        }
                    ],
                    "loyaltyPrograms": [
                        {
                            "programType": "LOYALTY_ID",
                            "programNumber": "4455667"
                        }
                    ]
                }
            ],
            "payments": {
                "formsOfPayment": [
                    {
                        "type": "PAYMENTCARD",
                        "cardTypeCode": "VI",
                        "cardNumber": "4487971000000006",
                        "expiryDate": "2022-10"
                    }
                ]
            }
        }
    }

    Expected response:

    {
        "booking": {
            "startDate": "2022-05-24",
            "endDate": "2022-05-28",
            "isTicketed": false,
            "agencyCustomerNumber": "1234567",
            "creationDetails": {
                "creationUserSine": "AWV",
                "creationDate": "2022-05-16",
                "creationTime": "07:07",
                "agencyIataNumber": "63211116",
                "userWorkPcc": "U9PK",
                "userHomePcc": "U9PK",
                "primeHostId": "1S"
            },
            "contactInfo": {
                "phones": [
                    "123456"
                ]
            },
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "SMITH",
                    "type": "ADULT",
                    "passengerCode": "ADT"
                },
                {
                    "givenName": "MARY",
                    "surname": "SMITH",
                    "type": "ADULT",
                    "passengerCode": "ADT",
                    "phones": [
                        {
                            "number": "+676767"
                        }
                    ],
                    "loyaltyPrograms": [
                        {
                            "programType": "LOYALTY_ID",
                            "programNumber": "4455667"
                        }
                    ]
                }
            ],
            "remarks": [
                {
                    "type": "FORM_OF_PAYMENT",
                    "text": "VI4XXXXXXXXXXX0006Â¥10/22"
                }
            ],
            "hotels": [
                {
                    "itemId": "79",
                    "confirmationId": "3253513908-",
                    "hotelName": "THE WALDORF HILTON LONDON",
                    "address": {
                        "street": "ALDWYCH",
                        "city": "LONDON",
                        "postalCode": "WC2B 4DD",
                        "countryCode": "GB"
                    },
                    "checkInDate": "2022-05-24",
                    "checkInTime": "00:00",
                    "checkOutDate": "2022-05-28",
                    "checkOutTime": "00:00",
                    "leadTravelerIndex": 2,
                    "room": {
                        "quantity": 1,
                        "description": "QUEEN GUEST ROOM DOUBLE BED IN CONTEMPORY SETTING PLASMA TV RAINDROP SHOWER MODEM POINT ROOM ONLY, STRICTER THAN STANDARD CXL POLICY. SEE TERMS AND CONDITIONS FOR CXL POLICY. 326.01 PER NIGHT STARTING 24MAY22 395.01 PER NIGHT STARTING 25MAY22 326.01 PER NIGHT STARTING 27MAY22 TAXES AND SERVICE CHARGES INCLUDED",
                        "roomRate": {
                            "amount": "395.01",
                            "currencyCode": "GBP"
                        },
                        "travelerIndices": [
                            1,
                            2
                        ]
                    },
                    "isRefundable": true,
                    "refundPenalties": [
                        {
                            "applicableFromDate": "2022-05-16T12:09:39.716666",
                            "applicableToDate": "2022-05-21T00:00:00",
                            "penalty": {
                                "amount": "0.00",
                                "currencyCode": "GBP"
                            }
                        },
                        {
                            "applicableFromDate": "2022-05-21T00:00:00",
                            "applicableToDate": "2022-05-28T00:00:00",
                            "penalty": {
                                "amount": "0.00",
                                "currencyCode": "GBP"
                            }
                        }
                    ],
                    "hotelStatusCode": "HK",
                    "hotelStatusName": "Confirmed",
                    "chainCode": "HL",
                    "chainName": "HiltonHotels",
                    "propertyId": "100020146",
                    "contactInfo": {
                        "phones": [
                            "44-207-8362400"
                        ],
                        "faxes": [
                            "44-207-8367244"
                        ]
                    },
                    "guaranteeTypeCode": 5,
                    "guaranteeTypeName": "Credit card",
                    "paymentPolicy": "GUARANTEE",
                    "payment": {
                        "subtotal": "1442.03",
                        "total": "1442.03",
                        "currencyCode": "GBP"
                    },
                    "numberOfGuests": 2,
                    "sourceTypeCode": 100,
                    "sourceTypeName": "Sabre GDS"
                }
            ],
            "allSegments": [
                {
                    "id": "79",
                    "type": "HOTEL",
                    "text": "3253513908-",
                    "vendorCode": "HL",
                    "locationCode": "LHR",
                    "address": {
                        "street": "ALDWYCH",
                        "city": "LONDON",
                        "postalCode": "WC2B 4DD",
                        "countryCode": "GB"
                    },
                    "startDate": "2022-05-24",
                    "startTime": "00:00",
                    "endDate": "2022-05-28",
                    "endTime": "00:00"
                }
            ],
            "payments": {
                "hotelTotals": [
                    {
                        "subtotal": "1442.03",
                        "total": "1442.03",
                        "currencyCode": "GBP"
                    }
                ],
                "formsOfPayment": [
                    {
                        "type": "PAYMENTCARD",
                        "cardTypeCode": "VI",
                        "cardNumber": "4XXXXXXXXXXX0006",
                        "expiryDate": "2022-10"
                    }
                ]
            },
            "otherServices": [
                {
                    "chainCode": "HL",
                    "serviceMessage": "HHL HL 12451 ARR24MAY CXL 3 DAYS PRIOR TO AR"
                },
                {
                    "chainCode": "HL",
                    "serviceMessage": "HHL HL 12451 ARR24MAY CREDIT CARD GUARANTEE"
                },
                {
                    "chainCode": "HL",
                    "serviceMessage": "HHL 100020146 A03DN8  D SEMI-FLEX"
                },
                {
                    "chainCode": "HL",
                    "serviceMessage": "HHL 100020146 A03DN8  C CANCEL 3 DAY PRIOR TO ARRIVA"
                },
                {
                    "chainCode": "HL",
                    "serviceMessage": "HHL 100020146 A03DN8  D QUEEN GUEST ROOM DOUBLE BED"
                },
                {
                    "chainCode": "HL",
                    "serviceMessage": "HHL 100020146 A03DN8  D IN CONTEMPORY SETTING PLASMA"
                },
                {
                    "chainCode": "HL",
                    "serviceMessage": "HHL 100020146 A03DN8  TP 1442.03 GBP APPROX. TTL PRI"
                },
                {
                    "chainCode": "HL",
                    "serviceMessage": "HHL 100020146 A03DN8  TD INCLUDES TAXES AND SURCHARG"
                }
            ]
        },
        "request": {
            "bookingSignature": "9ee349dccc46231954b80367fabb9f7c644f9226ec6dff9079906262b9a24f8f995f3db63e0ed47a31e291cb9256e9237e8ad7969ccfb249f1be69af73f2d9d1",
            "confirmationId": "BGLGVG",
            "retrieveBooking": true,
            "receivedFrom": "Modify Booking",
            "before": {
                "creationDetails": {
                    "agencyIataNumber": "63211116"
                },
                "hotels": [
                    {
                        "itemId": "22",
                        "checkInDate": "2022-05-24",
                        "checkOutDate": "2022-05-28",
                        "leadTravelerIndex": 1,
                        "room": {
                            "travelerIndices": [
                                1
                            ]
                        },
                        "numberOfGuests": 1,
                        "paymentPolicy": "GUARANTEE"
                    }
                ],
                "payments": {
                    "formsOfPayment": [
                        {
                            "type": "PAYMENTCARD",
                            "cardTypeCode": "VI",
                            "cardNumber": "4487971000000006",
                            "expiryDate": "2022-10"
                        }
                    ]
                },
                "travelers": [
                    {
                        "givenName": "JOHN",
                        "surname": "SMITHHH",
                        "passengerCode": "ADT",
                        "phones": [
                            {
                                "number": "+123456"
                            }
                        ],
                        "loyaltyPrograms": [
                            {
                                "programType": "LOYALTY_ID",
                                "programNumber": "987654321"
                            }
                        ]
                    }
                ]
            },
            "after": {
                "creationDetails": {
                    "agencyIataNumber": "63211116"
                },
                "hotels": [
                    {
                        "itemId": "22",
                        "bookingKey": "e3ce2acd-4e09-4223-ab7c-f982f0013163",
                        "checkInDate": "2022-05-24",
                        "checkOutDate": "2022-05-28",
                        "leadTravelerIndex": 2,
                        "room": {
                            "travelerIndices": [
                                1,
                                2
                            ]
                        },
                        "numberOfGuests": 2,
                        "paymentPolicy": "GUARANTEE"
                    }
                ],
                "payments": {
                    "formsOfPayment": [
                        {
                            "type": "PAYMENTCARD",
                            "cardTypeCode": "VI",
                            "cardNumber": "4487971000000006",
                            "expiryDate": "2022-10"
                        }
                    ]
                },
                "travelers": [
                    {
                        "givenName": "JOHN",
                        "surname": "SMITH",
                        "passengerCode": "ADT"
                    },
                    {
                        "givenName": "MARY",
                        "surname": "SMITH",
                        "passengerCode": "ADT",
                        "phones": [
                            {
                                "number": "+676767"
                            }
                        ],
                        "loyaltyPrograms": [
                            {
                                "programType": "LOYALTY_ID",
                                "programNumber": "4455667"
                            }
                        ]
                    }
                ]
            }
        }
    }

Important! Modify Booking prevents removing travelers originally stored in the PNR. This operation is available only if a particular traveler is only part of the lodging guest list. You can still update their name/surname information though.

CSL hotel booking - modify the form of payment

To ensure successful booking modification, the request should contain the below information:

  1. Add confirmationId (PNR Locator) and bookingSignature elements to verify the booking status and prevent applying any unexpected changes.

    Important! You can obtain bookingSignature value and other booking details by using the Get Booking method.

  2. Add hotel details under before (original booking details) and after (desired booking details) properties to determine the scope of changes.
  3. Add the hotel itemId element to indicate the desired item to change.
  4. Make sure that traveler data travelers is specified in the Modify Booking Request and associated with the hotel booking (travelerIndices, leadTravelerIndex, numberOfGuests), to fulfill requirements regarding lead guest information.
  5. Add paymentPolicy information.
{
    "bookingSignature": "bb805c0eb824257aa7c866e6c2f0af8ed895702a2f3e7c6e2fb9f11f8a48fd83e0e8bf13b71d488718d74605945014c7ee270500767b4f77628d566db1243076",
    "confirmationId": "LFNNIT",
    "retrieveBooking": true,
    "before": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "22",
                "checkInDate": "2022-05-24",
                "checkOutDate": "2022-05-28",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE"
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "VI",
                    "cardNumber": "4487971000000006",
                    "expiryDate": "2022-10"
                }
            ]
        }
    },
    "after": {
        "creationDetails": {
            "agencyIataNumber": "63211116"
        },
        "hotels": [
            {
                "itemId": "22",
                "checkInDate": "2022-05-24",
                "checkOutDate": "2022-05-28",
                "leadTravelerIndex": 1,
                "room": {
                    "travelerIndices": [
                        1
                    ]
                },
                "numberOfGuests": 1,
                "paymentPolicy": "GUARANTEE",
                "formOfPaymentIndex": 1
            }
        ],
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "payments": {
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "CA",
                    "cardNumber": "5105105105105100",
                    "expiryDate": "2023-10",
                    "cardSecurityCode": "123"
                }
            ]
        }
    }
}

The successful operation will result in no errors, and a normalized view of the reservation will be provided in the API response (if specified in the request). In this case, formsOfPayment property will contain new credit card information.

Expected response:

{
    "booking": {
        "startDate": "2022-05-24",
        "endDate": "2022-05-28",
        "isTicketed": false,
        "agencyCustomerNumber": "1234567",
        "creationDetails": {
            "creationUserSine": "AWV",
            "creationDate": "2022-05-16",
            "creationTime": "08:34",
            "agencyIataNumber": "63211116",
            "userWorkPcc": "U9PK",
            "userHomePcc": "U9PK",
            "primeHostId": "1S"
        },
        "contactInfo": {
            "phones": [
                "123456"
            ]
        },
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "SMITH",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "+123456"
                    }
                ]
            }
        ],
        "remarks": [
            {
                "type": "FORM_OF_PAYMENT",
                "text": "CA5XXXXXXXXXXX5100Â¥10/23"
            }
        ],
        "hotels": [
            {
                "itemId": "77",
                "confirmationId": "3251136737-",
                "hotelName": "THE WALDORF HILTON LONDON",
                "address": {
                    "street": "ALDWYCH",
                    "city": "LONDON",
                    "postalCode": "WC2B 4DD",
                    "countryCode": "GB"
                },
                "checkInDate": "2022-05-24",
                "checkInTime": "00:00",
                "checkOutDate": "2022-05-28",
                "checkOutTime": "00:00",
                "leadTravelerIndex": 1,
                "room": {
                    "quantity": 1,
                    "description": "QUEEN GUEST ROOM DOUBLE BED IN CONTEMPORY SETTING PLASMA TV RAINDROP SHOWER MODEM POINT ROOM ONLY, STRICTER THAN STANDARD CXL POLICY. SEE TERMS AND CONDITIONS FOR CXL POLICY. 326.01 PER NIGHT STARTING 24MAY22 395.01 PER NIGHT STARTING 25MAY22 326.01 PER NIGHT STARTING 27MAY22 TAXES AND SERVICE CHARGES INCLUDED",
                    "roomRate": {
                        "amount": "395.01",
                        "currencyCode": "GBP"
                    },
                    "travelerIndices": [
                        1
                    ]
                },
                "isRefundable": true,
                "refundPenalties": [
                    {
                        "applicableFromDate": "2022-05-16T13:35:08.582138",
                        "applicableToDate": "2022-05-21T00:00:00",
                        "penalty": {
                            "amount": "0.00",
                            "currencyCode": "GBP"
                        }
                    },
                    {
                        "applicableFromDate": "2022-05-21T00:00:00",
                        "applicableToDate": "2022-05-28T00:00:00",
                        "penalty": {
                            "amount": "0.00",
                            "currencyCode": "GBP"
                        }
                    }
                ],
                "hotelStatusCode": "HK",
                "hotelStatusName": "Confirmed",
                "chainCode": "HL",
                "chainName": "HiltonHotels",
                "propertyId": "100020146",
                "contactInfo": {
                    "phones": [
                        "44-207-8362400"
                    ],
                    "faxes": [
                        "44-207-8367244"
                    ]
                },
                "guaranteeTypeCode": 5,
                "guaranteeTypeName": "Credit card",
                "paymentPolicy": "GUARANTEE",
                "payment": {
                    "subtotal": "1442.03",
                    "total": "1442.03",
                    "currencyCode": "GBP"
                },
                "numberOfGuests": 1,
                "sourceTypeCode": 100,
                "sourceTypeName": "Sabre GDS"
            }
        ],
        "allSegments": [
            {
                "id": "77",
                "type": "HOTEL",
                "text": "3251136737-",
                "vendorCode": "HL",
                "locationCode": "LHR",
                "address": {
                    "street": "ALDWYCH",
                    "city": "LONDON",
                    "postalCode": "WC2B 4DD",
                    "countryCode": "GB"
                },
                "startDate": "2022-05-24",
                "startTime": "00:00",
                "endDate": "2022-05-28",
                "endTime": "00:00"
            }
        ],
        "payments": {
            "hotelTotals": [
                {
                    "subtotal": "1442.03",
                    "total": "1442.03",
                    "currencyCode": "GBP"
                }
            ],
            "formsOfPayment": [
                {
                    "type": "PAYMENTCARD",
                    "cardTypeCode": "CA",
                    "cardNumber": "5XXXXXXXXXXX5100",
                    "expiryDate": "2023-10"
                }
            ]
        },
        "otherServices": [
            {
                "chainCode": "HL",
                "serviceMessage": "HHL HL 12451 ARR24MAY CXL 3 DAYS PRIOR TO AR"
            },
            {
                "chainCode": "HL",
                "serviceMessage": "HHL HL 12451 ARR24MAY CREDIT CARD GUARANTEE"
            },
            {
                "chainCode": "HL",
                "serviceMessage": "HHL 100020146 A03DN8  D SEMI-FLEX"
            },
            {
                "chainCode": "HL",
                "serviceMessage": "HHL 100020146 A03DN8  C CANCEL 3 DAY PRIOR TO ARRIVA"
            },
            {
                "chainCode": "HL",
                "serviceMessage": "HHL 100020146 A03DN8  D QUEEN GUEST ROOM DOUBLE BED"
            },
            {
                "chainCode": "HL",
                "serviceMessage": "HHL 100020146 A03DN8  D IN CONTEMPORY SETTING PLASMA"
            },
            {
                "chainCode": "HL",
                "serviceMessage": "HHL 100020146 A03DN8  TP 1442.03 GBP APPROX. TTL PRI"
            },
            {
                "chainCode": "HL",
                "serviceMessage": "HHL 100020146 A03DN8  TD INCLUDES TAXES AND SURCHARG"
            }
        ]
    },
    "request": {
        "bookingSignature": "bb805c0eb824257aa7c866e6c2f0af8ed895702a2f3e7c6e2fb9f11f8a48fd83e0e8bf13b71d488718d74605945014c7ee270500767b4f77628d566db1243076",
        "confirmationId": "LFNNIT",
        "retrieveBooking": true,
        "receivedFrom": "Modify Booking",
        "before": {
            "creationDetails": {
                "agencyIataNumber": "63211116"
            },
            "hotels": [
                {
                    "itemId": "22",
                    "checkInDate": "2022-05-24",
                    "checkOutDate": "2022-05-28",
                    "leadTravelerIndex": 1,
                    "room": {
                        "travelerIndices": [
                            1
                        ]
                    },
                    "numberOfGuests": 1,
                    "paymentPolicy": "GUARANTEE"
                }
            ],
            "payments": {
                "formsOfPayment": [
                    {
                        "type": "PAYMENTCARD",
                        "cardTypeCode": "VI",
                        "cardNumber": "4487971000000006",
                        "expiryDate": "2022-10"
                    }
                ]
            },
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "SMITH",
                    "passengerCode": "ADT",
                    "phones": [
                        {
                            "number": "+123456"
                        }
                    ]
                }
            ]
        },
        "after": {
            "creationDetails": {
                "agencyIataNumber": "63211116"
            },
            "hotels": [
                {
                    "itemId": "22",
                    "checkInDate": "2022-05-24",
                    "checkOutDate": "2022-05-28",
                    "leadTravelerIndex": 1,
                    "room": {
                        "travelerIndices": [
                            1
                        ]
                    },
                    "numberOfGuests": 1,
                    "paymentPolicy": "GUARANTEE",
                    "formOfPaymentIndex": 1
                }
            ],
            "payments": {
                "formsOfPayment": [
                    {
                        "type": "PAYMENTCARD",
                        "cardTypeCode": "CA",
                        "cardNumber": "5105105105105100",
                        "cardSecurityCode": "123",
                        "expiryDate": "2023-10"
                    }
                ]
            },
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "SMITH",
                    "passengerCode": "ADT",
                    "phones": [
                        {
                            "number": "+123456"
                        }
                    ]
                }
            ]
        }
    }
}

Group booking - modify the traveler details

To ensure successful booking modification, the request should contain the below information:

  1. Add confirmationId (PNR Locator) and bookingSignature elements to verify the booking status and prevent applying any unexpected changes.

    Important! You can obtain bookingSignature value and other booking details by using the Get Booking method.

  2. Add booking details under the before (original booking details) and after (desired booking details) properties to determine the scope of the changes.
  3. Ensure that traveler data (travelers) specified in the Modify Booking request is associated with the group (isGrouped: true).
{
    "bookingSignature": "f9b562810a6b8797794ab882318a8f31c011c46851edbeb4a78b0bf097a7e8f3b3da4bc705d779e1ccdc0a21151b14daacc66b70435fad09ca0c4d48bff6af1b",
    "confirmationId": "AULKIH",
    "retrieveBooking": true,
    "receivedFrom": "Modify Booking",
    "before": {
        "travelers": [
            {
                "givenName": "JOE",
                "surname": "DOE",
                "passengerCode": "ADT",
                "isGrouped": true,
                "phones": [
                    {
                        "number": "817-555-1212",
                        "label": "H"
                    }
                ]
            },
            {
                "givenName": "JANE",
                "surname": "DOE",
                "passengerCode": "ADT",
                "isGrouped": true
            },
            {
                "givenName": "JILL",
                "surname": "DOE",
                "birthDate": "2022-03-04",
                "passengerCode": "INF",
                "isGrouped": true
            }
        ]
    },
    "after": {
        "travelers": [
            {
                "givenName": "JOE",
                "surname": "DOE",
                "passengerCode": "ADT",
                "isGrouped": true,
                "phones": [
                    {
                        "number": "666-555-1212",
                        "label": "H"
                    }
                ]
            },
            {
                "givenName": "JANE",
                "surname": "DOE",
                "passengerCode": "ADT",
                "isGrouped": true
            },
            {
                "givenName": "MEG",
                "surname": "DOE",
                "passengerCode": "ADT",
                "isGrouped": true
            },
            {
                "givenName": "JILL",
                "surname": "DOE",
                "passengerCode": "INF",
                "birthDate": "2022-03-04",
                "isGrouped": true
            },
            {
                "givenName": "PATTRICK",
                "surname": "DOE",
                "passengerCode": "INF",
                "birthDate": "2022-03-05",
                "isGrouped": true
            }
        ]
    }
}

The successful operation will result in no errors, and a normalized view of the reservation will be provided in the API response (if specified in the request). In this case, the travelers array will contain new adult and infant traveler details. Additionally, the phone number of the first traveler will be updated.

Expected response:

{
    "booking": {
        "startDate": "2022-11-11",
        "endDate": "2022-11-11",
        "isTicketed": false,
        "creationDetails": {
            "creationUserSine": "AWV",
            "creationDate": "2022-09-19",
            "creationTime": "05:30",
            "userWorkPcc": "U9PK",
            "userHomePcc": "U9PK",
            "primeHostId": "1S"
        },
        "contactInfo": {
            "emails": [
                "TEST.EMAIL@SABRE.COM"
            ],
            "phones": [
                "666-555-1212-H-1.1"
            ]
        },
        "travelers": [
            {
                "givenName": "JOE",
                "surname": "DOE",
                "type": "ADULT",
                "passengerCode": "ADT",
                "isGrouped": true,
                "phones": [
                    {
                        "number": "666-555-1212",
                        "label": "H"
                    }
                ]
            },
            {
                "givenName": "JANE",
                "surname": "DOE",
                "type": "ADULT",
                "passengerCode": "ADT",
                "isGrouped": true
            },
            {
                "givenName": "MEG",
                "surname": "DOE",
                "type": "ADULT",
                "passengerCode": "ADT",
                "isGrouped": true
            },
            {
                "givenName": "JILL",
                "surname": "DOE",
                "type": "INFANT",
                "passengerCode": "INF",
                "isGrouped": true
            },
            {
                "givenName": "PATTRICK",
                "surname": "DOE",
                "type": "INFANT",
                "passengerCode": "INF",
                "isGrouped": true
            }
        ],
        "travelersGroup": {
            "itemId": "3",
            "name": "GROUP A",
            "numberOfTravelers": 3,
            "numberOfTravelersRemaining": 0
        },
        "flights": [
            {
                "itemId": "13",
                "sourceType": "ATPCO",
                "flightNumber": 309,
                "airlineCode": "BA",
                "operatingFlightNumber": 309,
                "operatingAirlineCode": "BA",
                "fromAirportCode": "CDG",
                "toAirportCode": "LHR",
                "departureDate": "2022-11-11",
                "departureTime": "11:50:00",
                "departureTerminalName": "AEROGARE 2 TERMINAL A",
                "departureGate": "2A",
                "arrivalDate": "2022-11-11",
                "arrivalTime": "12:10:00",
                "arrivalTerminalName": "TERMINAL 5",
                "arrivalGate": "5",
                "numberOfSeats": 3,
                "cabinTypeName": "ECONOMY",
                "cabinTypeCode": "Y",
                "aircraftTypeCode": "320",
                "bookingClass": "Y",
                "meals": [
                    {
                        "code": "G",
                        "description": "Food and beverage for purchase"
                    }
                ],
                "flightStatusCode": "GK",
                "flightStatusName": "Confirmed",
                "durationInMinutes": 80,
                "distanceInMiles": 216,
                "travelerIndices": [
                    1,
                    2,
                    3,
                    4,
                    5
                ]
            }
        ],
        "journeys": [
            {
                "firstAirportCode": "CDG",
                "departureDate": "2022-11-11",
                "departureTime": "11:50",
                "lastAirportCode": "LHR",
                "numberOfFlights": 1
            }
        ],
        "allSegments": [
            {
                "id": "13",
                "type": "FLIGHT",
                "text": "309",
                "vendorCode": "BA",
                "startDate": "2022-11-11",
                "startTime": "11:50:00",
                "startLocationCode": "CDG",
                "endDate": "2022-11-11",
                "endTime": "12:10:00",
                "endLocationCode": "LHR"
            }
        ]
    },
    "request": {
        "bookingSignature": "f9b562810a6b8797794ab882318a8f31c011c46851edbeb4a78b0bf097a7e8f3b3da4bc705d779e1ccdc0a21151b14daacc66b70435fad09ca0c4d48bff6af1b",
        "confirmationId": "AULKIH",
        "retrieveBooking": true,
        "receivedFrom": "Modify Booking",
        "before": {
            "travelers": [
                {
                    "givenName": "JOE",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "isGrouped": true,
                    "phones": [
                        {
                            "number": "817-555-1212",
                            "label": "H"
                        }
                    ]
                },
                {
                    "givenName": "JANE",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "isGrouped": true
                },
                {
                    "givenName": "JILL",
                    "surname": "DOE",
                    "birthDate": "2022-03-04",
                    "passengerCode": "INF",
                    "isGrouped": true
                }
            ]
        },
        "after": {
            "travelers": [
                {
                    "givenName": "JOE",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "isGrouped": true,
                    "phones": [
                        {
                            "number": "666-555-1212",
                            "label": "H"
                        }
                    ]
                },
                {
                    "givenName": "JANE",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "isGrouped": true
                },
                {
                    "givenName": "MEG",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "isGrouped": true
                },
                {
                    "givenName": "JILL",
                    "surname": "DOE",
                    "birthDate": "2022-03-04",
                    "passengerCode": "INF",
                    "isGrouped": true
                },
                {
                    "givenName": "PATTRICK",
                    "surname": "DOE",
                    "birthDate": "2022-03-05",
                    "passengerCode": "INF",
                    "isGrouped": true
                }
            ]
        }
    }
}

ATPCO booking - add new special service request (SSR)

To ensure successful booking modification, the request should contain the below information:

  1. Add confirmationId (PNR Locator) and bookingSignature elements to verify the booking status and prevent applying any unexpected changes.

    Important! You can obtain bookingSignature value and other booking details by using the Get Booking method.

  2. Add booking details under the before (original booking details) and after (desired booking details) properties to determine the scope of the changes.
  3. Ensure that special service information (specialServices) is specified in the Modify Booking request.
{
    "bookingSignature": "caf89a8912f39cfa88fe00cd3a2136898c5f116569eeb2a103a48cd5cbe2cb9ef964c21329f055965abee1026924356089e36e8a9e9e2764c2403119a5a36a00",
    "confirmationId": "AXAXTN",
    "retrieveBooking": true,
    "receivedFrom": "Modify Booking",
    "before": {
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "DOE",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "1-555-123-4567",
                        "label": "M"
                    }
                ]
            }
        ]
    },
    "after": {
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "DOE",
                "passengerCode": "ADT",
                "phones": [
                    {
                        "number": "1-555-123-4567",
                        "label": "M"
                    }
                ],
                "loyaltyPrograms": [
                    {
                        "supplierCode": "BA",
                        "programType": "FREQUENT_FLYER",
                        "programNumber": "7654325643",
                        "tierLevel": "1",
                        "receiverCode": "BA"
                    }
                ],
                "emails": [
                    "john.doe@sabre.com"
                ]
            }
        ],
        "specialServices": [
            {
                "travelerIndices": [
                    1
                ],
                "code": "BLND"
            },
            {
                "travelerIndices": [
                    1
                ],
                "code": "WCHR",
                "flightIndices": [
                    1
                ]
            }
        ]
    }
}

The successful operation will result in no errors, and a normalized view of the reservation will be provided in the API response (if specified in the request). In this case, the specialServices array will contain new SSR details. Additionally, traveler's information will be updated (added email and frequent flyer program).

Expected response:

{
    "booking": {
        "startDate": "2022-12-23",
        "endDate": "2022-12-28",
        "isTicketed": false,
        "creationDetails": {
            "creationUserSine": "AWV",
            "creationDate": "2022-09-19",
            "creationTime": "06:07",
            "userWorkPcc": "U9PK",
            "userHomePcc": "U9PK",
            "primeHostId": "1S"
        },
        "contactInfo": {
            "emails": [
                "TRAVEL@SABRE.COM"
            ],
            "phones": [
                "123456",
                "1-555-123-4567-M-1.1"
            ]
        },
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "DOE",
                "type": "ADULT",
                "passengerCode": "ADT",
                "emails": [
                    "JOHN.DOE@SABRE.COM"
                ],
                "phones": [
                    {
                        "number": "1-555-123-4567",
                        "label": "M"
                    }
                ],
                "loyaltyPrograms": [
                    {
                        "supplierCode": "BA",
                        "programType": "FREQUENT_FLYER",
                        "programNumber": "7654325643",
                        "receiverCode": "BA"
                    }
                ]
            }
        ],
        "flights": [
            {
                "itemId": "13",
                "confirmationId": "SURTM9",
                "sourceType": "ATPCO",
                "flightNumber": 456,
                "airlineCode": "BA",
                "operatingFlightNumber": 456,
                "operatingAirlineCode": "BA",
                "fromAirportCode": "LHR",
                "toAirportCode": "MAD",
                "departureDate": "2022-12-23",
                "departureTime": "06:05:00",
                "departureTerminalName": "TERMINAL 5",
                "departureGate": "5",
                "arrivalDate": "2022-12-23",
                "arrivalTime": "09:40:00",
                "arrivalTerminalName": "TERMINAL 4S",
                "arrivalGate": "4S",
                "numberOfSeats": 1,
                "cabinTypeName": "ECONOMY",
                "cabinTypeCode": "Y",
                "aircraftTypeCode": "320",
                "bookingClass": "Y",
                "meals": [
                    {
                        "code": "G",
                        "description": "Food and beverage for purchase"
                    }
                ],
                "flightStatusCode": "HK",
                "flightStatusName": "Confirmed",
                "durationInMinutes": 155,
                "distanceInMiles": 774,
                "travelerIndices": [
                    1
                ]
            },
            {
                "itemId": "14",
                "confirmationId": "SURTM9",
                "sourceType": "ATPCO",
                "flightNumber": 457,
                "airlineCode": "BA",
                "operatingFlightNumber": 457,
                "operatingAirlineCode": "BA",
                "fromAirportCode": "MAD",
                "toAirportCode": "LHR",
                "departureDate": "2022-12-28",
                "departureTime": "10:45:00",
                "departureTerminalName": "TERMINAL 4S",
                "departureGate": "4S",
                "arrivalDate": "2022-12-28",
                "arrivalTime": "12:15:00",
                "arrivalTerminalName": "TERMINAL 5",
                "arrivalGate": "5",
                "numberOfSeats": 1,
                "cabinTypeName": "ECONOMY",
                "cabinTypeCode": "Y",
                "aircraftTypeCode": "320",
                "bookingClass": "Y",
                "meals": [
                    {
                        "code": "G",
                        "description": "Food and beverage for purchase"
                    }
                ],
                "flightStatusCode": "HK",
                "flightStatusName": "Confirmed",
                "durationInMinutes": 150,
                "distanceInMiles": 774,
                "travelerIndices": [
                    1
                ]
            }
        ],
        "journeys": [
            {
                "firstAirportCode": "LHR",
                "departureDate": "2022-12-23",
                "departureTime": "06:05",
                "lastAirportCode": "MAD",
                "numberOfFlights": 1
            },
            {
                "firstAirportCode": "MAD",
                "departureDate": "2022-12-28",
                "departureTime": "10:45",
                "lastAirportCode": "LHR",
                "numberOfFlights": 1
            }
        ],
        "allSegments": [
            {
                "id": "13",
                "type": "FLIGHT",
                "text": "456",
                "vendorCode": "BA",
                "startDate": "2022-12-23",
                "startTime": "06:05:00",
                "startLocationCode": "LHR",
                "endDate": "2022-12-23",
                "endTime": "09:40:00",
                "endLocationCode": "MAD"
            },
            {
                "id": "14",
                "type": "FLIGHT",
                "text": "457",
                "vendorCode": "BA",
                "startDate": "2022-12-28",
                "startTime": "10:45:00",
                "startLocationCode": "MAD",
                "endDate": "2022-12-28",
                "endTime": "12:15:00",
                "endLocationCode": "LHR"
            }
        ],
        "specialServices": [
            {
                "travelerIndices": [
                    1
                ],
                "code": "BLND",
                "name": "Blind Passenger",
                "statusCode": "NN",
                "statusName": "On Request"
            },
            {
                "travelerIndices": [
                    1
                ],
                "code": "WCHR",
                "name": "Wheelchair - R for Ramp (Passenger can ascend/descend steps and make own way to/from cabin seat but requires wheelchair for distance to/from aircraft)",
                "statusCode": "NN",
                "statusName": "On Request"
            }
        ]
    },
    "request": {
        "bookingSignature": "caf89a8912f39cfa88fe00cd3a2136898c5f116569eeb2a103a48cd5cbe2cb9ef964c21329f055965abee1026924356089e36e8a9e9e2764c2403119a5a36a00",
        "confirmationId": "AXAXTN",
        "retrieveBooking": true,
        "receivedFrom": "Modify Booking",
        "before": {
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "phones": [
                        {
                            "number": "1-555-123-4567",
                            "label": "M"
                        }
                    ]
                }
            ]
        },
        "after": {
            "specialServices": [
                {
                    "travelerIndices": [
                        1
                    ],
                    "code": "BLND"
                },
                {
                    "travelerIndices": [
                        1
                    ],
                    "code": "WCHR"
                }
            ],
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "emails": [
                        "john.doe@sabre.com"
                    ],
                    "phones": [
                        {
                            "number": "1-555-123-4567",
                            "label": "M"
                        }
                    ],
                    "loyaltyPrograms": [
                        {
                            "supplierCode": "BA",
                            "programType": "FREQUENT_FLYER",
                            "programNumber": "7654325643",
                            "tierLevel": 1,
                            "receiverCode": "BA"
                        }
                    ]
                }
            ]
        }
    }
}

ATPCO booking - modify identity document (PASSPORT) details

To ensure successful booking modification, the request should contain the information below:

  1. Add confirmationId (PNR Locator) and bookingSignature elements to verify the booking status and prevent applying any unexpected changes.

    Important! You can obtain bookingSignature value and other booking details by using the Get Booking method.

  2. Add booking details under the before (original booking details) and after (desired booking details) properties to determine the scope of your changes.
  3. Ensure that passport information (travelers.identityDocuments) is updated in the Modify Booking request.

Important! Modification of identity documents is done by means of the travelers.identityDocuments properties. The corresponding special service request (specialServices) is changed automatically. A direct modification of the DOCO, DOCA, and DOCO SSRs is not allowed.

{
    "bookingSignature": "0606d8125e90bfc2ea0fd2daf2876a889cb79434afaa2a42f5a257f5676eae5bbe28f0eaab060d4a4dff4c603baaabca291d8513dd1518808aad3f1ef64d69bf",
    "confirmationId": "OFGBRU",
    "before": {
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "DOE",
                "type": "ADULT",
                "passengerCode": "ADT",
                "identityDocuments": [
                    {
                        "documentNumber": "0123456789",
                        "documentType": "PASSPORT",
                        "expiryDate": "2024-07-09",
                        "issuingCountryCode": "US",
                        "residenceCountryCode": "POL",
                        "givenName": "JOHN",
                        "middleName": "JACK",
                        "surname": "SMITH",
                        "birthDate": "1970-01-23",
                        "gender": "MALE",
                        "isPrimaryDocumentHolder": false
                    }
                ]
            }
        ],
        "specialServices": [
            {
                "travelerIndices": [
                    1
                ],
                "code": "DOCS",
                "name": "API-Passenger Travel Document",
                "message": "/P/US/0123456789/POL/23JAN1970/M/09JUL2024/SMITH/JOHN/JACK",
                "statusCode": "HK",
                "statusName": "Confirmed"
            },
            {
                "code": "OTHS",
                "message": "MISSING SSR CTCM MOBILE OR SSR CTCE EMAIL OR SSR CTCR NON-CONSENT FOR BA"
            }
        ]
    },
    "after": {
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "DOE",
                "type": "ADULT",
                "passengerCode": "ADT",
                "identityDocuments": [
                    {
                        "documentNumber": "987765452",
                        "documentType": "PASSPORT",
                        "expiryDate": "2024-07-09",
                        "issuingCountryCode": "US",
                        "residenceCountryCode": "GB",
                        "givenName": "JOHN",
                        "surname": "DOE",
                        "birthDate": "1970-01-23",
                        "gender": "MALE",
                        "isPrimaryDocumentHolder": false
                    }
                ]
            }
        ],
        "specialServices": [
            {
                "travelerIndices": [
                    1
                ],
                "code": "DOCS",
                "name": "API-Passenger Travel Document",
                "message": "/P/US/0123456789/POL/23JAN1970/M/09JUL2024/SMITH/JOHN/JACK",
                "statusCode": "HK",
                "statusName": "Confirmed"
            },
            {
                "code": "OTHS",
                "message": "MISSING SSR CTCM MOBILE OR SSR CTCE EMAIL OR SSR CTCR NON-CONSENT FOR BA"
            }
        ]
    },
    "retrieveBooking": true,
    "receivedFrom": "Booking Management API testing"
}

Successful operation results in no errors, and a normalized view of the reservation is provided in the API response (if specified in the request). In this case, the identityDocuments array contains new PASSPORT document details.

Expected response:

{
    "timestamp": "2023-03-21T14:22:05",
    "booking": {
        "startDate": "2023-09-23",
        "endDate": "2023-09-23",
        "isTicketed": false,
        "creationDetails": {
            "creationUserSine": "AWV",
            "creationDate": "2023-03-20",
            "creationTime": "09:57",
            "userWorkPcc": "U9PK",
            "userHomePcc": "U9PK",
            "primeHostId": "1S"
        },
        "contactInfo": {
            "phones": [
                "123456"
            ]
        },
        "travelers": [
            {
                "givenName": "JOHN",
                "surname": "DOE",
                "type": "ADULT",
                "passengerCode": "ADT",
                "identityDocuments": [
                    {
                        "documentNumber": "987765452",
                        "documentType": "PASSPORT",
                        "expiryDate": "2024-07-09",
                        "issuingCountryCode": "US",
                        "residenceCountryCode": "GB",
                        "givenName": "JOHN",
                        "surname": "DOE",
                        "birthDate": "1970-01-23",
                        "gender": "MALE",
                        "isPrimaryDocumentHolder": false,
                        "itemId": "a6dfc58e0b9ba95cb83d41ba92160ad9d559278fb6f7e1c69aba6c90945a435f17c3384ed39373a9d95a87ac8e25c9bc5d3fdfd01d9f411389c33c8334a89ef9"
                    }
                ]
            }
        ],
        "flights": [
            {
                "itemId": "11",
                "confirmationId": "T89AA5",
                "sourceType": "ATPCO",
                "flightNumber": 458,
                "airlineCode": "BA",
                "operatingFlightNumber": 458,
                "operatingAirlineCode": "BA",
                "fromAirportCode": "LHR",
                "toAirportCode": "MAD",
                "departureDate": "2023-09-23",
                "departureTime": "07:45:00",
                "departureTerminalName": "TERMINAL 5",
                "departureGate": "5",
                "arrivalDate": "2023-09-23",
                "arrivalTime": "11:10:00",
                "arrivalTerminalName": "TERMINAL 4S",
                "arrivalGate": "4S",
                "numberOfSeats": 1,
                "cabinTypeName": "ECONOMY",
                "cabinTypeCode": "Y",
                "aircraftTypeCode": "320",
                "aircraftTypeName": "AIRBUS",
                "bookingClass": "Y",
                "meals": [
                    {
                        "code": "G",
                        "description": "Food and beverage for purchase"
                    }
                ],
                "flightStatusCode": "HK",
                "flightStatusName": "Confirmed",
                "durationInMinutes": 145,
                "distanceInMiles": 774,
                "travelerIndices": [
                    1
                ],
                "identityDocuments": [
                    {
                        "itemId": "a6dfc58e0b9ba95cb83d41ba92160ad9d559278fb6f7e1c69aba6c90945a435f17c3384ed39373a9d95a87ac8e25c9bc5d3fdfd01d9f411389c33c8334a89ef9",
                        "status": "Confirmed"
                    }
                ]
            }
        ],
        "journeys": [
            {
                "firstAirportCode": "LHR",
                "departureDate": "2023-09-23",
                "departureTime": "07:45",
                "lastAirportCode": "MAD",
                "numberOfFlights": 1
            }
        ],
        "allSegments": [
            {
                "id": "11",
                "type": "FLIGHT",
                "text": "458",
                "vendorCode": "BA",
                "startDate": "2023-09-23",
                "startTime": "07:45:00",
                "startLocationCode": "LHR",
                "endDate": "2023-09-23",
                "endTime": "11:10:00",
                "endLocationCode": "MAD"
            }
        ],
        "specialServices": [
            {
                "travelerIndices": [
                    1
                ],
                "code": "DOCS",
                "name": "API-Passenger Travel Document",
                "message": "/P/US/987765452/GB/23JAN1970/M/09JUL2024/DOE/JOHN",
                "statusCode": "HK",
                "statusName": "Confirmed"
            },
            {
                "code": "OTHS",
                "message": "MISSING SSR CTCM MOBILE OR SSR CTCE EMAIL OR SSR CTCR NON-CONSENT FOR BA"
            }
        ]
    },
    "request": {
        "bookingSignature": "0606d8125e90bfc2ea0fd2daf2876a889cb79434afaa2a42f5a257f5676eae5bbe28f0eaab060d4a4dff4c603baaabca291d8513dd1518808aad3f1ef64d69bf",
        "confirmationId": "OFGBRU",
        "retrieveBooking": true,
        "receivedFrom": "Booking Management API testing",
        "before": {
            "specialServices": [
                {
                    "travelerIndices": [
                        1
                    ],
                    "code": "DOCS",
                    "message": "/P/US/0123456789/POL/23JAN1970/M/09JUL2024/SMITH/JOHN/JACK"
                },
                {
                    "code": "OTHS",
                    "message": "MISSING SSR CTCM MOBILE OR SSR CTCE EMAIL OR SSR CTCR NON-CONSENT FOR BA"
                }
            ],
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "identityDocuments": [
                        {
                            "documentNumber": "0123456789",
                            "documentType": "PASSPORT",
                            "expiryDate": "2024-07-09",
                            "issuingCountryCode": "US",
                            "residenceCountryCode": "POL",
                            "givenName": "JOHN",
                            "middleName": "JACK",
                            "surname": "SMITH",
                            "birthDate": "1970-01-23",
                            "gender": "MALE",
                            "isPrimaryDocumentHolder": false
                        }
                    ]
                }
            ]
        },
        "after": {
            "specialServices": [
                {
                    "travelerIndices": [
                        1
                    ],
                    "code": "DOCS",
                    "message": "/P/US/0123456789/POL/23JAN1970/M/09JUL2024/SMITH/JOHN/JACK"
                },
                {
                    "code": "OTHS",
                    "message": "MISSING SSR CTCM MOBILE OR SSR CTCE EMAIL OR SSR CTCR NON-CONSENT FOR BA"
                }
            ],
            "travelers": [
                {
                    "givenName": "JOHN",
                    "surname": "DOE",
                    "passengerCode": "ADT",
                    "identityDocuments": [
                        {
                            "documentNumber": "987765452",
                            "documentType": "PASSPORT",
                            "expiryDate": "2024-07-09",
                            "issuingCountryCode": "US",
                            "residenceCountryCode": "GB",
                            "givenName": "JOHN",
                            "surname": "DOE",
                            "birthDate": "1970-01-23",
                            "gender": "MALE",
                            "isPrimaryDocumentHolder": false
                        }
                    ]
                }
            ]
        }
    }
}