BookingFlow

Polls for the status of a search session and returns available results.

get/search/{searchId}/{searchKey}/{accommodation}

Path parameters

searchIdinteger required

Numeric search Id.

searchKeystring required

36-character search security key.

accommodationstring required

Optional accommodation identifier to only return a single accommodation result - only used for certain widgets.

Query parameters

reloadAllboolean

Optional parameter to re-return all available results, even if they have been previously returned.

returnAllDataboolean

Optional parameter to return a full set of result data (if false the response will be reduced to important data only).

returnPrivateDataboolean

Optional parameter to return private supplier data (defaulted to true for private API connections).

interactSessionstring

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

productType1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20

Enumerator defining product types:<br>1=Flights, 2=Accommodation, 3=Packages, 4=TicketsAttractions, 5=Transfers, 6=AirportExtras, 7=Insurance, 8=CarRental, 9=Visas, 10=Tours, 11=Tracking, 12=Itinerary, 13=PaymentService, 14=CRM, 15=Extras, 16=DynamicPackage, 17=Rail, 18=Generic, 19=Cruise, 20=TicketPackage

Optional product type to only return results matching the criteria. Do not send in for all products.

versioninteger

Version of processing engine (default 2, recommend leaving as default).

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.