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

Cancel flight order

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-