v1

latestOpenAPI 3.0.02026-08-061029011.1 MB
NDC Modify Cancel Exchange

Modify

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.

post/air/modify/reservations/{Identifier}

Path parameters

Identifierstring required
Example:49f58f5f-c443-43b4-9f5d-be405fd00a01

The Reservation Workbench Identifier you wish to modify NDC content

Query parameters

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.

Issuance'Ticket' | 'BackOffice' | 'All' | 'Invoice'

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

DocumentValue'Retain' | 'Refund' | 'Forfeit' | 'Void'

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

payLaterIndboolean

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

Headers

TraceIdstring
Example:TraceID_123456789

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

XAUTH_TRAVELPORT_ACCESSGROUPstring
Example:19Y88702-C27A-4E5D-829A-89D7016688B1

Identifies the Travelport access group with which the caller is associated

travelportPlusSessionIdentifierstring
Example:49f58f5f-c443-43b4-9f5d-be405fd00a01

travelportPlusSessionIdentifier used to maintain an established agency session

TVP-PCC-Corestring
Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

Request body

scheduleChangeAcceptedIndboolean

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

errorWhenOfferPriceCancelledIndboolean
inhibitResidualDocumentIssuanceIndboolean

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

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.

overrideMCTIndboolean

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

errorWhenScheduleChangesIndboolean

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

scheduleChangeReprice'RetainOfferPrice' | 'AcceptOfferPriceDifference'
ReceivedFromstring

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

errorWhenOfferPriceChangesIndboolean

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

Example request

{
  "Notification": [
    {
      "QueueNumber": [
        {
          "value": 10,
          "category": "CAE",
          "subCategory": "Date Range sub-category",
          "overridePCC": "0XS4"
        }
      ],
      "Comment": "Optional free text"
    }
  ],
  "inhibitResidualDocumentIssuanceInd": true,
  "enableTwoStepCommitInd": true,
  "overrideMCTInd": true,
  "errorWhenScheduleChangesInd": true,
  "scheduleChangeReprice": "AcceptOfferPriceDifference",
  "ReceivedFrom": "TW",
  "errorWhenOfferPriceChangesInd": true
}

Response

OK - Successful Response - 200

Example response

{
  "ReservationResponse": {
    "Reservation": {
      "@type": "Reservation",
      "id": "REF12873",
      "Identifier": {
        "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
        "authority": "TVPT"
      }
    },
    "@type": "response",
    "transactionId": "49f58f5f-c443-43b4-9f5d-be405fd00a01",
    "traceId": "TraceID_123456",
    "Result": {
      "@type": "Result",
      "status": "Complete",
      "Error": [
        {
          "@type": "ErrorDetail",
          "StatusCode": 200,
          "Message": "No flights found.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ],
      "Warning": [
        {
          "@type": "WarningDetail",
          "StatusCode": 200,
          "Message": "Customer Loyalty could not be applied.",
          "NameValuePair": [
            {
              "value": "Sunday",
              "id": "6",
              "name": "Day1"
            }
          ]
        }
      ]
    },
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    },
    "NextSteps": {
      "id": "5",
      "NextStep": [
        {
          "value": "www.resourcelocation.com",
          "id": "2",
          "action": "cancel",
          "description": "remove offer from the order"
        }
      ]
    },
    "ReferenceList": [
      {
        "@type": "ReferenceListFlight"
      }
    ],
    "CurrencyRateConversion": [
      {
        "SourceCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "TargetCurrency": {
          "value": "USD",
          "codeAuthority": "ISO 4217",
          "decimalPlace": 4,
          "decimalAuthority": "ISO 4217"
        },
        "ConversionRate": {
          "rateAuthority": "ISO 4217",
          "rateAsOf": "2026-08-07T12:12:00Z"
        }
      }
    ],
    "Pagination": {
      "@type": "Pagination",
      "page": 1,
      "pageSize": 20,
      "totalPages": 5,
      "totalItems": 100
    }
  }
}