Skip to content

Get journey by id

GET/journeys/{journeyId}

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

Retrieves a previously created journey

Returns one journey: status, pickup time, locations, traveller, assigned transfer company, meeting point, driver and vehicle. Use it after a webhook event to refresh the journey, or to show the traveller who will pick them up.

Guides: Follow a journey, How a booking works, Cancellations

Path parameters

  • journeyIdinteger · int64required

    The id of the journey to retrieve

Headers

  • X-Request-IDstring

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

Responses

OK

  • idinteger · int64

    Journey id (journeyId in webhook events).

  • codestring

    Journey reference shown to the traveller and the driver.

  • quoteIdinteger · int64

    The quote this journey was booked from.

  • vehicleCategoryenum
    SEDAN
    Standard car for up to 3 passengers with luggage.
    STATIONWAGON
    Estate car with extra luggage space.
    SUV
    Sport utility vehicle.
    MINIVAN
    People carrier for up to 6–7 passengers.
    BUSINESS_LIMOUSINE
    Deprecated business category; use BUSINESS_SEDAN.
    BUSINESS_SEDAN
    Business-class sedan.
  • pickupTimeAdjustmentMethodenum

    Whether and how the pickup time follows the flight.

    PENDING
    Not decided yet.
    NONE
    The pickup time is not adjusted.
    FLIGHT_TRACKING
    The pickup time follows the tracked flight.
    MANUAL
    The pickup time is adjusted by hand.
  • originobject
  • destinationobject
  • pickupobject

    The pickup time.

  • transferCompanyobject

    The transfer company performing the journey, once assigned.

  • driverobject

    The driver and vehicle, once assigned.

  • meetingPointobject

    Where the driver meets the traveller.

  • approxDurationAndDistanceobject

    Expected distance and driving time.

  • travellerobject
  • travelAddonsarray of objects
  • statusenum

    Current status of the journey.

    NOT_PAID
    The booking exists but has not been paid; the journey is not yet sent to a transfer company.
    AWAITING_APPROVAL
    Paid, waiting for an internal Transferz approval before it is processed.
    PENDING
    Paid and being processed; Transferz is looking for a transfer company.
    CONFIRMED
    A transfer company has been assigned and confirmed the journey.
    PLANNED
    A driver has been assigned.
    DRIVER_UNDERWAY
    The driver is on the way to the pickup point.
  • cancellationDetailsobject

    Whether and until when the journey can be cancelled for free.

  • priceSummaryobject

    The price of the journey.

  • customerServiceInfoobject

    Transferz customer service contact for this journey.

  • travellerAppUrlstring

    Link to the traveller page where the traveller can follow the journey.

Errors this endpoint can return

  • When: The journey 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.

Certification case

Certification case

Certification case

Certification case

Certification case

Certification case

Guide

Guide

Guide