Skip to main content

API docs

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

Handle an airline disruption (JSON)

When Breeze cancels, reschedules or delays a flight, the order carries a disruption that says what the traveler may do about it. Breeze uses the IATA seller follow-up actions:

ActionWhat it meansHow to do it
AcceptKeep the flight as it now standsChange order with an AcceptChange change
ReshopMove to another flight at no extra costReshop, quote, accept as for any flight change
CancelCancel with no cancellation feeCancel the order with a refundMethod

The disruption's actions list says which of these apply. 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​

Order retrieve returns it, as does every change or cancel response:

GET /json/v2/orders/MX7GTUUEBX30
Response — 200 OK (excerpt)
{
"data": {
"order": {
"orderId": "MX7GTUUEBX30",
"recordLocator": "D2MFSV",
"statusCode": "CONFIRMED"
},
"disruption": {
"reason": "Delayed",
"orderItemIds": [
"OOI-FL-UHxQQVgtUVVSVUxURXxTfFBWVVNOQXwyMDI2MTExMHxNWDE2NDQ"
],
"actions": ["Accept", "Reshop", "Cancel"],
"refundMethods": ["Credit"],
"consequenceOfInaction": "AutoAcceptance",
"flights": [
{
"origin": "PVU",
"destination": "SNA",
"flightNumber": "1644",
"departure": "2026-11-10T19:31:00",
"estimatedDeparture": "2026-11-10T23:00:00"
}
]
}
},
"error": null
}
FieldDescription
reasonFlightCancelled, ScheduleChangeCancelled, ScheduleChanged or Delayed.
orderItemIdsThe flight order items the disruption is on.
actionsWhich of Accept, Reshop, Cancel the traveler may choose.
refundMethodsHow a Cancel can pay out: OriginalPayment (back to the card) and/or Credit.
consequenceOfInactionAutoCancellation: a cancelled flight is refunded automatically if nobody acts. AutoAcceptance: the change stands.
flightsThe disrupted flight(s) as originally scheduled. Times are local to the departure airport; a delay adds estimatedDeparture.

disruption disappears once the traveler's choice has been made.

Accept the change​

PATCH /json/v2/orders/MX7GTUUEBX30
Request
{
"changes": [
{
"type": "AcceptChange",
"orderItemIds": [
"OOI-FL-UHxQQVgtUVVSVUxURXxTfFBWVVNOQXwyMDI2MTExMHxNWDE2NDQ"
]
}
]
}

The response is the order, without disruption. Nothing on the booking changes. Send AcceptChange on its own, and only when actions includes Accept.

Rebook on another flight​

Use the normal change flow: reshop the disrupted order item, quote the flight you want, then accept it. 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 quote shows it:

Quote — 200 OK (excerpt)
{
"oldTotal": { "amount": 99, "currency": "USD" },
"newTotal": { "amount": 99, "currency": "USD" },
"balanceDelta": { "amount": 0, "currency": "USD" },
"differentialTypeCode": "EvenExchange"
}

That holds even when shopping prices the new flight higher ($119 for this one). Any other choice (a different bundle, or more than 14 days away) is priced as a normal paid change.

Cancel with a refund or credit​

POST /json/v2/orders/MX7GTUUEBX30/cancel?ownerCode=MX
Request
{ "refundMethod": "Credit" }
  • There is no cancellation fee when the cancel includes a disrupted flight. Cancelling only another journey on the order is a normal cancel.
  • refundMethod must be one of the disruption's refundMethods. Without it, the refund goes to the original payment when that is offered. Otherwise it is issued as credit.
  • Asking for a method that is not offered is rejected:
Response — 400
{
"data": null,
"error": {
"code": "ERR-1004",
"title": "Invalid field value",
"description": "One or more request fields contain an invalid value. refundMethod OriginalPayment is not offered for this disruption; use one of the order's disruption refundMethods.",
"path": "refundMethod"
}
}

The same refundMethod field works on the reshop cancellation quote and on a change order that cancels journeys.

The reshop cancellation quote says where the money will go, so you can tell the traveler before committing:

Reshop response (excerpt)
"cancellation": {
"offerId": "OF-…",
"penaltyAmount": { "amount": 0, "currency": "USD" },
"refundAmount": { "amount": 151.92, "currency": "USD" },
"refunds": [{ "to": "OrganizationCredit", "amount": { "amount": 151.92, "currency": "USD" } }],
"isRefundable": true
}
toWhere the money goes
OriginalPaymentBack to the card it was paid with
LoyaltyBack to the Breeze Points account it was paid from
CustomerCreditFlight credit on the booker's Breeze account
OrganizationCreditCredit on your agency account
BookingCreditFlight credit held on the booking, used with its confirmation code

A quote for a cheaper change carries the same refunds on its priceDifferential.

A refund can split across several destinations. Choosing Credit can still send some money back to the card; for example, a cancellation inside the 24-hour DOT window always refunds to the card.

The NDC/XML API carries the same information as SellerFollowUpAction on the order item.