Breeze Airways JSON APIs
This collection of documents describes the Breeze Airways JSON APIs.
Our JSON APIs expose similar offer-order capabilities as our NDC/XML APIs. Some JSON endpoints have extended functionality beyond what is allowed by IATA’s definitions.
Breaking changes are only introduced with major versions.
Base path & versioning
Section titled “Base path & versioning”All endpoints live under /json/{version}:
| Version | Status |
|---|---|
v0 | Development preview. Unsupported for production use. |
v2 | (preview) First long-term supported release. |
The JSON API route only carries the major version. Requests to non-live versions return a HTTP 404 error.
Visit our dedicated page to learn about our release schedule.
Authentication
Section titled “Authentication”Every request requires authentication.
Most actions should be made using a bearer token (JWT) issued by the shared /auth/token endpoint. See Authentication for the token exchange, partner API keys, and acting as multiple sellers.
Authorization at the /auth/token endpoint requires an x-api-key header.
Submitting an x-api-key header to other endpoints alongside a bearer token is not recommended.
The API key controls permissions like:
- allowed request volumes
- allowed fare and ancillary products
- allowed agency IDs for transactions
- read-only or full transaction permissions
Each bearer token acts as exactly one seller. A partner API key can act as any of the partner’s sellers: pass sellerId to /auth/token, and list the available sellers with GET /auth/sellers.
OpenAPI (Swagger) specification
Section titled “OpenAPI (Swagger) specification”- Interactive reference: https://api.flybreeze.com/zephyr/breeze-offer-order/docs/swagger
- Raw spec (JSON): https://api.flybreeze.com/zephyr/breeze-offer-order/docs/swagger/json
Our OpenAPI documents are generated from our live service. They get updated every time our deployment pipeline runs.
Response envelope
Section titled “Response envelope”Every response uses the same envelope:
{ "data": { "...": "endpoint payload, null on error" }, "error": null}On failure, data is null and error contains code, title, description, and optionally fields.
API health monitoring
Section titled “API health monitoring”For service monitoring, use the shared health endpoint. Our JSON and NDC/XML APIs rely on the same service.