Travel Agency Corporate ID API Reference

POST

ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/addcorporatecode

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/

Put

ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/updatecorporatecode

For {travelagencyID} send the agency identifier returned in TravelAgency/id.

See the POST request above for other variables and the base path.

DEL

ticket/travelagency/reservationworkbench/{workbenchID}/travelagency/{travelagencyID}/deletecorporatecode

For {travelagencyID} send the agency identifier returned in TravelAgency/id.

See the POST request above for other variables and the base path.

Related Content: Booking Guide, Travel Agency Details API Reference

The Travel Agency Corporate ID API supports POST, PUT, and DEL requests to add, modify, or delete a travel agency corporate ID to or from the 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. in the current workbench. All requests must be sent as part of a workbench session, either during the initial booking workflow or a post-commitClosed Refers to the state of a booking after the booking is created, which happens after the initial booking workbench is commited and the reservation locator code issued. workbench for an existing booking, and followed by a workbench commit.

For adding only, you can instead use the Travel Agency Details API to add all travel agency details in a single request using one payload. Using the Travel Agency Details API for adding is recommended, as the individual POST endpoints for the travel agency corporate ID, telephone, email, and address APIs will eventually be deprecated.

The reservation retrieve for a booking returns any travel agency details associated with that booking.

Request

Also see Authorization and Common Headers.

Query Parameters

None.

Request Body

Use the following request for both the POST (add) and PUT (update) calls. The DEL (delete) request does not send a request body.

Note the different endpoints for each operation per above.

Object

Description

Required/Optional

TravelAgencyQueryTravelAgencyCorporateCode

Top level object.

Required

CorporateCode

Corporate code value.

Required

Response

The add and update responses return an id for the newly added or updated id. The corporate code value is not returned in this response but is returned in any subsequent Reservation Retrieve.

The delete response returns an empty 204 No Content message.

Object

Description

TravelAgencyResponse

Top level object.

Includes TravelAgency object.

TravelAgency

Corporate code value. Key value pair:

id: System-generated id for this travel agency.

Identifier

System-generated internal identifier for the response:

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

Use the following request for both the add and update operations; note the different endpoints for each operation per above.

{
 "TravelAgencyQueryTravelAgencyCorporateCode": {
  "CorporateCode": "HSBC01GBHRG"
 }
}

Example Response

The following example response is returned for the add and update operations.

The delete response returns a 204 No Content message.

{
    "TravelAgencyResponse": {
        "TravelAgency": {
            "@type": "TravelAgency",
            "id": "HSBC01GBHRG",
            "Identifier": {
                "value": "9c65ed3a-b30e-4df7-ad0b-07516d239bea",
                "authority": "Travelport"
            }
        }
    }
}