Travel Agency Corporate ID API Reference

INTERNAL - REVIEW QUESTION: Which of these requests - POST, PUT, and/or DEL - will still be in use when single payload Travel Agency Details POST request deploys?

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 {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

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

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

DEL

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

For {workbenchID} send the workbench identifier returned in ReservationResponse/Identifer/value in the workbench create response.

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

Base path:

Pre-production https://api.pp.travelport.com/11/air/

Production https://api.travelport.com/11/air/

Related Content: Booking Guide

The Travel Agency Corporate ID POST request adds a travel agency corporate ID to the booking, while the PUT request updates the travel agency corporate ID on a booking. Both requests also send a request payload and must be sent as part of a workbench session, either during the initial booking workflow or a post-commit workbench for an existing booking. It must be followed by a workbench commit to add it to the booking.

Use the DEL request above to delete a corporate ID from a booking, either during the initial booking workflow or a post-commit workbench for an existing reservation, and then commit the workbench.

The reservation retrieve for a booking returns any travel agency corporate ID 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 the newly added or updated id along with an internal identifier for the response.

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: User-assigned id for this travel agency. Must be sent in any subsequent update or delete request for the agency ID.

Identifier

System-generated internal identifier for the add or update response:

authority: Source of information.

value: Unique system-generated identifier.

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"
            }
        }
    }
}