Cancel Workbench Items API Reference

POST

book/reservationworkbench/{workbenchID}/reservations/cancelitems

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

Base path:

Note the following base path varies from other JSON APIs.

Pre-production https://api.pp.travelport.com/11/

Production https://api.travelport.com/11/

Related Content:Booking Guide, Booking Session Workflow

Cancel Workbench Items offers specific payloads that support the following cancellation options:

  • In the initial booking workbench only, and for NDC only, canceling all offers in the workbench

  • In the post-commit workbench only, and for GDS only, canceling either the entire booking or only the offers on a booking, including all air, hotel, and car offers

When only offers are canceled, any data in the workbench and/or in the booking persist, and another offer can be added with Add Offer. If the workbench is committed without adding another offer, a shell booking with only the remaining data is created.

Cancel Workbench must always be followed by a Workbench Commit to commit the changes.

Upcoming releases will support additional cancel options.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

The following payload cancels the entire reservation, including all offers, traveler data, and any other details on the booking. Currently supported only for NDC in the initial booking workbench, and for an existing GDS reservation in a post-commit workbench.

To cancel an existing NDC reservation, create a post-commit workbench and then use the NDC Cancel API.

Object

Description

Required/Optional

@type

Identifier. Send with value CancelRequest

Required

cancelAllInd

Indicator. Send with value true

Required

The following payload cancels GDS content from an existing booking, and is sent in a post-commit workbench. Not supported for NDC.

This payload cancels all offers (air, hotel, and car) on a held booking. The reservation remains active and includes any traveler data and other details on the booking.

(GDS post-commit workbench)

Object

Description

Required/Optional

@type

Identifier. Send with value CancelRequest

Required

cancelOffers

Object to cancel offers.

Required

objectType

String. Send with value CancelAllOffers

Required

Response

All of the request payloads above return a transaction identifier in the same format in the response.

Object

Description

ReservationResponse

Top level object.

Reservation

Top level object.

Includes Identifier.

Identifier

Standard Travelport system-generated transaction identifier.

Key value pairs:

authority: Source of information.

value: Unique system-generated identifier.

Example Request

See the Request Body section above for details on when the following payloads are supported.

Send the following payload to cancel the entire booking. Supported for NDC in the initial booking workbench. Supported for an existing GDS reservation only in the post-commit workbench.

{
  "@type": "CancelRequest",
  "cancelAllInd": true
}

Send the following payload to cancel all offers (air, hotel, and car as applicable) on an existing GDS booking. Supported only for GDS and only in the post-commit workbench. 

{
 "@type": "CancelRequest",
 "cancelOffers": {
  "objectType": "CancelAllOffers"
 }
}

Example Response

All of the request payloads above return a transaction identifier in the response per the example below. 

{
 "ReservationResponse": {
  "Reservation": {
   "@type": "Reservation",
   "Identifier": {
    "value": "8521bef5-da95-496f-9b03-fc3b1fcac50b",
    "authority": "Travelport"
   }
  }
 }
}