Skip to content

Search journeys

GET/journeys

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

Retrieves a list of journeys based on the provided parameters for which an offer has been accepted

Lists the journeys assigned to your company, filtered and paged. Use it to build your planning and to reconcile after missed webhooks (for example everything updated since your last sync with updatedAfter). page starts at 0; size is at most 100.

Guides: Handle changes and cancellations, How a journey reaches you, Look up and search journeys

Query parameters

  • journeyIdinteger · int64

    Only the journey with this id.

  • bookingIdinteger · int64

    Only journeys of this booking.

  • bookingCodestring

    Only journeys of the booking with this reference.

  • journeyCodestring

    Only the journey with this reference.

  • driverCodestring

    Only the journey with this driver code.

  • pickupDateAfterstring · date-time

    Pickup at or after this time.

  • pickupDateBeforestring · date-time

    Pickup before this time.

  • assignedTransferCompanyIdarray of integers · int64

    Only journeys of these companies (when you manage several).

    Unique items

  • assignedFleetIdarray of integers · int64

    Only journeys of these fleets.

    Unique items

  • updatedBeforestring · date-time

    Changed before this time.

  • updatedAfterstring · date-time

    Changed at or after this time. Use it for incremental syncs.

  • createdBeforestring · date-time

    Created before this time.

  • createdAfterstring · date-time

    Created at or after this time.

  • includedStatusesarray of enums

    Only journeys in these statuses.

    Unique items

    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.
  • excludedStatusesarray of enums

    Leave out journeys in these statuses.

    Unique items

    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.
  • completedOnAfterstring · date-time

    Completed at or after this time.

  • completedOnBeforestring · date-time

    Completed before this time.

  • cancelledAfterstring · date-time

    Cancelled at or after this time.

  • cancelledBeforestring · date-time

    Cancelled before this time.

  • travellerEmailAddressstring

    Only journeys of the traveller with this email address.

  • travellerNamestring

    Only journeys of travellers with this name.

  • heldForComplaintboolean

    true for journeys held because of a complaint, false for the others.

  • hubCountrystring

    Only journeys whose hub is in this country (ISO 3166-1 alpha-2).

  • pageintegerrequired

    The page to return, starting at 0.

    Default: 0

  • sizeintegerrequired

    Results per page, at most 100.

    Default: 10

  • sortarray of enums

    Format: (property;direction). Direction - asc,desc. Multiple sort criteria are supported.

    id;asc
    id;desc
    pickup;asc
    pickup;desc
    created;asc
    created;desc
    status;asc
    status;desc

Headers

  • X-Request-IDstring

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

Responses

OK

  • paginationobject
  • resultsarray of objects

Errors this endpoint can return