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, Cancel a journey or a booking
Path parameters
Headers
Responses
OK
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.
Errors this endpoint can return
- 403, failedINSUFFICIENT_PERMISSIONS
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.