NDC Order Cancel API Reference

POST

receipt/reservations/{workbenchID}/receipts?OfferIdentifier={OfferID}

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

For {OfferID} send the offerClosed In the JSON Search APIs, an offer is a product available at a specific price under a set of terms and conditions. An offer includes the flight or connecting flights for one leg of the itinerary, plus a service level that includes the cabin class and any fare codes that may apply. At booking, the selected offer from the Search response - including the flight/s, service level, price, terms and conditions, and brand if applicable - is converted into a single Offer object that is subsequently returned for that booking. identifier from Offer/Identifier/value in the Create Workbench response.

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Related Content: Exchange, Refund, and Void Guide

Use the Order Cancel API to voidClosed Voiding a ticket cancels the ticket and payment and is based on rules for the market in which the ticket was issued. Generally a ticket can be voided only the same day it was issued, usually up to midnight local agency time. See the Exchange, Refund, and Void Guide. or cancelClosed Cancel a ticket outside the void period without rebooking on another itinerary. Depending on the airline ticket policy, canceling a ticket may result in a full, partial, or no refund. NDC tickets or reservations (held bookings not yet ticketed).

Create a workbench session before sending Order Cancel. You may need to send Refund Quote before the Order Cancel request. See the Exchange, Refund, and Void Guide for workflows.

Refund Quote is mandatory when canceling a ticket outside the void period and there is any difference between a refund due and the purchase price. If Refund Quote is not sent, and a refund is not available for the exact amount of the purchase price, Order Cancel returns the error message OFFER CANNOT BE CANCELED WHEN REFUND AMOUNT DOES NOT EQUAL OFFER PRICE. PERFORM A REFUND QUOTE AND TRY AGAIN.
For differences in how the JSON APIs support GDS and NDC content, see the support tables for seats, ancillaries, fare rules, and exchanges. Also see the NDC and GDS Functionality Comparison.
For carrierClosed An airline.-specific NDC differences, see NDC capabilities by airline through JSON API in the Travelport Knowledge Base. If you need login assistance, see Knowledge Base NDC Resources.

Request

Header Parameters

In addition to the Common Air Headers, for Order Cancel the RetainFlag header parameter determines the type of operation.

Parameter

Description

Required/Optional

RetainFlag

Determines the type of cancel operation. Supported values:

false: Voids or cancels ticket, or cancels reservation. Issues a refund if within the void period for the ticket, or if outside the void period and a refund is due.

true: For supporting NDC carriers only, either within or after the void period, send with true to cancel the ticket and the segments but retain the ticket value instead of issuing a refund. You may be able to apply the value of the ticket to another bookingClosed A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable. using the Ticket as FOP API.

For carrier support, see Retain Tickets in NDC capabilities by airline through JSON API in the Travelport Knowledge Base.

Required

Query Parameters

Also see note above on the RetainFlag header parameter.

Parameter

Description

Required/Optional

OfferIdentifier

Send the offer identifier for the offer to cancel or void. Returned in the Create Workbench response in Offer/Identifier/value.

Required

Request Body

No message payload.

In the HTTP header parameters, set the RetainFlag parameter per above to indicate the cancel operation.

Response

The content of the response depends on the offer canceled:

  • When RetainFlag is set to false in the request:
    • For a reservation, the booking is canceled. The response does not return a ticket number because no ticket was issued.
    • For a ticket, if the ticket is inside the void period determined by the airline, the ticket is voided and any available refund credited to the original form of payment.
    • For a ticket, if the ticket is outside the void period or not eligible for a full refund, the ticket is canceled and no refund or a partial refund is issued.
  • When RetainFlag is set to true in the request, the ticket and segments are canceled but the ticket value is retained and can be applied to a subsequent booking. Supported NDC carriers only.

Example Request

No message body. Example POST request:

https://api.pp.travelport.com/11/air/receipt/reservations/reservations/1ace440f-66e9-4898-9802-3fc35b24bfd1/receipts?OfferIdentifier=QUEwMDEzRjZCOTJDNHxQb1BDQzQxOTIxMS1CQ0I3LT
Q5NEYtOUFBMy0xLTF8UG9QQ0M0MTkyMTEtQkNCNy00OTRGLTlBQTMtMS0y

Example Response

In all cancel scenarios, a successful cancellation returns at least one instance of ReceiptID@type ReceiptCancellation/Cancellation@type CancellationHold:

    "Cancellation": {
     "@type": "CancellationHold",
     "Locator": {
      "source": "SQ",
      "sourceContext": "VendorLocator",
      "value": "5EI5CB"
     }

For tickets, cancel and void requests also return an instance of ReceiptID@type ReceiptPayment in which Document@type indicates the void or refund; see the table above for possible values.

In the following example, the ticket was voided with the void period (ReceiptID@type ReceiptPayment/Document@type=DocumentTicketVoid and VoidInd=true) and the full ticket value was refunded. The response for a canceled and refunded ticket is similar.

The response for a canceled reservation is also similar but does not return an instance of ReceiptID with @type ReceiptPayment because no payment was made.