Accept offer
/offers/{id}/acceptAuth: X-API-Key headerhttps://warpdrive.staging.transferz.com/transfercompanies
Accepts an available offer
Accepts an offer. The journey is assigned to your company and returned in full, including the traveller's details; a journeyFleetAssignedEvent follows. When meetingPointRequired is true, send the id and type of one of the offer's meeting points. Accepting an offer you already accepted succeeds again with 200 and the journey, so a retry after a timeout is safe.
Path parameters
Headers
Request body
application/json
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
- 400, failedOFFER_MISSED
When: Another company accepted the journey first.
What to do: Remove the offer from your list; an offerStatusChangedEvent with MISSED is sent too.
- 400, failedOFFER_EXPIRED
When: The offer expired.
What to do: Respond to offers before
expiry. - 400, failedOFFER_FINALIZED
When: You already declined the offer.
What to do: Check the offer status with Get offer before responding.
- 400, failedINVALID_MEETING_POINT
When: A meeting point is required and none (or an unknown one) was sent.
What to do: Send a meetingPointId from the offer's meetingPoints with its type.