Sign in

v1

latestOpenAPI 3.0.02026-08-061029011.1 MB
Remarks and Special Service Requests

Document Override Remarks

Use document override to send remarks such as tour code, commission, or endorsements/restrictions.Document override remarks are returned in the PNR retrieve only when the detailViewInd query parameter is set to true. Document override remarks can be added to an existing PNR but cannot be modified or deleted.

post/air/book/documentoverride/Reservation/{ReservationResource_Identifier}/documentoverrides

Path parameters

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

The Reservation Identifier you wish to add document overrides

Headers

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

travelportPlusSessionIdentifier used to maintain an established agency session

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

TVP-PCC-Corestring
Example:DU7_1G

Allows user to pass PCC instead of Access Group ID

Request body

@typestring required

Discriminator classes DocumentOverridesID or DocumentOverrides

idstring

The reporting number.

DocumentOverridesRefstring
residualValueAsEvenExchangeMIRIndboolean

Report an exchange with residual value transaction as an Even exchange in the MIR.

obFeeExemptIndboolean

If true, the associated Offer is exempt from OB Payment Card Fees.

Example request

{
  "@type": "DocumentOverrides",
  "id": "documentoverrides_001",
  "Identifier": {
    "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
    "authority": "TVPT"
  },
  "OfferIdentifier": {
    "id": "offer_1",
    "offerRef": "offer_1",
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    }
  },
  "ProductIdentifier": {
    "id": "product_1",
    "productRef": "product_1",
    "Identifier": {
      "value": "A0656EFF-FAF4-456F-B061-0161008D7C4E",
      "authority": "TVPT"
    }
  },
  "Commissions": [
    {
      "TravelerIdentifierRef": [
        {
          "uris": [
            "google.com"
          ]
        }
      ],
      "Commission": {
        "@type": "CommissionAmount",
        "application": "Full"
      },
      "ApplyTo": "Base"
    }
  ],
  "DestinationPurpose": [
    {
      "@type": "DestinationPurpose",
      "destination": "Africa",
      "purpose": "Business"
    }
  ],
  "Restrictions": [
    {
      "TravelerIdentifierRef": [
        {
          "uris": [
            "google.com"
          ]
        }
      ],
      "Restriction": [
        "NON REFUNDABLE/NON ENDORSEABLE"
      ],
      "DocumentType": "Ticket"
    }
  ],
  "TourCodes": [
    {
      "@type": "TourCodes",
      "TravelerIdentifierRef": [
        {
          "uris": [
            "google.com"
          ]
        }
      ],
      "TourCode": {
        "tourCodeType": "Inclusive Tour"
      }
    }
  ],
  "ChangeFeeCollectionMethod": {
    "value": "EMD",
    "code": "f2142",
    "subCode": "631b",
    "description": "Change fee collection method",
    "changeFeeIssuedSeparatelyInd": true,
    "taxIncludedInBaseAmountInd": true
  },
  "NetRemitInfo": {
    "@type": "NetRemitInfo",
    "CarCode": "ACAR",
    "ValueCode": "D1000",
    "ActualSellingFare": 100.5,
    "NetBaseAmount": {
      "value": 43.3422,
      "currencyCode": "USD",
      "codeAuthority": "Australian Dollar",
      "decimalPlace": 3,
      "decimalAuthority": "ISO 4217"
    },
    "ClientDiscountCode": "DEF456"
  },
  "TicketDesignators": [
    {
      "TravelerIdentifierRef": [
        {
          "uris": [
            "google.com"
          ]
        }
      ]
    }
  ],
  "InvoiceFareAmount": {
    "value": 124.56,
    "code": "USD",
    "minorUnit": 2,
    "currencySource": "Supplier",
    "approximateInd": true
  },
  "residualValueAsEvenExchangeMIRInd": true,
  "obFeeExemptInd": true
}

Response

OK - Successful Response - 200

Example response

{
  "DocumentOverridesResponse": {
    "@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
    }
  }
}