Skip to main content

Breeze Airways JSON APIs

This collection of documents describes the Breeze Airways JSON APIs.

Our JSON APIs expose the same capabilities as the NDC/XML APIs through conventional REST endpoints.

They are meant to be cross-compatible with the latest IATA NDC schema. Breaking schema changes in the underlying IATA standards will result in a new API version.

Base path & versioning

All endpoints live under /json/{version}:

VersionStatus
v0Development preview. Available.
v1Not yet available

Requests to any other version segment return a 404 with code ERR-1002.

Authentication

Every request needs one of:

  • Authorization: <bearer token from /auth/token> header, or
  • Authorization: Bearer <seller-token> header (takes precedence if both are sent).

The API key controls allowed request volumes, allowed fare and ancillary products, allowed agency IDs, and read-only versus full transaction permissions.

OpenAPI specification

The spec is generated from the running service, so it always matches the deployed API version.

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.