Sign in
BookingFlow

Starts a search session using the criteria provided.

post/search

Query parameters

interactSessionstring

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

Request body

environment0 | 1 | 2 | 3 | 4

Enumerator defining sales environment used for booking:<br>0=Website, 1=MobileWebsite, 2=AgentTool, 3=MobileApp, 4=MetaChannel

searchType1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 required

Enumerator defining type of search:<br>1=Flights, 2=Accommodation, 3=Packages, 4=TicketsAttractions, 5=Transfers, 6=AirportExtras, 7=Insurance, 8=CarRental, 9=Visas, 10=Tours, 11=DynamicPackaging, 12=CustomExtra, 13=Cruise, 14=TicketAccommodation, 15=TicketAccommodationFlight

languagestring required

ISO639-1 2-letter language code (e.g. en).

localestring nullable

Locale for formatting based on the language (optional, will be set internally if not set)

currencystring required

ISO4217 3-letter currency code (e.g. GBP).

distanceUnit1 | 2 | 3

Enumerator defining unit of distance:<br>1=KM, 2=Miles, 3=NauticalMiles

nationalitystring required

ISO3166 2-letter nationality country code (e.g. GB).

customerIPstring required

IPv4 or IPv6 of the end customer browser.

customerUserAgentstring required

User agent string of the end customer browser, or if server-to-server provide your application name and version (e.g. MyAppName/v1.0).

customerCountrystring nullable

ISO3166 2-letter country code of where the customer is located (optional, will be set internally if not set)

sourceobject nullable

Source data can be used to track any source data for linking to a booking

originListIdinteger nullable

Origin list identifier

destinationListIdinteger nullable

Destination list identifier

tripType0 | 1 | 2

Enumerator defining type of trip customer is taking:<br>0=Unspecified, 1=Personal, 2=Business

Example request

{
  "language": "en",
  "currency": "GBP",
  "nationality": "GB",
  "customerIP": "127.0.0.1",
  "customerUserAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0",
  "flightSearchCriteria": {
    "freeBaggageOnly": true,
    "flexibleDates": true,
    "carrier": "BA",
    "legs": [
      {
        "originCode": "LON",
        "destinationCode": "AGP",
        "departDate": "2020-10-30"
      }
    ],
    "passengers": [
      {
        "age": 12,
        "typeCode": "J10"
      }
    ]
  },
  "railSearchCriteria": {
    "originCode": "LON",
    "destinationCode": "MAN",
    "departDateTime": "2024-10-30T07:00",
    "returnDateTime": "2024-10-30T18:30",
    "passengers": [
      {
        "age": 12,
        "typeCode": "J10"
      }
    ]
  },
  "accommodationSearchCriteria": {
    "locations": [
      {
        "latitude": 51.52831,
        "longitude": -0.3817765,
        "radius": 5
      }
    ],
    "latitude": 51.52831,
    "longitude": -0.3817765,
    "radius": 5,
    "checkinDate": "2020-10-20",
    "checkoutDate": "2020-10-27",
    "propertyName": "Hilton",
    "rooms": [
      {
        "guests": [
          {
            "age": 12,
            "typeCode": "J10"
          }
        ]
      }
    ]
  },
  "tourSearchCriteria": {
    "latitude": 51.52831,
    "longitude": -0.3817765,
    "radius": 5,
    "startDateMin": "2020-02-07",
    "startDateMax": "2020-02-10",
    "durationMin": 1,
    "durationMax": 1
  },
  "ticketSearchCriteria": {
    "latitude": 51.52831,
    "longitude": -0.3817765,
    "radius": 5,
    "startDate": "2020-02-07",
    "endDate": "2020-02-10",
    "participants": [
      {
        "age": 12,
        "typeCode": "J10"
      }
    ]
  },
  "carRentalSearchCriteria": {
    "pickupLatitude": 51.52831,
    "pickupLongitude": -0.3817765,
    "pickupAirportTerminal": "3",
    "outboundFlightNo": "BA123",
    "dropoffLatitude": 51.52831,
    "dropoffLongitude": -0.3817765,
    "dropoffAirportTerminal": "3",
    "returnFlightNo": "BA234",
    "startDateTime": "2020-02-07T12:30",
    "endDateTime": "2020-02-14T14:00",
    "driverAge": 30,
    "promos": [
      {
        "companyCode": "BA",
        "reference": "ABC123",
        "surname": "Bloggs"
      }
    ]
  },
  "transferSearchCriteria": {
    "point1Latitude": 50.719475,
    "point1Longitude": -1.8813264,
    "point1Name": "Hilton, Bournemouth",
    "point1CountryCode": "GB",
    "point2Latitude": 51.470024,
    "point2Longitude": -0.4564842,
    "point2Name": "LHR",
    "point2CountryCode": "GB",
    "outPickupDateTime": "2020-02-10T14:30",
    "returnPickupDateTime": "2020-02-17T09:00",
    "passengers": [
      {
        "age": 12,
        "typeCode": "J10"
      }
    ],
    "additionalCriteria": {
      "originAirport": "LHR",
      "destinationAirport": "BCN",
      "outCarrier": "BA",
      "outFlightNo": "BA001",
      "retCarrier": "BA",
      "retFlightNo": "BA002"
    }
  },
  "airportExtrasSearchCriteria": {
    "originCode": "LGW",
    "originTerminal": "N",
    "destinationCode": "BCN",
    "destinationTerminal": "1",
    "outboundFlightDateTime": "2020-02-07T10:00",
    "outboundFlightNo": "BA123",
    "returnFlightDepartDateTime": "2020-02-14T13:00",
    "returnFlightArrivalDateTime": "2020-02-14T15:30",
    "returnFlightNo": "BA234",
    "passengers": [
      {
        "age": 12,
        "typeCode": "J10"
      }
    ]
  },
  "packageHolidaySearchCriteria": {
    "originCode": "LGW",
    "latitude": 51.52831,
    "longitude": -0.3817765,
    "radius": 5,
    "destinationCode": "PMI",
    "departDate": "2020-02-07",
    "rooms": [
      {
        "guests": [
          {
            "age": 12,
            "typeCode": "J10"
          }
        ]
      }
    ]
  },
  "visaSearchCriteria": {
    "residency": "GB",
    "country": "US"
  },
  "insuranceSearchCriteria": {
    "residency": "GB",
    "region": "US",
    "startDate": "2020-02-07",
    "endDate": "2020-02-14",
    "travellers": [
      {
        "age": 12,
        "typeCode": "J10"
      }
    ],
    "additionalCriteria": {
      "originAirport": "LHR",
      "originCountryCode": "LHR",
      "destinationAirport": "BCN",
      "operatingCarrier": "BA",
      "marketingCarrier": "BA"
    }
  },
  "extrasSearchCriteria": {
    "latitude": 51.52831,
    "longitude": -0.3817765,
    "radius": 5,
    "startDate": "2020-02-07",
    "endDate": "2020-02-10",
    "participants": [
      {
        "age": 12,
        "typeCode": "J10"
      }
    ],
    "additionalCriteria": {
      "originAirport": "LHR",
      "originCountryCode": "LHR",
      "destinationAirport": "BCN",
      "operatingCarrier": "BA",
      "marketingCarrier": "BA"
    }
  },
  "cruiseSearchCriteria": {
    "startDate": "2020-02-07",
    "endDate": "2020-02-10",
    "travellers": [
      {
        "age": 12,
        "typeCode": "J10"
      }
    ]
  },
  "multiCitySearchCriteria": {
    "originCode": "LON",
    "departureDate": "2020-10-20",
    "freeBaggageOnly": true,
    "carrier": "BA",
    "steps": [
      {
        "latitude": 51.52831,
        "longitude": -0.3817765,
        "radius": 5,
        "locationCode": "AGP"
      }
    ],
    "rooms": [
      {
        "guests": [
          {
            "age": 12,
            "typeCode": "J10"
          }
        ]
      }
    ]
  }
}

Response

Success - returns the newly created search information.

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.