BookingFlow

Polls for the status of a multi-city search session and returns available results for the step.

post/searchmulticity/{searchId}/{searchKey}/{step}

Path parameters

searchIdinteger required

Numeric search Id.

searchKeystring required

36-character search security key.

stepinteger required

Step to initialise.

Query parameters

interactSessionstring

Optional but recommended customer interaction session. Keep the same session valid for the whole customer interaction journey.

Request body

previousStage1 | 2 | 3 | 4 | 5 | 6 | 7

Enumerator defining booking stages:<br>1=Search, 2=GetInformation, 3=PricingAndExtras, 4=Reserve, 5=Pay, 6=Book, 7=Cancel

previousStepIdinteger nullable

Optional previous step identifier (only for multi-city package searches)

previousSIDstring nullable

Optional previous step identifier (only for multi-city package searches)

returnUpsellsProductTypes[] nullable

Flag to trigger product upsells in the response

isUpsellboolean

Flags that the selection is an upsell product

orderRefstring nullable

Optional order reference for maintaining an existing basket (ADVANCED USE ONLY - DO NOT USE WITHOUT PERMISSION FROM TRAVELGENIX)

specialRequestsstring nullable

Optional special requests that may be sent to the supplier but cannot be guaranteed

depositOptionIDinteger nullable

Selected deposit option identifier

Example request

{
  "flight": {
    "routes": [
      {
        "extras": [
          {
            "participants": [
              {
                "firstname": "Joe",
                "middleNames": "B",
                "surname": "Bloggs",
                "dateOfBirth": "1970-01-25",
                "nationality": "GB",
                "foidNumber": "ABC123456",
                "foidStartDate": "2015-01-10",
                "foidExpiryDate": "2025-01-10",
                "foidIssuingCountry": "GB"
              }
            ]
          }
        ]
      }
    ],
    "extras": [
      {
        "participants": [
          {
            "firstname": "Joe",
            "middleNames": "B",
            "surname": "Bloggs",
            "dateOfBirth": "1970-01-25",
            "nationality": "GB",
            "foidNumber": "ABC123456",
            "foidStartDate": "2015-01-10",
            "foidExpiryDate": "2025-01-10",
            "foidIssuingCountry": "GB"
          }
        ]
      }
    ],
    "travellers": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "accommodation": {
    "extras": [
      {
        "participants": [
          {
            "firstname": "Joe",
            "middleNames": "B",
            "surname": "Bloggs",
            "dateOfBirth": "1970-01-25",
            "nationality": "GB",
            "foidNumber": "ABC123456",
            "foidStartDate": "2015-01-10",
            "foidExpiryDate": "2025-01-10",
            "foidIssuingCountry": "GB"
          }
        ]
      }
    ],
    "guests": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "package": {
    "extras": [
      {
        "participants": [
          {
            "firstname": "Joe",
            "middleNames": "B",
            "surname": "Bloggs",
            "dateOfBirth": "1970-01-25",
            "nationality": "GB",
            "foidNumber": "ABC123456",
            "foidStartDate": "2015-01-10",
            "foidExpiryDate": "2025-01-10",
            "foidIssuingCountry": "GB"
          }
        ]
      }
    ],
    "guests": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "tour": {
    "travellers": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "ticket": {
    "options": [
      {
        "extras": [
          {
            "participants": [
              {
                "firstname": "Joe",
                "middleNames": "B",
                "surname": "Bloggs",
                "dateOfBirth": "1970-01-25",
                "nationality": "GB",
                "foidNumber": "ABC123456",
                "foidStartDate": "2015-01-10",
                "foidExpiryDate": "2025-01-10",
                "foidIssuingCountry": "GB"
              }
            ]
          }
        ]
      }
    ],
    "travellers": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "transfer": {
    "extras": [
      {
        "participants": [
          {
            "firstname": "Joe",
            "middleNames": "B",
            "surname": "Bloggs",
            "dateOfBirth": "1970-01-25",
            "nationality": "GB",
            "foidNumber": "ABC123456",
            "foidStartDate": "2015-01-10",
            "foidExpiryDate": "2025-01-10",
            "foidIssuingCountry": "GB"
          }
        ]
      }
    ],
    "travellers": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "carRental": {
    "extras": [
      {
        "participants": [
          {
            "firstname": "Joe",
            "middleNames": "B",
            "surname": "Bloggs",
            "dateOfBirth": "1970-01-25",
            "nationality": "GB",
            "foidNumber": "ABC123456",
            "foidStartDate": "2015-01-10",
            "foidExpiryDate": "2025-01-10",
            "foidIssuingCountry": "GB"
          }
        ]
      }
    ],
    "driver": {
      "firstname": "Joe",
      "middleNames": "B",
      "surname": "Bloggs",
      "dateOfBirth": "1970-01-25",
      "nationality": "GB",
      "foidNumber": "ABC123456",
      "foidStartDate": "2015-01-10",
      "foidExpiryDate": "2025-01-10",
      "foidIssuingCountry": "GB"
    },
    "additionalDriver": {
      "firstname": "Joe",
      "middleNames": "B",
      "surname": "Bloggs",
      "dateOfBirth": "1970-01-25",
      "nationality": "GB",
      "foidNumber": "ABC123456",
      "foidStartDate": "2015-01-10",
      "foidExpiryDate": "2025-01-10",
      "foidIssuingCountry": "GB"
    }
  },
  "insurance": {
    "extras": [
      {
        "participants": [
          {
            "firstname": "Joe",
            "middleNames": "B",
            "surname": "Bloggs",
            "dateOfBirth": "1970-01-25",
            "nationality": "GB",
            "foidNumber": "ABC123456",
            "foidStartDate": "2015-01-10",
            "foidExpiryDate": "2025-01-10",
            "foidIssuingCountry": "GB"
          }
        ]
      }
    ],
    "travellers": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "airportExtras": [
    {
      "travellers": [
        {
          "firstname": "Joe",
          "middleNames": "B",
          "surname": "Bloggs",
          "dateOfBirth": "1970-01-25",
          "nationality": "GB",
          "foidNumber": "ABC123456",
          "foidStartDate": "2015-01-10",
          "foidExpiryDate": "2025-01-10",
          "foidIssuingCountry": "GB"
        }
      ]
    }
  ],
  "extras": [
    {
      "participants": [
        {
          "firstname": "Joe",
          "middleNames": "B",
          "surname": "Bloggs",
          "dateOfBirth": "1970-01-25",
          "nationality": "GB",
          "foidNumber": "ABC123456",
          "foidStartDate": "2015-01-10",
          "foidExpiryDate": "2025-01-10",
          "foidIssuingCountry": "GB"
        }
      ]
    }
  ],
  "multiCity": {
    "travellers": [
      {
        "firstname": "Joe",
        "middleNames": "B",
        "surname": "Bloggs",
        "dateOfBirth": "1970-01-25",
        "nationality": "GB",
        "foidNumber": "ABC123456",
        "foidStartDate": "2015-01-10",
        "foidExpiryDate": "2025-01-10",
        "foidIssuingCountry": "GB"
      }
    ]
  },
  "contactInfo": {
    "internalRef": "CUST-123",
    "emailAddress": "joe.bloggs@email.com",
    "telephone": {
      "countryPrefix": "44",
      "number": "0123456789"
    },
    "firstname": "Joe",
    "surname": "Bloggs",
    "company": "ACME Travel",
    "address1": "123 Any Road",
    "city": "Bournemouth",
    "state": "Dorset",
    "postalCode": "BH1 1AB",
    "countryCode": "GB"
  }
}

Response

Success - Returns the status of the requested search session, including any results available.

successboolean

Indicator as to whether API request was successful.

versioninteger nullable

API method version (for information only)

errorsstring[] nullable

Returns a list of errors if success is returned as false.

infostring nullable

Generic information (should not be dislayed to end user or used - informational purposes only).

interactSessionstring nullable

Customer interaction session. This should be cookied for 365-days for an individual customerand is used for personalisation features.

searchSessionstring nullable

Search session identifier which is used throughout a booking journey (e.g. id/guid).

humanReadableSearchRefstring nullable

A human-readable search identifier and can be shown to the end user for telephone enquiries about the current search (can be used by agents to look up the search in admin console)

shareUrlstring nullable

A sharing URL for this search

deeplinkUrlstring nullable

A deeplink URL for this search normally used for abandoned basket email tracking

orderRefDisplaystring nullable

Order reference for displaying to customer.

orderRefstring nullable

Order reference for maintaining a basket (e.g. id/guid).

orderCanAmendboolean nullable

Defines if an order can be amended

hasPreConfirmUrlboolean nullable

Defines if an order has a pre-confirmation URL (eg. Ryanair)

dedupeboolean nullable

Flag to inform front end that it needs to deduplicate results

totalinteger nullable

Total number of suppliers/threads initiated on the booking flow step.

completedinteger nullable

Number of completed suppliers/threads initiated on the booking flow step.

{"stackTrail":"components:schemas:APIResponse:properties:data","oasType":"schema","type":"unknown","description":"Returns generic data","nullable":true}

trackingCodestring nullable

Tracking code (if present)

specialRequestsstring nullable

Special requests

isSessionTimeoutboolean

Flag to inform front end of session timeout

sessionExpirystring date-time nullable

Session expiry date time

Changes

No recorded changes to this endpoint across all 1 revision of this API.