Skip to main content

API docs

Build on Breeze with our JSON and NDC/XML APIs.

Handle an airline disruption (NDC/XML)

When Breeze cancels, reschedules or delays a flight, the affected flight OrderItem carries an IATA SellerFollowUpAction saying what the traveler may do about it:

ActionCodeWhat it meansHow to do it
AcceptKeep the flight as it now standsOrderChange with AcceptChange
ReshopMove to another flight at no extra costOrderReshop → OrderQuote → OrderChange, as for any change
CancelCancel with no cancellation feeOrderReshop CancelOrderRef → OrderChange AcceptCancelledOffer

A cancelled flight offers Reshop and Cancel. A schedule change or delay also offers Accept. Bookings made through a travel agency's GDS can only Accept.

Spot the disruption​

OrderViewRS (from OrderRetrieve, and the OrderChange response):

IATA_OrderViewRS (excerpt)
<OrderItem>
<OrderItemID>OOI-FL-UHxQQVgtUVVSVUxURXxTfFBWVVNOQXwyMDI2MTExMHxNWDE2NDQ</OrderItemID>
<OwnerCode>MX</OwnerCode>
<Price>…</Price>
<SellerFollowUpAction>
<ActionCode>Accept</ActionCode>
<ActionCode>Reshop</ActionCode>
<ActionCode>Cancel</ActionCode>
<ActionInd>true</ActionInd>
<ConsequenceOfInactionCode>Auto-acceptance</ConsequenceOfInactionCode>
</SellerFollowUpAction>
<Service>…</Service>
<StatusCode>ACTIVE</StatusCode>
</OrderItem>
  • One ActionCode per action the traveler may choose.
  • ActionInd true means an action is still pending.
  • ConsequenceOfInactionCode:
    • Auto-cancellation: a cancelled flight is refunded automatically if nobody acts.
    • Auto-acceptance: the change stands.

The element is removed once the traveler's choice has been made.

Accept the change​

POST /ndc/v26.2/OrderChange
IATA_OrderChangeRQ
<IATA_OrderChangeRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
<DistributionChain>…</DistributionChain>
<Request>
<ChangeOrderChoice xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
<AcceptChange>
<OrderItemRefID>OOI-FL-UHxQQVgtUVVSVUxURXxTfFBWVVNOQXwyMDI2MTExMHxNWDE2NDQ</OrderItemRefID>
</AcceptChange>
</ChangeOrderChoice>
<Order xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
<OrderID>MX7GTUUEBX30</OrderID>
<OwnerCode>MX</OwnerCode>
</Order>
</Request>
</IATA_OrderChangeRQ>

The response is the OrderViewRS without the SellerFollowUpAction. Nothing on the booking changes. Send AcceptChange on its own, for the order items carrying ActionCode Accept.

Rebook on another flight​

Use the normal change flow (OrderReshop, OrderQuote, OrderChange AcceptRepricedOrder). A flight on the same route, in the same fare and bundle, departing within 14 days of the original, keeps the price already paid. The OrderQuote shows DifferentialTypeCode EvenExchange, even when shopping prices the new flight higher. Any other choice is priced as a normal paid change.

Cancel with a refund or credit​

There is no cancellation fee when the cancel includes a disrupted flight; cancelling only another journey is a normal cancel. Choose the payout with PaymentFunctions/RefundMethodCriteria, on the OrderReshop cancellation quote and on the OrderChange that accepts it:

IATA_OrderReshopRQ
<IATA_OrderReshopRQ xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersMessage">
<DistributionChain>…</DistributionChain>
<Request>
<OrderRefID xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">MX7GTUUEBX30</OrderRefID>
<PaymentFunctions xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
<RefundMethodCriteria>
<OriginalPaymentMethodInd>false</OriginalPaymentMethodInd>
<PaymentTypeCode>VO</PaymentTypeCode>
</RefundMethodCriteria>
</PaymentFunctions>
<UpdateOrder xmlns="http://www.iata.org/IATA/2015/EASD/00/IATA_OffersAndOrdersCommonTypes">
<CancelOrderRef>
<OrderRefID>MX7GTUUEBX30</OrderRefID>
</CancelOrderRef>
</UpdateOrder>
</Request>
</IATA_OrderReshopRQ>
  • OriginalPaymentMethodInd true refunds the original payment. Any other RefundMethodCriteria issues credit.
  • Without RefundMethodCriteria, the refund goes to the original payment when that is offered. Otherwise it is issued as credit.
  • A method the disruption does not offer is rejected with ERR-1004.

The JSON API carries the same information as an order disruption, with refundMethods listing what a cancel can pay out.