GET/v1/transfers/reservations/by-confirmation/:confirmationNumber

Get reservation by confirmation number

Read a reservation when the confirmation number is the identifier you have.

Share
GET/v1/transfers/reservations/by-confirmation/:confirmationNumber

API console

Try it

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

Credentials

Log in to pick from your saved API keys instead of pasting them.

Path parameters

1 field

Confirmation number

Confirmation number returned when the booking was created. On the unified details endpoint, send only one of reservationId, confirmationNumber or searchId.

Query parameters

3 fields

GDS provider

Transfer content selector. Currently only 0.

Currency

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

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-confirmation/:confirmationNumber?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 when the confirmation number is the identifier you have.

Authentication and headers

HeaderDescription
AuthorizationBearer <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>.
LANGPreferred locale header. Accept-Language is also supported.
Content-Typeapplication/json for requests with a JSON body.

Request

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

Request Params Schema

confirmationNumber
stringYes
Confirmation number returned when the booking was created.

Request Query Params Schema

gdsprovider
enum
0
Yes
Transfer content selector. Currently 0.
currency
enum
EURUSDINRCHFJPYGBPAUDCADCNYSGDNZDMXN
No
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
No
Legacy field. Prefer the LANG or Accept-Language header.

Success response

Returns the same reservation envelope as the unified details endpoint.

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
No
reservations[]selectedScheduleIndex
numberNo
reservations[]departureDatetime
string
Format: ISO 8601
No
reservations[]arrivalDatetime
string
Format: ISO 8601
No
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
No
reservations[]selectedAmenities[]pngImageUrl
string
Format: URL
No
reservations[]selectedAmenities[]inputType
enum
booleannumeric
No
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
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.",
      "departureDatetime": "2026-08-16T14:40:00-04:00",
      "arrivalDatetime": "2026-08-16T15:06:00-04:00",
      "selectedAmenities": []
    }
  ]
}

Errors

HTTPCodeMeaningRecommended action
400The body, query or path is invalid, or contains an unknown property.Fix the request using the message array.
400transfer_invalid_currencyThe currency is outside the supported list.Use a supported currency.
400transfer_invalid_languageThe requested language is not supported.Use one of the documented language values.
429transfer_provider_errorThe service is temporarily rate limited.Retry with exponential backoff.
502transfer_provider_errorThe request could not be completed.Do not assume success. Keep your identifiers and read the reservation when the operation could have been created.
400transfer_currency_mismatchThe 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.
503The price could not be confirmed right now.Retry later. Do not book and do not charge the traveller.

Usage notes

Reservations that include selected amenities are returned in full only by the search-ID endpoint. Use this alias for reservations without amenities, or when the confirmation number is all you have.

cURL example

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