Breeze API sample flows

End-to-end walkthroughs illustrating common transaction flows with our API.

• Make a test booking: token, AirShopping, OfferPrice, OrderCreate, OrderRetrieve
• Hold and pay: OrderCreate without payment, then OrderChange with PaymentFunctions
• Add seats after initial booking: SeatAvailability, then OrderChange with payment
• Add bags & extras after initial booking: ServiceList, then OrderChange with payment
• Update passenger contact info: passenger and contact updates via OrderChange
• Cancel an order: OrderReshop cancel quote, then OrderChange

These walkthroughs build upon each other. The initial booking will get subsequently modified with a seat and a bag and is cancelled.

JSON flows available

Similar walkthroughs are available for our JSON API here.

Run locally in Bruno

Download our Bruno API client collection to run Breeze Offer Order sample flows locally.

Download BOO sample flows
Latest: 2026-08-18 | sha256.e178e0f46ef106f2e9d34c19f9e922d6a067c84131db54351505a168dbd36379

2026-08-18

OrderCreate hold request updated so the booking primary ContactInfo is unreferenced (no ContactInfoRefID on Pax), matching contacts.

Import into Bruno

1. Download and unzip the collection.
2. In Bruno, import the BOO sample flows folder as an OpenCollection.
3. Copy .env.example to .env, then add the x-api-key values provided by Breeze.
4. Select TEST [BOO] for sandbox testing, or PROD [BOO] when you are ready to go live.
5. Run Get Access Token first. It stores booAccessToken, which the other requests use as their bearer token.

Tokens expire after about 30 minutes. Re-run Get Access Token when a request returns 401.

Flow order

The collection is organized around runnable v24.1 NDC/XML scenarios:

1. 00 Reference data: get valid markets and schedule dates.
2. 01 Shop and price: run AirShopping, then price the selected offer.
3. 02 Services and seats: request available services and seats for the selected offer.
4. 03 Create order: create a hold booking (OrderCreate without payment).
5. 04 Retrieve and pay held order: retrieve the hold and confirm payment.
6. 05 Manage existing order: retrieve, update passenger details, or cancel an unpaid order.
7. 99 Diagnostics: run intentionally invalid requests to confirm error handling.

The requests use Bruno variables for IDs, markets, dates, and selected offers. Several requests save response values automatically, so run each scenario in order unless the request notes otherwise.