TravelCaster API - Fulfillment - InitializeExchange

Back to Fulfillment home.

---

Retrieves the current booking details before starting an exchange. Returns the booked itinerary, fare summary, and passenger list. No changes are made to the booking.

This step is optional in the exchange flow but strongly recommended: it allows the application to display the current itinerary and fare to the user before presenting alternatives.

Request

JSON

https://endpoint/api/version/FulfillmentService.json/InitializeExchange [POST]

request: ExchangeInitializeRequest

response: ExchangeInitializeResponse

Structure of the ExchangeInitializeRequest object

ExchangeInitializeRequest
 |
 |_ Token (string - required - access token from AuthService)
 |_ BookingNumber (string - required - record locator of the booking to exchange)

Structure of the ExchangeInitializeResponse object

ExchangeInitializeResponse
 |
 |_ TransactionID (string)
 |_ TransactionCode (string - "0" = success)
 |_ TransactionMessage (string)
 |
 |_ BookingNumber (string - record locator)
 |_ OfficeID (string - provider office ID of the booking)
 |_ BookingDate (string - ISO 8601 YYYY-MM-DD)
 |_ BookingFare (FlightFare - booked fare summary)
 |  |
 |  |_ FareAmount (double)
 |  |_ TaxAmount (double)
 |  |_ TotalAmount (double)
 |  |_ Currency (string - ISO 3-letter)
 |  |_ ValidatingCarrier (string - IATA 2-letter)
 |  |_ LastTicketingDate (string - YYYY-MM-DD HH:mm:ss)
 |  |_ FareType (string)
 |  |_ Legs (FlightLeg[])
 |     |
 |     |_ LegNumber (int - 1-based)
 |     |_ Options (FlightOption[])
 |        |
 |        |_ OptionDuration (int - total duration in minutes)
 |        |_ Segments (FlightSegment[])
 |           |
 |           |_ SegmentNumber (int)
 |           |_ Airline (string - IATA 2-letter marketing carrier)
 |           |_ OperatingAirline (string - IATA 2-letter)
 |           |_ FlightNumber (int)
 |           |_ BookingClass (string - 1-letter RBD)
 |           |_ CabinClass (string - 1-letter: Y=Economy, W=Premium Economy, C=Business, F=First)
 |           |_ FareBasis (string)
 |           |_ Status (string - segment status code)
 |           |_ Equipment (string - IATA aircraft type)
 |           |_ Baggage (string - e.g. 1PC, 23K, 2PC-20K)
 |           |_ Duration (int - segment duration in minutes)
 |           |_ Departure (FlightEvent)
 |           |  |_ AirportCode (string - IATA 3-letter)
 |           |  |_ Date (string - YYYY-MM-DD)
 |           |  |_ Time (string - HH:MM local time)
 |           |_ Arrival (FlightEvent)
 |              |_ AirportCode (string - IATA 3-letter)
 |              |_ Date (string - YYYY-MM-DD)
 |              |_ Time (string - HH:MM local time)
 |
 |_ Passengers (PaxInformation[])
    |
    |_ Number (int - 1-based passenger reference)
    |_ LastName (string)
    |_ FirstName (string)
    |_ DateOfBirth (string - YYYY-MM-DD)
    |_ Gender (string)
    |_ Type (string - ADT, CHD, INF)

Notes

• A successful response does not guarantee that the booking is eligible for exchange. Eligibility is determined by the provider during SearchExchangeAlternatives.
• The BookingFare reflects the originally booked fare, not the current market price.

---

Back to Fulfillment home.