Skip to main content

Cancel

Overview​

The Cancel operation allows clients to terminate a previously confirmed booking. It uses the client and supplier locators to identify the reservation and process the cancellation. Depending on the supplier's policies, penalties or fees may apply.

The Cancel operation ensures:

  • Reservation Termination: Enables clients to cancel bookings through the supplier's API.
  • Penalty Calculation: Returns any applicable cancellation fees based on the supplier's policies provided during Quote.
  • Status Confirmation: Confirms the success or failure of the cancellation request.

When to Use:

  • Client-Initiated Cancellations: When the end-user requests to cancel their reservation.
  • Penalty Validation: To verify if a cancellation incurs fees before finalizing the process.

Note: Always check the cancellation policies returned during Quote to inform the client about any penalties.

Common Scenarios:

  • Penalty-Based Cancellations: Applies when the supplier charges fees for cancellations based on policies.
  • Error Handling: Common errors include:
    • SupplierError: Indicates the cancellation could not be processed by the supplier.

Request​

Overview​

The request operation includes client and supplier locators and any additional data required by the supplier.

Sample​

var cancelRq = new CancelRq
{
    Input = new CancelInput
    {
        Language = "99",
        AccommodationRq = new Accommodation
        {
            Type = "Hotel",
            Code = "12345"
        },
        Reference = new BookingReference
        {
            ClientLocator = "ClientReference12345",
            SupplierLocator = "SupplierLocator389b10ca-893b-4e7b-adf6-b067a1b1d9b3",
            HotelLocator = "HotelLocator208c2b6f-1cdf-4204-9ebe-f147808218d9"
        }
    },
    Settings = new Settings
    {
        Supplier = "HOTELTEST",
        Platform = "HOTELTEST",
        Client = "TravelAgency123",
        Access = new Access
        {
            Code = 1001,
            User = "agency_user",
            Password = "secure_password",
            ApiKey = "API_KEY_123456789",
            Urls = new Urls
            {
                Book = "https://api.hotelsupplier.com/book",
                Search = "https://api.hotelsupplier.com/search",
                Quote = "https://api.hotelsupplier.com/quote",
                Generic = "https://api.hotelsupplier.com/generic"
            },
            Parameters = new Dictionary<string, string>
            {
                { "someParameter1", "50" },
                { "someParameter2", "true" },
                { "someParameter3", "5000" },
                { "someParameter4", "SupplierX" }
            }
        },
        BusinessRules = new BusinessRules
        {
            OptionsQuota = 170,
            BusinessRuleType = "CheaperAmount"
        },
        Timeout = "00:00:10",
        TimeoutAsTimeSpan = TimeSpan.Parse("00:00:10"),
        IncludeProviderTransactions = true
    }
};

Details​

NameRelationTypeDescription
Input1CancelInputGets or initializes the input details for the cancellation request, including specific information about the booking to be canceled. Such as the access, booking reference, and accommodation code.
Input/AccessCode0 . . 1StringAccess code associated with the cancellation request. This property is deprecated and should not be used in new implementations.
Input/Language1StringGets or sets the language code for the cancellation request.
Input/AccommodationRq1AccommodationRQDetails of the accommodation associated with the cancellation request, such as the accommodation type and code.
Input/AccommodationRq/Type1AccommodationTypeSpecifies the type of accommodation being requested, such as Hotel or Rental.
Input/AccommodationRq/Code1StringRepresents a unique code identifying the accommodation in the request.
Input/Reference1ReferenceReference information containing client, supplier, or hotel locators for the booking associated with the cancellation request. Validation of these locators is performed based on the metadata restriction information.
Input/Reference/ClientLocator0 . . 1StringThe booking locator provided by the client.This is typically used to match the booking in the client's internal systems.
Input/Reference/
SupplierLocator		0 . . 1StringThe booking locator provided by the supplier.This identifier is used to reference the booking in the supplier's system.
Input/Reference/HotelLocator0 . . 1StringThe booking locator specific to the hotel, provided by the supplier. (Optional)This may be required in cases where the hotel system uses its own unique identifiers.
Settings1SettingsGets or initializes the platform-specific settings required for processing the cancellation request. These settings include credentials, API endpoints, parameters, and details about the client, supplier, and platform involved in the request.
Settings/Supplier1StringIdentifies the supplier associated with the hotel operation. This is a unique code generated by Travelgate within its system to represent the supplier.
Settings/Platform1StringRepresents the platform on which the hotel operation is performed.Platforms are collections of suppliers, and the platform code is generated by Travelgate to define the operational context.
Settings/Client1StringRepresents the client performing the hotel operation.This is a unique client code assigned by Travelgate to identify the client within its system.
Settings/Access1AccessContains access information required for the operation, including API credentials, endpoints, and other connection details specific to the supplier's integration.
Settings/Access/Code1IntegerThe unique code identifying the access configuration.
Settings/Access/User0 . . 1StringThe username used for authentication with the supplier.
Settings/Access/Password0 . . 1StringThe password used for authentication with the supplier.
Settings/Access/ApiKey0 . . 1StringThe API key used for authentication or authorization.
Settings/Access/Urls1UrlsThe URLs associated with the access configuration.
Settings/Access/Urls/Book0 . . 1StringThe URL used for booking operations.
Settings/Access/Urls/Search0 . . 1StringThe URL used for Search operations.
Settings/Access/Urls/Quote0 . . 1StringThe URL used for Quote operations.
Settings/Access/Urls/Generic0 . . 1StringA generic URL for additional operations.
Settings/Access/Parameters0 . . 1AccessParametersAdditional parameters related to the connection.
Settings/BusinessRules0 . . 1BusinessRulesSpecifies the business rules to be applied during the operation. These rules define operational constraints and behavior, such as quota limits or prioritization criteria.
Settings/BusinessRules/
OptionsQuota		0 . . 1IntegerThe maximum number of options returned for each board in the Search query.
Settings/BusinessRules/
BusinessRuleType		1BusinessRulesTypeThe business rule type that determines how Search results are prioritized or filtered.
Settings/Timeout1StringDefines the timeout period for the operation as a string value.This indicates the maximum amount of time to wait for a supplier's response before timing out.The value must be provided in timestamp format (e.g., "00:00:10" for 10 seconds).
Settings/TimeoutAsTimeSpan0 . . 1StringConverts the timeout value from the string representation (Timeout) into a TimeSpan for use in time-based operations.
Settings/
IncludeProviderTransactions		1BooleanIndicates whether detailed traces of provider transactions should be included in the operation's response.If enabled, the ProviderAudit field in responses will contain the transaction logs (e.g., requests and responses exchanged with the supplier).

Response​

Provides the cancellation status, penalties (if any), and any warnings or remarks.

Overview​

The Cancel operation provides:

  • Cancellation Status:
    • Confirmed: The reservation status is OK, is not cancelled.
    • Canceled: Indicates the reservation has been successfully canceled.
    • On_Request: The reservation was completed but the product is still not available by the Seller, so the reservation goes into a waiting list. It is the Buyer’s responsibility to check if the booking is OK.
    • Unknown: During the cancelation process, an issue led to an unknown reservation status. The Buyer is responsible for confirming with the Seller that the booking has been canceled.
  • Cancellation Fees: If applicable, the supplier may return a penalty fee for the cancellation.
  • Warnings or Remarks: Additional details from the supplier about the cancellation process.

Sample​

var cancelRs = new CancelRs
{
    AuditData = new AuditData
    {
        Request = new List<RequestItem>
        {
            new RequestItem
            {
                Data = "<x>SupplierRequest</x>",
                Headers = new Dictionary<string, string>
                {
                    { "Accept", "application/x-protobuf" },
                    { "Accept-Encoding", "gzip,deflate," }
                },
                HttpMethod = new HttpMethodType
                {
                    Method = "POST"
                },
                SendAt = DateTime.Parse("2025-03-16T08:21:49Z"),
                Url = "http://travelgate.com"
            }
        },
        Response = new List<ResponseItem>
        {
            new ResponseItem
            {
                Data = "<x>SupplierResponse</x>",
                Headers = new Dictionary<string, string>
                {
                    { "Content-Encoding", "gzip," }
                },
                HttpMethod = new HttpMethodType
                {
                    Method = "POST"
                },
                ReceivedAt = DateTime.Parse("2025-03-16T08:21:49Z"),
                StatusCode = 200
            }
        }
    },
    AdviseMessages = new List<AdviseMessage>
    {
        new AdviseMessage
        {
            Code = "SupplierError",
            Level = "Error",
            Description = "Supplier error, check external for more details",
            External = new ExternalError
            {
                Code = "Code123",
                Message = "Supplier internal error",
                HttpStatusCode = 200
            }
        }
    },
    Reference = new BookingReference
    {
        ClientLocator = "ClientReference12345",
        SupplierLocator = "SupplierLocator389b10ca-893b-4e7b-adf6-b067a1b1d9b3",
        HotelLocator = "HotelLocator208c2b6f-1cdf-4204-9ebe-f147808218d9"
    },
    CancelLocator = "CancelLocator85bf83d1-2a63-4771-98d4-c61bb0d1097a",
    Status = "Cancelled",
    BookPrice = new Price
    {
        Currency = "EUR",
        Binding = true,
        Net = 100,
        Gross = 100,
        NetSpecified = true,
        MinimumSellingPrice = 100
    },
    CancelPrice = new Price
    {
        Currency = "EUR",
        Binding = true,
        Net = 100,
        Gross = 100,
        NetSpecified = true,
        MinimumSellingPrice = 100
    }
};

Details​

NameRelationTypeDescription
AuditData1ProviderAuditGets or sets the audit data provided by the supplier or system for the operation.
AuditData/Request0 . . NArray<ProviderAuditRq>Collection of audit entries for provider requests.Each entry contains details about a specific request made to the provider.
AuditData/Request/SendAt1StringThe timestamp indicating when the request was sent. Date on UTC Standard (ISO 8601 UTC 2025-05-21T08:48:53.9744052+00:00)
AuditData/Request/Data1StringThe payload data included in the request.
AuditData/Request/Url1StringThe URL of the provider endpoint to which the request is sent.
AuditData/Request/Headers1ObjectA collection of headers included in the request.
AuditData/Request/HttpMethod1HttpMethodThe HTTP method used to send the request.
AuditData/Request/HttpMethod/
Method		1StringNo description available.
AuditData/Response0 . . NArray<ProviderAuditRs>Collection of audit entries for provider responses.Each entry contains details about a specific response received from the provider.
AuditData/Response/ReceivedAt1StringThe timestamp indicating when the response was received. Date on UTC Standard (ISO 8601 UTC 2025-05-21T08:48:53.9744052+00:00)
AuditData/Response/Data1StringThe payload data contained in the provider's response.
AuditData/Response/Headers1ObjectA collection of headers included in the provider's response.
AuditData/Response/StatusCode1IntegerThe HTTP status code returned by the provider.
AdviseMessages0 . . NArray<AdviseMessage>Gets the collection of advise messages related to the cancellation operation.
AdviseMessages/Code1AdviseMessageCodeGets the code that represents the message type.
AdviseMessages/Level1AdviseMessageLevelGets the severity level of the message (e.g., Error, Warning, or Info).
AdviseMessages/Description1StringGets the message description providing additional context.
AdviseMessages/CorrelationId0 . . 1StringGets a unique identifier for correlating the message with specific operations.
AdviseMessages/External0 . . 1ExternalGets additional external details associated with the message.
AdviseMessages/External/Code1StringThe supplier's internal code for identifying the nature of the response or error.
AdviseMessages/External/
Message		1StringA descriptive message returned by the supplier.
AdviseMessages/External/
HttpStatusCode		1IntegerThe HTTP status code of the supplier's response.
Reference0 . . 1ReferenceGets the reference information associated with the booking.
Reference/ClientLocator0 . . 1StringThe booking locator provided by the client.This is typically used to match the booking in the client's internal systems.
Reference/SupplierLocator0 . . 1StringThe booking locator provided by the supplier.This identifier is used to reference the booking in the supplier's system.
Reference/HotelLocator0 . . 1StringThe booking locator specific to the hotel, provided by the supplier. (Optional)This may be required in cases where the hotel system uses its own unique identifiers.
CancelLocator0 . . 1StringGets or sets the cancel locator value specific to the cancellation operation.
Status1BookStatusGets the status of the booking after the cancellation operation. Possible values: Unknown, Ko, Ok, OnRequest, Cancelled or PendingCommit.
BookPrice0 . . 1PriceGets or sets the original booking price before cancellation.
BookPrice/Currency1CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
BookPrice/Binding1BooleanIndicates whether the price is binding.
BookPrice/Net1DoubleThe net price paid by the Buyer to the Seller.
BookPrice/Gross1DoubleThe gross price, which includes the net price and the Buyer's commission.
BookPrice/NetSpecified1BooleanIndicates whether the net price is explicitly specified.
BookPrice/MinimumSellingPrice1DoubleThe minimum selling price.
CancelPrice0 . . 1PriceGets or sets the price associated with the cancellation operation.
CancelPrice/Currency1CurrencyThe currency of the price, represented in ISO 4217 format (e.g., USD, EUR).
CancelPrice/Binding1BooleanIndicates whether the price is binding.
CancelPrice/Net1DoubleThe net price paid by the Buyer to the Seller.
CancelPrice/Gross1DoubleThe gross price, which includes the net price and the Buyer's commission.
CancelPrice/NetSpecified1BooleanIndicates whether the net price is explicitly specified.
CancelPrice/
MinimumSellingPrice		1DoubleThe minimum selling price.
AddOns0 . . 1ObjectGets or sets additional supplier information as key-value pairs.