GET/v1/transfers/reservations/by-search/:searchId

Get reservation by search ID

Read a reservation that includes selected amenities.

GET/v1/transfers/reservations/by-search/:searchId

API console

Try it

Send a real request to the sandbox API and inspect the response.

Credentials

Profile code

Public key

Secret key

Path parameters

1 field

searchIdstringRequired

Search ID

Search identifier used to create the booking. Required for reservations that include amenities. On the unified details endpoint, send only one of reservationId, confirmationNumber or searchId.

Query parameters

3 fields

gdsproviderenumRequired

GDS provider

Transfer content selector. Currently only 0.

currencystring ISO 4217Optional

Currency

Currency of the returned amounts. Must match the offer or reservation when one already exists.

languagestringOptional

Language

Legacy language field. Prefer the LANG or Accept-Language header.

cURL request

cURL

bash

curl -X GET 'https://api.sandbox.travelandz.com/v1/transfers/reservations/by-search/:searchId?gdsprovider=0&currency=USD' \
  -H 'Authorization: Bearer YOUR_SECRET_KEY' \
  -H 'X-Travelandz-Id: YOUR_PUBLIC_KEY:YOUR_PROFILE_CODE'

Add your credentials to send a request.

This request needs identifiers or tokens from an earlier call. Run the previous step first, then paste its values here.

Response

Click "Try it!" to send a request and see the response here.

Read a reservation that includes selected amenities.

Authentication and headers

Header	Description
`Authorization`	`Bearer <secret_key>`. Keep the secret on the server and never write it to client logs.
`X-Travelandz-Id`	`<public_key>:<profile_code>`, where the persisted profile code has the form `dp_<12 alphanumeric>`.
`LANG`	Preferred locale header. `Accept-Language` is also supported.
`Content-Type`	`application/json` for requests with a JSON body.

Request

This endpoint takes no body. searchId goes in the path and gdsprovider in the query.

Request Params Schema

searchId

stringYes

Search identifier used to create the booking.

Request Query Params Schema

gdsprovider

enum

0

Yes

Transfer content selector. Currently 0.

currency

enum

EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN

Lowercase values are accepted and normalized. Defaults to USD on a new search and is inherited afterwards.

language

enum

en-USes-ESde-DEfr-FRpt-BRzh-CNit-IT

Legacy field. Prefer the LANG or Accept-Language header.

Success response

Returns the reservation envelope with selectedAmenities fully populated.

Response Body Schema

status

enum

completedpendingfailed

Yes

completed

booleanYes

Treat the operation as confirmed only when this is true and reservations is not empty.

timedOut

booleanYes

True when a final state was not reached in time.

reservations

arrayYes

reservations[]gdsprovider

enum

0

Yes

reservations[]reservationId

stringYes

Persist this value; reservation reads and cancellation need it.

reservations[]confirmationNumber

stringNo

Traveller-facing confirmation code.

reservations[]status

enum

completedpendingfailed

Yes

reservations[]cancelled

booleanYes

reservations[]totalAmount

numberYes

Total charged for the reservation.

reservations[]currency

enum

EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN

Yes

reservations[]pickupInstructions

stringNo

reservations[]ticketUrl

string

Format: URL

reservations[]selectedScheduleIndex

numberNo

reservations[]departureDatetime

string

Format: ISO 8601

reservations[]arrivalDatetime

string

Format: ISO 8601

reservations[]selectedAmenities

arrayYes

reservations[]selectedAmenities[]key

stringYes

Value to send in selectedAmenities.

reservations[]selectedAmenities[]name

stringYes

Localized name.

reservations[]selectedAmenities[]description

stringNo

reservations[]selectedAmenities[]imageUrl

string

Format: URL

reservations[]selectedAmenities[]pngImageUrl

string

Format: URL

reservations[]selectedAmenities[]inputType

enum

booleannumeric

reservations[]selectedAmenities[]included

booleanYes

True when the amenity is already part of the offer.

reservations[]selectedAmenities[]selectable

booleanYes

True when the amenity can be added to this offer.

reservations[]selectedAmenities[]selected

booleanYes

True when the amenity is part of the priced selection.

error

stringNo

Present when status is failed.

metadata

objectYes

metadatauseSearchIdForDetails

booleanYes

True when reservation details must be read with searchId instead of reservationId.

metadatadetailsIdentifier

enum

reservationIdsearchId

Yes

Identifier to use when reading the reservation.

metadatadetailsSearchId

stringNo

Present when detailsIdentifier is searchId.

metadatamessage

stringNo

Response examples

json

{
  "status": "completed",
  "completed": true,
  "timedOut": false,
  "reservations": [
    {
      "gdsprovider": 0,
      "reservationId": "f390daff1fdf4cccb19b7abd825dc011",
      "confirmationNumber": "TZ-6202191",
      "status": "completed",
      "cancelled": false,
      "totalAmount": 181.97,
      "currency": "USD",
      "pickupInstructions": "The driver will call you when he arrives.",
      "selectedScheduleIndex": 0,
      "departureDatetime": "2026-08-16T14:40:00-04:00",
      "arrivalDatetime": "2026-08-16T15:06:00-04:00",
      "selectedAmenities": [
        {
          "key": "baby_seats",
          "name": "Baby seats",
          "description": "Your vehicle will have a child safety seat to keep children under age 4 safe.",
          "imageUrl": "https://api.sandbox.travelandz.com/v1/assets/transfers/images/0/amenities/baby-seats.svg",
          "pngImageUrl": "https://api.sandbox.travelandz.com/v1/assets/transfers/images/0/amenities/baby-seats.png",
          "inputType": "numeric",
          "included": false,
          "selected": true,
          "selectable": true
        },
        {
          "key": "child_booster",
          "name": "Child booster",
          "description": "Your vehicle will have a child booster seat to keep children from age 4-8 safe.",
          "imageUrl": "https://api.sandbox.travelandz.com/v1/assets/transfers/images/0/amenities/child-booster.svg",
          "pngImageUrl": "https://api.sandbox.travelandz.com/v1/assets/transfers/images/0/amenities/child-booster.png",
          "inputType": "numeric",
          "included": false,
          "selected": true,
          "selectable": true
        }
      ]
    }
  ]
}

Errors

HTTP	Code	Meaning	Recommended action
`400`		The body, query or path is invalid, or contains an unknown property.	Fix the request using the `message` array.
`400`	`transfer_invalid_currency`	The currency is outside the supported list.	Use a supported currency.
`400`	`transfer_invalid_language`	The requested language is not supported.	Use one of the documented language values.
`429`	`transfer_provider_error`	The service is temporarily rate limited.	Retry with exponential backoff.
`502`	`transfer_provider_error`	The request could not be completed.	Do not assume success. Keep your identifiers and read the reservation when the operation could have been created.
`400`	`transfer_currency_mismatch`	The currency does not match the offer, the quote or the reservation.	Reuse the currency returned by the previous step, or omit the field to inherit it.
`503`		The price could not be confirmed right now.	Retry later. Do not book and do not charge the traveller.

Usage notes

This is the recommended endpoint for any reservation created with amenities. Keep the searchId you used to book so the reservation stays readable later.

cURL example

bash

curl --request GET \
  --url "https://api.sandbox.travelandz.com/v1/transfers/reservations/by-search/73a5670b476649a985f0535db1077c05?gdsprovider=0&currency=USD" \
  -H "Authorization: Bearer $TRAVELANDZ_SECRET_KEY" \
  -H "X-Travelandz-Id: $TRAVELANDZ_PUBLIC_KEY:$TRAVELANDZ_PROFILE_CODE"