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

Functionality in the Cancel Workbench Items API is being deployed in phases. It currently offers specific payloads that support the following cancellation options.

In the initial booking workbench only:

Cancel entire reservation
Cancel all offers In the JSON Search APIs, an offer is a product available at a specific price under a set of terms and conditions. An offer includes the flight or connecting flights for one leg of the itinerary, plus a service level that includes the cabin class and any fare codes that may apply. At booking, the selected offer from the Search response - including the flight/s, service level, price, terms and conditions, and brand if applicable - is converted into a single Offer object that is subsequently returned for that booking. in the workbench
Cancel a specific offer in the workbench (NDC only)

In the post-commit workbench only; in other words, for an existing reservation, Cancel Workbench Items is supported only for GDS. To modify an NDC held booking, use the NDC Modify API. Cancel Workbench Items currently supports the following for GDS on an existing booking:

Cancel entire booking
Cancel a single, multiple, or all offers on the booking, including air, hotel, and car offers
Cancel a product In the JSON APIs, a product is the term used in the model for one leg of the itinerary. It includes the flight or connecting flights between one origin and destination pair; e.g., LON > EWR. Product information also includes a service level of the cabin class and any applicable fare codes. within an air offer
Cancel a segment A flight or flights under one flight number. One flight equals one segment. A segment could have multiple flights if the flight number remains the same, which happens if a flight makes a stop without changing planes. within an air product
cancel multiple segments across air 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 Items must always be followed by a Workbench Commit to commit the changes.

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.

Show Request Body Table (NDC initial booking workbench; ; GDS post-commit workbench)

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.

Show Request Body Table - cancel all offers (air, hotel, car) (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.

Show Response Body Table

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.

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.

Show Example request to cancel entire reservation (NDC initial booking workbench; GDS 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.

Show Example request to cancel all offers (inclusive of air/car/hotel) (GDS 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.

Show Example

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