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 {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 Corporate ID request adds a travel agency corporate ID to the booking. This request is sent as part of a workbench session, either during the initial booking workflow or a post-commit workbench for an existing reservation. 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 and address associated with that booking.
Request
Also see Authorization and Common Headers.
Query Parameters
None.
Request Body
Use the following request for both the add and update operations; note the different endpoints for each operation per above.
The delete request does not have a message body.
Object |
Description |
Required/Optional |
---|---|---|
TravelAgencyQueryTravelAgencyCorporateCode |
Top level object. |
Required |
CorporateCode |
Corporate code value. |
Required |
Response
The response returns an identifier for the travel agency.
Object |
Description |
---|---|
TravelAgencyResponse |
Top level object. Includes TravelAgency object. |
TravelAgency |
Corporate code value. Key value pair:
|
Identifier |
System-generated identifier for the travel agency; use this in subsequent update and delete request:
|
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 response is returned for the add and update operations.
{
"TravelAgencyResponse": {
"TravelAgency": {
"@type": "TravelAgency",
"id": "travelagency_1",
"Identifier": {
"value": "9c65ed3a-b30e-4df7-ad0b-07516d239bea",
"authority": "Travelport"
}
}
}
}
The delete response returns a No Content message.
The following example shows the corporate code as returned in the Reservation Retrieve response after the corporate code has been added and the workbench committed. The preceding objects have been collapsed for brevity.
{
"ReservationResponse": {
"@type": "ReservationResponse",
"Reservation": {
"@type": "Reservation",
"Identifier": {
"authority": "Travelport",
"value": "ca969ac3-c13b-4558-9016-9988ddc9633c"
},
"Offer": [
{...}
],
"Traveler": [
{...}
],
"Receipt": [
{...},
{...}
],
"ReservationComment": [
{...}
],
"TravelAgency": {
"@type": "TravelAgency",
"id": "travelAgency_1",
"Identifier": {
"authority": "Travelport",
"value": "45ae2d68-8894-458a-a2da-ea3038949d6f"
},
"CorporateCode": "TEST01USCWT"
},
"ReservationDisplaySequence": {
"@type": "ReservationDisplaySequence",
"DisplaySequence": [
{
"@type": "DisplaySequence",
"displaySequence": 1,
"OfferRef": "offer_1",
"ProductRef": "product_1",
"Sequence": 1
}
]
}
},
"Identifier": {
"authority": "Travelport",
"value": "ca969ac3-c13b-4558-9016-9988ddc9633c"
}
}
}