Skip to content

Get booking by id

GET/bookings/{id}

Auth: X-API-Key headerhttps://warpdrive.staging.transferz.com/partners

Retrieves a previously created booking including associated journeys

Returns a booking with all its journeys, including each journey's status, driver and price. There is no search or list for bookings: store the booking id from Create booking.

Guides: Create a booking, Pay for a booking

Path parameters

  • idinteger · int64required

    The id of the booking to retrieve

Headers

  • X-Request-IDstring

    The optional (ideally unique) request identifier used for later analysis or diagnostics

Responses

OK

  • idinteger · int64

    Booking id. Store it; there is no search for bookings.

  • codestring

    Booking reference shown to the traveller.

  • partnerReferencestring
  • partnerIdinteger · int64
  • travelIntentenum
    BUSINESS
    Business travel.
    LEISURE
    Leisure travel.
    UNKNOWN
    Not known.
  • bookerInfoobject
  • journeysarray of objects

    The journeys in this booking, one per booked quote.

Errors this endpoint can return

  • When: The booking belongs to another partner.

    What to do: Check that the id belongs to your company and that you use the key of the right user. Ask Transferz to check the account's permissions if the id is correct.