Cancel a hold

POST

api

flights

orders

{orderId}

cancel-hold

curl -X POST "https://api.staging.ttool.travel/hub/api/v1/flights/orders/184233/cancel-hold" \
  -H "Authorization: Bearer $TOKEN"

{
  "ticketedAtProvider": false,
  "message": null,
  "order": {
    "orderId": 184233,
    "orderCode": 1005123,
    "status": "HoldCancelled",
    "pnr": "ABC123",
    "price": { "currency": "USD", "total": 350.90 },
    "tickets": []
  }
}

{
  "success": false,
  "error": { "errorCode": "ORDER_NOT_ON_HOLD", "errorCategory": "Conflict", "httpStatusCode": 409 }
}

No request body. Nothing was paid, so nothing is refunded. Call it before hold.expiresAt; after that the platform releases the PNR itself. Repeating the call is safe: a second call on a released order answers 409 ORDER_NOT_ON_HOLD.

Path

integer

required

The orderId returned by create order.

Response

boolean

true when the airline had already ticketed the PNR, for example because your staff issued it directly in the GDS. Nothing was cancelled, and order.status is IssuedSucceeded with the tickets.

string | null

object

The order as in order status, normally with status HoldCancelled.

Errors

HTTP	`errorCode`	Action
404	`ORDER_NOT_FOUND`	Unknown order, or not your agency’s
409	`ORDER_NOT_ON_HOLD`	The order isn’t `OnHold`: already issued, already released, or a normal booking
502	`HOLD_CANCEL_FAILED`	The airline didn’t confirm the release. Read the order and retry, or contact support.

curl -X POST "https://api.staging.ttool.travel/hub/api/v1/flights/orders/184233/cancel-hold" \
  -H "Authorization: Bearer $TOKEN"

{
  "ticketedAtProvider": false,
  "message": null,
  "order": {
    "orderId": 184233,
    "orderCode": 1005123,
    "status": "HoldCancelled",
    "pnr": "ABC123",
    "price": { "currency": "USD", "total": 350.90 },
    "tickets": []
  }
}

{
  "success": false,
  "error": { "errorCode": "ORDER_NOT_ON_HOLD", "errorCategory": "Conflict", "httpStatusCode": 409 }
}

curl -X POST "https://api.staging.ttool.travel/hub/api/v1/flights/orders/184233/cancel-hold" \
  -H "Authorization: Bearer $TOKEN"

{
  "ticketedAtProvider": false,
  "message": null,
  "order": {
    "orderId": 184233,
    "orderCode": 1005123,
    "status": "HoldCancelled",
    "pnr": "ABC123",
    "price": { "currency": "USD", "total": 350.90 },
    "tickets": []
  }
}

{
  "success": false,
  "error": { "errorCode": "ORDER_NOT_ON_HOLD", "errorCategory": "Conflict", "httpStatusCode": 409 }
}

Get started

Guides

Reference

API endpoints

Path

Response

Errors

​Path

​Response

​Errors

Path

Response

Errors