POST/v1/flights/order/cancel/:gdsprovider/:orderId

Flugauftrag stornieren

Requests cancellation of an existing flight order, optionally using a cancellation id from a pending cancellation flow.

Requests cancellation of an existing flight order, optionally using a cancellation id from a pending cancellation flow.

Endpoint

MethodPathAuth
POST/v1/flights/order/cancel/:gdsprovider/:orderIdRequired API key
Required headers:
HeaderDescription
AuthorizationBearer <secret_key>. The secret is shown only once when the credential is created.
X-Travelandz-Id<public_key>:<profile_code>. The profile_code is the dp_-prefixed Developer Profile code shown in your dashboard. This binds the request to a profile and credential.
Content-TypeUse application/json for requests with a body.

Request Params Schema

PropertyTypeDetailsRequiredNotes
gdsprovidernumberYes-
orderIdstringYes-

Request Body Schema

PropertyTypeDetailsRequiredNotes
cancelIdstringNo-

Success Response

Returns message of cancellation

Response Body Schema

PropertyTypeDetailsRequiredNotes
messagestringYes-

Operational Notes

  • Send cancelId when a pending cancellation was already created. If cancelId is omitted, Travelandz creates and confirms the cancellation in one request when supported by the selected flow.
  • Direct cancellation can fail when the booking is already ticketing or no longer cancellable.

Example

bash
bash
curl -X POST https://api.sandbox.travelandz.com/v1/flights/order/cancel/0/order_123 \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE" \
  -H "Content-Type: application/json" \
  -d '{"cancelId":"ore_123"}'