Transfers

Transfers overview

Understand the Transfers API surface, its response conventions, and the endpoint catalog.

Share

Understand the Transfers API surface, its response conventions, and the endpoint catalog.

Base path

Every operation lives under /v1/transfers and requires API credentials.

text
text
https://api.sandbox.travelandz.com/v1/transfers

Content types

Send Content-Type: application/json on any request with a body. Streaming endpoints require Accept: text/event-stream.

Success codes

OperationHTTP
Reads200 OK
Pricing200 OK
Booking and changes200 OK
Cancellation200 OK
Stream connection established200 OK

Creating a reservation answers 200, not 201. The response carries a status field, because a reservation is not always confirmed by the time the request returns. Read [Booking a transfer](/docs/transfers-book) for the three states you must handle.

Unknown properties in a body or query are rejected with 400.

Endpoint catalog

MethodPathPurpose
POST/v1/transfers/searchSearch transfer offers.
GET/v1/transfers/amenitiesList the amenity catalog.
POST/v1/transfers/pricingConfirm the final price of an offer.
POST/v1/transfers/bookCreate a reservation.
GET/v1/transfers/reservations/detailsRead a reservation by any identifier.
GET/v1/transfers/reservations/by-confirmation/:confirmationNumberRead a reservation by confirmation number.
GET/v1/transfers/reservations/by-search/:searchIdRead a reservation by search ID.
GET/v1/transfers/reservations/:reservationIdRead a single reservation.
POST/v1/transfers/reservations/changes/searchSearch replacement offers.
POST/v1/transfers/reservations/changesConfirm a reservation change.
POST/v1/transfers/flights/verifyCheck a flight against the pickup time.
GET/v1/transfers/flightsLook up a flight.
GET/v1/transfers/reservations/:reservationId/vehicleRead driver and vehicle.
GET/v1/transfers/reservations/:reservationId/vehicle/streamStream driver and vehicle.
GET/v1/transfers/tracking/:reservationId/events/latestRead the latest tracking event.
GET/v1/transfers/tracking/:reservationId/events/streamStream tracking events.
DELETE/v1/transfers/reservations/:reservationIdCancel a reservation.

Integration checklist

  1. Persist searchId, resultId, bookingToken, pricingToken, reservationId, confirmationNumber and your own partnerTrackingId.
  2. Charge only the finalPrice.amount returned by pricing.
  3. Never rebuild a price from a search response or from amenity data.
  4. Treat 409 transfer_price_changed as a mandatory new quote.
  5. Treat 502 as a failed request, then read the reservation before creating another one.
  6. Read reservations that include amenities by searchId.
  7. Retry 429 and temporary network failures with exponential backoff.
  8. Close stream connections explicitly when you no longer need them.
  9. Never log tokens, payment data or traveller personal data on the client.