Cancel Workbench Items API Reference

POST

book/session/reservationworkbench/{workbenchID}/reservations/cancelitems

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

Base path:

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

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

Related Content:Booking Guide, Booking Session Workflow

Use this request to cancelClosed Cancel a ticket outside the void period without rebooking on another itinerary. Depending on the airline ticket policy, canceling a ticket may result in a full, partial, or no refund. all offers in an initial bookingClosed A confirmed reservation with the carrier. A held booking is a reservation that has not yet been ticketed. The terms booking and reservation are interchangeable. workbench (cannot be used to cancel offers from an existing reservation). The workbench session and any traveler data persist, and another offerClosed 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. can be added with Add Offer.

AirReservation 25.11.61. In this initial release, Cancel Workbench Items cancels all offers in the workbench and is supported only for NDCClosed New Distribution Capability, an XML standard for exchanging data that supports airlines in distributing their content directly to online travel agencies. See the NDC Guide. offers. Upcoming releases will support GDSClosed Global Distribution System. A GDS aggregates and distributes air, hotel, and car rental content such as schedules, fares, and upsells. In the JSON APIs, GDS content is distributed from Travelport. offers and cancellation of specific offers instead of all offers.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Object

Description

Required/Optional

@type

Identifier. Send with value CancelRequest

Required

cancelAllInd

Indicator. Send with value true

Required

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 identifierClosed In the JSON APIs, a unique identifier for specific, unique data, such as an entire response or an offer, product, or brand in a response. These identifiers must often be sent in subsequent requests to refer to a previous response, offer, product, etc. Usually returned in Identifier/value for the referenced object. Example format: 3cecf1be-0b21-4881-8f33-ae11c8d7b708. See the JSON APIs Guide..

Example Request

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

Example Response

The response returns a transaction identifier. 

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