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

Crear cancelación pendiente de vuelo

Inicia un flujo de cancelación pendiente para revisar reembolso, penalidades o confirmación del proveedor antes de cancelar definitivamente.

Inicia un flujo de cancelación pendiente para revisar reembolso, penalidades o confirmación del proveedor antes de cancelar definitivamente.

Endpoint

MétodoRutaAuth
POST/v1/flights/order/pending/cancel/:gdsprovider/:orderIdAPI key requerida
Headers obligatorios:
HeaderDescripción
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.

Esquema de parámetros de la petición

PropiedadTipoDetallesRequeridoNotas
gdsprovidernumberOnly gdsprovider "0" supports this flow
orderIdstring-

Respuesta exitosa

Devuelve the pending cancellation id and provider state.

Esquema del cuerpo de la respuesta

PropiedadTipoDetallesRequeridoNotas
dataobject-
datarefund_to
string-
datarefund_currency
string-
datarefund_amount
string-
dataorder_id
string-
datalive_mode
boolean-
dataid
string-
dataexpires_at
string
Format: ISO 8601
-
datacreated_at
string
Format: ISO 8601
-
dataconfirmed_at
string
Format: ISO 8601
-
dataairline_credits
array-
dataairline_credits[]passenger_id
string-
dataairline_credits[]issued_on
string
Format: ISO 8601
-
dataairline_credits[]id
string-
dataairline_credits[]credit_name
string-
dataairline_credits[]credit_currency
string-
dataairline_credits[]credit_code
string-
dataairline_credits[]credit_amount
string-

Notas operativas

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

Ejemplo

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"