Order Notification Webhooks
Breeze can POST order-change notifications to seller webhook URLs. Each notification carries the change metadata and a full order snapshot, so sellers do not need to call back before updating their local order state.
Webhook registrations support two payload formats:
| Format | Payload |
|---|---|
json | JSON body with change metadata and an order snapshot matching GET /json/{version}/orders/{id} response data. |
ndc-xml | IATA_OrderChangeNotifRQ with the order snapshot in Notification > CurrentOrder. |
For ndc-xml, registration must include ndcVersion: v21.3, v24.1, v25.4, or v26.2.
Delivery
Breeze sends each notification as an HTTPS POST to the registered URL:
Authorization: <registered secret>
Content-Type: application/xml
X-Breeze-Delivery-Id: <delivery-id>
For json webhooks, Content-Type is application/json. The Authorization header is the seller-provided secret exactly as registered. There is no HMAC signature or timestamp header.
Any 2xx response acknowledges delivery. Breeze retries 5xx responses, 429, and transport failures up to three attempts with short backoff. Other 4xx responses are terminal. X-Breeze-Delivery-Id is stable across retries and should be used for dedupe.
XML Payload
IATA_OrderChangeNotifRQ includes:
| Field | Description |
|---|---|
DistributionChain | Sender chain. Defaults to Breeze as carrier. |
Notification > ChangeGroup > ChangeOperationGroup > ChangeOperation > ChangeTypeCode | IATA change type. Breeze currently sends Flight, Name, or Service. |
Notification > ChangeGroup > ChangeOperationGroup > ChangeOperation > ReasonCode | Open reason code from the booking-change source, such as schedule or name-change codes. |
Notification > ChangeGroup > ChangeOperationGroup > ChangeOperation > ChangeDateTime | Time the upstream change happened. |
Notification > ChangeGroup > ChangeOperationGroup > OrderVersionNumber | Opaque, increasing order version derived from the upstream modification timestamp. |
Notification > CurrentOrder | Full current order snapshot. |
PayloadAttributes > VersionNumber | NDC version selected at registration. |
In v24.1 and later, Notification > OrderRefID is also present. In v21.3, the order reference is available inside CurrentOrder.