Changing a flight

High level example API flow for changing a flight

This functionality allows you to change (i.e replace) a flight within an order.

Changing a flight takes at least 7 steps:

  1. Check what alternative flights are offered - POST /v1/servicing/changeFlight/availability?supplierCode=BAE&supplierBookingReference=abcd

    • Set the request URL parameters as appropriate
    • NOTE request body has been omitted from this example
    • The request body must list the flights you wise to remove and the flights you wish to shop for as their replacement. The flights you wish to replace are specified using replaceFlightDid. The flights you wish to shop for are specified using departure airport, departure date, and arrival airport.
      • Flight DIDs for use in replaceFlightDid can be found in order retrieve response
    • Response will list flight offers
  2. Quote - Request a quote for changing one or more flights - POST /v1/servicing/changeFlight/quote?supplierCode=BAE&supplierBookingReference=abcd

    • Set the request URL parameters as appropriate
    • NOTE request body has been omitted from this example
    • The request body must specify the offer you wish to select. This offer will include one or more flight changes depending on your previous search request
      • The offer is identified by its DID. To find the DID for a given offer check the availability response
    • If initially successful the response will then need polling
  3. Poll for quote response - GET /v1/servicing/changeFlight/quote/poll?asyncOperationToken=b3604d53-2e29-4d03-923d-565a98d7ad1e

    • asyncOperationToken is from previous response
    • Multiple polls may be required
  4. Prepare - Provide payment details to get a final price - POST /v1/servicing/changeFlight/prepare?transactionId=78dfe432-5159-490f-82ea-a63b90e77693

    • NOTE request body has been omitted from this example
    • transactionId is from the previous response
  5. Poll for prepare response - GET /v1/servicing/changeFlight/prepare/poll?asyncOperationToken=79c2b2e0-b982-4d27-8179-d03cbdd64142

    • asyncOperationToken is from previous response
    • Multiple polls may be required
  6. Execute - Request change be performed - POST /v1/servicing/changeFlight/execute?transactionId=78dfe432-5159-490f-82ea-a63b90e77693

    • NOTE request body has been omitted from this example
    • expectedPriceAmount & expectedPriceAmountCurrency in request body must be correctly set based on totalPrice from previous response
      • This validates that you agree with PaxFaB Servicing’s calculations
    • expectedPaymentAmount & expectedPaymentAmountCurrency in request body must be correctly set based on newPayment.totalAmount from previous response.
      • This validates that you agree with PaxFaB Servicing’s calculations
    • Payment details must be provided in request. If these differ than at prepare undefined behaviour may occur.
  7. Poll for execute response - GET /v1/servicing/changeFlight/execute/poll?asyncOperationToken=0f2430a8-7500-416f-9877-923370f5ddb6

    • asyncOperationToken is from previous response
    • Multiple polls may be required