BookingFlow

Retrieves the search criteria of a search by the search/web reference.

Changed on
get/searchcriteria/{searchRef}

Request

Path parameters

searchRefstring required

Search reference identifier.

Query parameters

bookStage1 | 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

Optional booking stage (default: Search).

Response

OK

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.

dataunknown
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

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///////// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the ///////// response property for the response status

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///////// response property for the response status

    • warning

      added the new 192.00 enum value to the /////////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /////////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the ///////// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the ///////// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the //////// response property for the response status

    • warning

      added the new 192.00 enum value to the ////// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 192.00 enum value to the ///// response property for the response status

    • warning

      added the new 192.00 enum value to the /////// response property for the response status

    • warning

      added the new 192.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///////// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the ///////// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///////// response property for the response status

    • warning

      added the new 193.00 enum value to the /////////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /////////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the ///////// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the ///////// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the //////// response property for the response status

    • warning

      added the new 193.00 enum value to the ////// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • warning

      added the new 193.00 enum value to the ///// response property for the response status

    • warning

      added the new 193.00 enum value to the /////// response property for the response status

    • warning

      added the new 193.00 enum value to the /// response property for the response status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status