---
title: "Batch Void"
method: POST
path: "/documents/void"
tags: ["Ticketing"]
---

# Batch Void

`POST /documents/void`

The Batch Void API voids multiple documents, including Tickets, EMDs and MCOs on a single booking. You can either void all documents of a specific type (ticket, EMD, or MCO), or send a list of individual ticket or document numbers to void. All tickets and/or documents must be on the same booking. This function is not supported for NDC or LCC. TASF void will be supported as a future enhancement.

## Headers

- `TraceId` string
- `XAUTH_TRAVELPORT_ACCESSGROUP` string
- `travelportPlusSessionIdentifier` string
- `TVP-PCC-Core` string

## Request body

- DocumentVoidQueryRequest — Allows user to support voiding GDS issued documents including Tickets, EMDs and MCOs. This request allows user to void documents by PNR (all documents in PNR voided) or by individual document number(s).
  - `locator` Locator, required — Locator information for the reservation. Contains the locator (PNR or external locator) or cancellation number for the reservation, order, or offer.
    - `value` string — Reference number for locatorType. Booking.com returns a PIN number along with the confirmation number for each sold hotel segment. If the agent/traveler needs to reconcile the booking with Booking.com, Booking.com requires both the PIN number and confirmation number to locate the segment in their system.
    - `locatorType` string — Specifies the type of reservation ID Travelport - Confirmation number; PNR locator Agency - IATA Number Booking.com - Confirmation number; PIN number In Document History, may return the content source (e.g. GDS or NDC)
    - `source` string — Content source. Typically a two-character Supplier code that indicates the source system which generated the resid. For Hotels, if source matches chain code, the offer is directly with the supplier. If source is 'BO', the offer is with Booking.com.
    - `sourceContext` string — Specifies the context of the source. Either Travelport, Agency, or Supplier.
    - `otaType` string — Used for codes
    - `creationDate` string, date — Date created in Travelport or supplier system in YYYY-MM-DD format.
    - `lastUpdated` string, date-time — The date and time stamp the Reservation was last updated.
  - `documentVoid` DocumentVoid[], required
    - `documentType` 'EMD' | 'MCO' | 'Ticket' | 'TASF' | 'Invoice', required — Document type like EMD, MCO
    - `number` string[]
    - `reverseResidentFareInd` boolean — Request reversal of residency fare allocation in SARA database.

## Response `200`

OK - Successful response

- DocumentVoidListResponseWrapper — Wrapper schema to expose the root element in the JSON example.
  - `DocumentVoidListResponse` DocumentVoidListResponse — Base response is part of all TripServices responses and includes common items which are relevant across all APIs
    - `@type` string
    - `transactionId` string — A unique system-generated (128 bit GUID format) transaction/tracking id for a single request and response (i.e. for a single transaction) used for internal tracking and troubleshooting. Also known as E2ETrackingId. Not returned in all Hotel API responses.
    - `traceId` string — Used in hospitality workflows to provide a unique transaction or tracking id for a single request and response. For Air Eligibility, returned if a custom trace ID was sent in the request header. For Hotel Rules, returned if a custom trace ID was sent in the request header.
    - `correlationId` string, uuid — Identifier used to correlate hotel API invocations across a multi-call business flows.
    - `reservationStatus` 'Success' | 'Fail' | 'Partial' | 'Pending' | 'OnHold' | 'Retry' | 'Other' — Status of reservation or offer completion.
    - `Result` Result — Returns the error and/or warning message information, if applicable.
      - `@type` string — Discriminator class Result only
      - `status` 'Not processed' | 'Incomplete' | 'Complete' | 'Unknown' — The status of an error or warning
      - `Error` Error[] — A list of error information returned at the provider level for a response.
        - `@type` string, required — Discriminator classes Error or ErrorDetail
        - `StatusCode` integer — Http standard response code
        - `Message` string — The Travelport standardized error or warning message
        - `NameValuePair` NameValuePair[]
          - `value` string — Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
          - `id` string — Optional internally referenced id
          - `name` string, required — Key, categorizing the type of remark or error.
      - `Warning` Warning[] — A list of warning information returned at the provider level for a response.
        - `@type` string, required — Discriminator classes Warning or WarningDetail
        - `StatusCode` integer — Http standard response code
        - `Message` string — The Travelport standardized error or warning message
        - `NameValuePair` NameValuePair[]
          - `value` string — Text directly related to name description, providing more detail. May have character restrictions based on remark type (e.g. Free Text limitations: 84 characters, alphanumeric and some special characters).
          - `id` string — Optional internally referenced id
          - `name` string, required — Key, categorizing the type of remark or error.
    - `Identifier` Identifier — A globally unique identifier key often used to reference a given option (such as Pricing, Booking, Rules, or additional workflows) or to retrieve information (such as Hotel pagination).
      - `value` string — Unique offer identifier that can be sent in subsequent payload requests to reference this offer. When used for reference flight calls, the CatalogProductOfferingsIdentifier will be the transaction identifier from the Search, Next Leg Search, or Flight Specific Search response in CatalogProductOfferings/Identifier/value. If you choose to pull the CatalogProductOfferingsIdentifier from the Price response instead (OfferListResponse/Identifier/value), either full or reference payload, please note for subsequent Add Offer requests you must remove the _PC appended to the end of the value in the AirPrice response (e.g., change value: '93d2091d-3d04-48ab-8091-6ae1525f02ea_PC' to value: '93d2091d-3d04-48ab-8091-6ae1525f02ea'). When building an AirPrice or Add Offer reference payload request: - Look for the CatalogProductOfferingIdentifier (ex: o1) in a Search response at CatalogProductOfferings/CatalogProductOffering/id or a Price response at OfferListResponse/OfferID/id. - Look for the ProductIdentifier (ex: p0) in a Search response at CatalogProductOfferings/CatalogProductOffering/ProductBrandOptions/ProductBrandOffering/Product/productRef or from a Price response at OfferListResponse/OfferID/Product/id. When returned from a Workbench, this value is the workbench identifier that must be sent in all subsequent requests for this workbench session. When returned from Air Exchange Eligibility, value is the ticket number sent with the eligibility request. When used specifically for form of payment, the value will begin with the characters 'FOP'. Similarly, the OfferIdentifier associated will begin with the character 'O'. For Hotel Create Reservation (Reference Payload), send the value from the Availability response in CatalogOffering/id or the value from SearchComplete returned in propertyItems/lowestPublicAvailableRate/rateKey/value. Results from Hotel Availability and Hotel SearchComplete are stored in the cache for 30 minutes. If the offers expire before booking, you must send a new request.
      - `authority` string — Name of the supplier system that created this identifier - the source of information. For AirPrice, please note that GDS offers return the value 'Travelport' in authority while NDC offers return the carrier code of the issuing NDC carrier. When returned from Air Exchange Eligibility, authority is always 'Travelport' as the transaction issuer. For Hotels, authority indicates which supplier returned the lowest available rate for that property: either 'TVPT' (Travelport) or 'BKNG' (booking.com). Booking.com access requires additional provisioning and a direct agreement with the supplier. Authority is not returned if the property is closed or returns an error. For Hotel Create Reservation (Full Payload) and Sync Reservation send the value from the Availability response in CatalogOffering/Identifier/authority for the instance you want to book.
    - `NextSteps` NextSteps — Container for the steps that describe actions that may be taken on the containing object. Not applicable for an Eligibility or Exchange response.
      - `baseURI` string, required — The base portion of the URI in order to shorten the uris in the individual steps
      - `id` string — Optional internally referenced id
      - `NextStep` NextStep[], required
        - `value` string
        - `id` string — Identifier for the Next Step
        - `action` string, required — The action this next step is intended to achieve
        - `method` 'GET' | 'DELETE' | 'PUT' | 'POST', required — Describes the set of potential methods that can be taken after an operation.
        - `description` string — Additional clarification for the next step
    - `ReferenceList` ReferenceList[]
      - `@type` string, required — Discriminator - Air Search child classes are ReferenceListAmenity, ReferenceListBrand, ReferenceListFlight, ReferenceListProduct, ReferenceListTermsAndConditions, and ReferenceListUniversalProductAttribute. - Air Price child classes are ReferenceListAmenity and ReferenceListBrand. - FareRules child class is ReferenceListFlight. - Search Ancillaries child class is ReferenceListFlight. - Seat Map child class is ReferenceListSeatingChart. - Hotel Availability child class is ReferenceListPropertyDates. - Reservation and Reservation Workbench child classes are ReferenceListAmenity, ReferenceListBrand, and ReferenceListUniversalProductAttribute. - Exchange Search child classes are ReferenceListBrand, ReferenceListFlight, and ReferenceListExchangedPrice. - Reservation Receipt child classes are ReferenceListOffer and ReferenceListTraveler. - Book_Traveler child class is ReferenceListTraveler.
      - `id` string — Uniquely identifies for the Reference List
    - `CurrencyRateConversion` CurrencyRateConversion[]
      - `@type` string
      - `SourceCurrency` CurrencyCode, required — Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.
        - `value` string — An ISO 4217 currency code.
        - `codeAuthority` string — Currency code authority
        - `decimalPlace` integer — Number of decimal places for the currency.
        - `decimalAuthority` string — Currency code decimal authority
      - `TargetCurrency` CurrencyCode, required — Currency codes are the three-letter alphabetic codes that represent the various currencies used throughout the world. Unless changed in the request, the currency is the default associated with your provisioned PCC from Travelport. For Hotel: SourceCurrency is based on the location of the hotel and used for all rates in the response. TargetCurrency is the currency code sent in the request in requestedCurrency.
        - `value` string — An ISO 4217 currency code.
        - `codeAuthority` string — Currency code authority
        - `decimalPlace` integer — Number of decimal places for the currency.
        - `decimalAuthority` string — Currency code decimal authority
      - `ConversionRate` ConversionRate, required — Conversion rate of SourceCurrency value to TargetCurrency value. This value can be used to calculate, independently of the API, conversion for the rates in the response. The response does not convert any amounts.
        - `value` number, float
        - `rateAuthority` string — Contextual rate authority
        - `rateAsOf` string, date-time — Rate as of
    - `Pagination` Pagination — Pagination object used when result sets span across a number of pages.
      - `@type` string, required
      - `page` integer, required — The current page number of the full result set
      - `pageSize` integer, required — The total number of items on this page
      - `totalPages` integer, required — The total number of pages in this result set
      - `totalItems` integer, required — The total number of pages in this result set

## Other responses

- `400` — Bad Request - 400
- `401` — Unauthorized - 401
- `402` — Payment Required - 402
- `403` — Forbidden - 403
- `404` — Not Found - 404
- `500` — Internal Server Error - 500
- `503` — Service Unavailable - 503. This error may be returned when the service is temporarily unavailable due to infrastructure or network issues.

---

[API](https://skmtc.net/travelport/apis/tripservices-flights.md) · [All operations](https://skmtc.net/travelport/apis/tripservices-flights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/travelport/tripservices-flights/versions/2628253a4cd5/schema)