Amend Paxes

The Amend Paxes operation lets you update your booking's paxes. You can change names, surnames, ages, and add or remove paxes. To make a modification to your booking accurately, you should begin by executing the 'quote amend' query to confirm the feasibility of the change and its associated price. After obtaining this information, you can proceed to implement the amendment using the 'commit' mutation, which will finalize the modification in the Seller's system.

Quote Amend Paxes

The quote amend query simulates the amendment to confirm the price of the booking modification. The returned fields include:

• amendFee
• amendedBookingDetail
  • reference
  • holder
  • hotel
  • price
  • quotePrice
  • cancelPolicy
  • remarks
  • status

Inputs

When creating your quote amend query, you have two different inputs to fill based on your specific needs:

1. Criteria
2. Settings

Remember

It's important to note that even if certain fields in the "criteria" or "settings" inputs are labeled as optional, we still need to use some value internally. This value will either come from your query/mutation request or your default settings. You have the ability to manage your default API settings by visiting the API Settings section on our website.

1. Criteria

You can perform the query (simulation) of the amendment sending all the booking information (reference, dates, hotelCode) or sending the bookingID got in the booking flow:

• Booking information:

  • accessCode
  • language
  • hotelCode
  • reference
  • dates

• BookingID got in the booking flow:

  • bookingID

You can decide between the two options either by booking information or directly by bookingID, empowering you with the choice that suits you best.

Additionally you'll need to indicate the new paxes information you want for your reservation with the rooms input. For example:

{
    "criteria" : {
        "bookingID" : "n1@1[241128[241129[240516[1[es[EUR[2[test_09052024_test[3128791[",
        "rooms" : [
            {
                "occupancyRefId" : 1,
                "paxes" : [
                    {
                        "name" : "Juan",
                        "surname" : "Smith",
                        "age" : 30
                    },
                    {
                        "name" : "Tom",
                        "surname" : "Jones",
                        "age" : 30
                    }
                ]
            }
        ]
    }
}

2. Settings

Settings are the common configurations used to construct requests to the supplier/s. By default, we apply the same configuration to all Hotel-X clients.

Mandatory Settings:

• client
• context
• timeout (Timeout in milliseconds for the supplier connection. Won't close client connection if exceeded.)

Optional Settings:

• group
• auditTransactions
• suppliers (Each one contains its own code, settings and accesses)
• plugins
• testMode (This flag allows only the accesses checked as test)
• clientTokens (Used to identify the origin of the request, this is only used in plugins)
• businessRules
• operationTimeout (Timeout in milliseconds for Hotel-X connection. Will close Buyer connection if exceeded. Must be higher than timeout.)

Requests Examples

Paxes amendment quote with the bookingID from the book response

Commit Amend Paxes

The commit amend mutation generates the amendment to confirm the booking modification. The returned fields include:

• amendFee
• amendedBookingDetail
  • reference
  • holder
  • hotel
  • price
  • quotePrice
  • cancelPolicy
  • remarks
  • status

Inputs

When creating your quote amend query, you have two different inputs to fill based on your specific needs:

1. Data
2. Settings

1. Data

You must perform the mutation (commit) of the amendment sending the amendmentID received in the quote amend response:

• amendmentID

2. Settings

Settings are the common configurations used to construct requests to the supplier/s. By default, we apply the same configuration to all Hotel-X clients.

Mandatory Settings

• context
• timeout (Timeout in milliseconds for the supplier connection. Won't close client connection if exceeded.)
• businessRules
• language
• currency
• nationality
• markets

Optional Settings

• group
• auditTransactions
• suppliers (Each one contains its own code, settings and accesses)
• plugins
• testMode (This flag allows only the accesses checked as test)
• clientTokens (Used to identify the origin of the request, this is only used in plugins)
• businessRules
• operationTimeout (Timeout in milliseconds for Hotel-X connection. Will close Buyer connection if exceeded. Must be higher than timeout.)

Requests Examples