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

Créer une annulation de vol en attente

Starts a pending cancellation flow so the integration can review refund data, penalties or provider confirmation before final cancellation.

Starts a pending cancellation flow so the integration can review refund data, penalties or provider confirmation before final cancellation.

Endpoint

MethodPathAuth
POST/v1/flights/order/pending/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
gdsprovidernumberYesOnly gdsprovider "0" supports this flow
orderIdstringYes-

Success Response

Returns the pending cancellation id and provider state.

Response Body Schema

PropertyTypeDetailsRequiredNotes
dataobjectYes-
datarefund_to
stringYes-
datarefund_currency
stringYes-
datarefund_amount
stringYes-
dataorder_id
stringYes-
datalive_mode
booleanYes-
dataid
stringYes-
dataexpires_at
string
Format: ISO 8601
Yes-
datacreated_at
string
Format: ISO 8601
Yes-
dataconfirmed_at
string
Format: ISO 8601
Yes-
dataairline_credits
arrayYes-
dataairline_credits[]passenger_id
stringYes-
dataairline_credits[]issued_on
string
Format: ISO 8601
Yes-
dataairline_credits[]id
stringYes-
dataairline_credits[]credit_name
stringYes-
dataairline_credits[]credit_currency
stringYes-
dataairline_credits[]credit_code
stringYes-
dataairline_credits[]credit_amount
stringYes-

Operational Notes

Only gdsprovider "0" supports this flow. Store the returned cancellation id and confirm details before finalizing.

Example

bash
bash
curl -X POST https://api.sandbox.travelandz.com/v1/flights/order/pending/cancel/0/order_123 \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"