Skip to content
/
Modify

Modify

Request

After all required changes any optional steps in a booking workbench session, send a POST request with the workbench identifier to commit the order changes in the workbench.

Security
bearerAuth
Path
Identifierstring, <= 128 charactersrequired

The Reservation Workbench Identifier you wish to modify NDC content

Example:49f58f5f-c443-43b4-9f5d-be405fd00a01
Query
autoDeleteDatestring, (date)

Acts as a retention segment to hold the reservation open past the last date of travel purge date. Sending a new autoDeleteDate at commit step will update the existing autoDeleteDate. Sending 000/00/00 will delete an existing autoDeleteDate.

Issuancestring

Indicates the type of issuance that should be performed at commit. (Ticket, BackOffice (MIR/TAIR))

Enum:"Ticket""BackOffice""All""Invoice"
DocumentValuestring

Indicates of the value of the document should be refunded or retained following a CancelOffer action

Enum:"Retain""Refund""Forfeit""Void"
payLaterIndboolean

If true, the Reservation will be fulfilled at a later date

Headers
TraceIdstring, [ 10 .. 89 ] characters

Identifier used to correlate Air API invocations across a multi-call business flows.

Example:TraceID_123456789
XAUTH_TRAVELPORT_ACCESSGROUPstring, = 36 characters([a-zA-Z-0-9-_]*)

Identifies the Travelport access group with which the caller is associated

Example:19Y88702-C27A-4E5D-829A-89D7016688B1
travelportPlusSessionIdentifierstring, [ 0 .. 100 ] characters([a-zA-Z-0-9-_]*)

travelportPlusSessionIdentifier used to maintain an established agency session

Example:49f58f5f-c443-43b4-9f5d-be405fd00a01
TVP-PCC-Corestring^[a-zA-Z\d]{3,4}_\w{2}$

Allows user to pass PCC instead of Access Group ID

Example:DU7_1G
Bodyapplication/json
NotificationArray of objects, [ 1 .. 5 ] items(Notification)
scheduleChangeAcceptedIndboolean

If true, the schedule change is accepted by the consumer.

inhibitResidualDocumentIssuanceIndboolean

If true, any residual value will not be applied to an MCO or EMD.

Example:true
enableTwoStepCommitIndboolean

If true, reservation warnings such as minimum connection time will be returned to the user for review and a second commit will be required to proceed with creating the reservation.

Example:true
overrideMCTIndboolean

If true, the minimum connection time warning will be ignored and the Reservation created.

Example:true
errorWhenScheduleChangesIndboolean

If true, an error will be returned when the flight schedule changes during commit processing

Example:true
scheduleChangeRepricestring(ScheduleChangeRepriceEnum)
Enum:"RetainOfferPrice""AcceptOfferPriceDifference"
Example:"AcceptOfferPriceDifference"
ReceivedFromstring, <= 61 characters

Override the received from field with custom data. Field is stored in Reservation history.

Example:"TW"
errorWhenOfferPriceChangesIndboolean

If true, an error will be returned when the flight price changes during commit processing.

Example:true
errorWhenOfferPriceCancelledIndbooleandeprecated
curl -i -X POST \
  'https://developer.travelport.com/_mock/apis/flights/air/modify/reservations/49f58f5f-c443-43b4-9f5d-be405fd00a01?autoDeleteDate=2019-08-24&Issuance=Ticket&DocumentValue=Retain&payLaterInd=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'TVP-PCC-Core: DU7_1G' \
  -H 'TraceId: TraceID_123456789' \
  -H 'XAUTH_TRAVELPORT_ACCESSGROUP: 19Y88702-C27A-4E5D-829A-89D7016688B1' \
  -H 'travelportPlusSessionIdentifier: 49f58f5f-c443-43b4-9f5d-be405fd00a01' \
  -d '{
    "Notification": [
      {
        "QueueNumber": [
          {
            "value": 10,
            "category": "CAE",
            "subCategory": "Date Range sub-category",
            "overridePCC": "0XS4"
          }
        ],
        "Date": "2019-08-24",
        "Comment": "Optional free text"
      }
    ],
    "scheduleChangeAcceptedInd": true,
    "errorWhenOfferPriceCancelledInd": true,
    "inhibitResidualDocumentIssuanceInd": true,
    "enableTwoStepCommitInd": true,
    "overrideMCTInd": true,
    "errorWhenScheduleChangesInd": true,
    "scheduleChangeReprice": "AcceptOfferPriceDifference",
    "ReceivedFrom": "TW",
    "errorWhenOfferPriceChangesInd": true
  }'

Responses

OK - Successful Response - 200

Bodyapplication/json
ReservationResponseobject(ReservationResponse)

The response of a Create Reservation (Reference or Full Payload), Sync Reservation, Modify/Add Reservation, Create/Modify Passive Reservation, Retrieve Reservation, or Cancel Reservation endpoint. The structure detailed here is the same as for all of these API responses. For Post-Commit Workbench Create and Workbench Retrieve, the response is structured the same plus a workbench identifier. The information returned in the Reservation Retrieve response varies depending on the information that has been added to the reservation at the time of retrieve, whether the reservation has been ticketed, and whether the reservation was created using the Travelport TripServices APIs or another program.

Please note the requests for Workbench Commit (Create Reservation), Post-Commit Workbench Create, and Workbench Retrieve do not support the query parameters available in Reservation Retrieve and do not return the following:

  • any document override, accounting, historical, and DOCI remarks
  • any custom rules
  • brand attributes
  • baggage dimension and fee details
  • fare rules
  • ATPCO RouteHappy flight amenities
Response
{
  "ReservationResponse": {
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
    "reservationStatus": "Success",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [ … ],
      "Warning": [ … ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "baseURI": "string",
      "id": "5",
      "NextStep": [ … ]
    },
    "ReferenceList": [
      { … }
    ],
    "CurrencyRateConversion": [
      { … }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}