Skip to content

Create journey change

POST/journeys/{journeyId}/changes

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

Creates a change to an existing journey and applies it if no additional payment is required

Changes a journey: pickup time, traveller details, passengers and luggage, the non-hub address, or add-ons. Transferz reprices the journey. If the price does not go up the change is applied immediately (additionalPaymentRequired false). If it goes up, the change waits for payment: pay it on invoice or with a payment link using the returned changeId.

Only the hub end is fixed

For a journey from the airport only the destination can change; for a journey to the airport only the origin.

Guide: Change a journey

Path parameters

  • journeyIdinteger · int64required

    The id of the journey to change

Headers

  • X-Request-IDstring

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

Request body

application/json · required

  • pickupDatestring · date-time

    New pickup time, local to the pickup location.

  • travellerInfoobject

    New traveller details, passengers and luggage.

  • originobject

    New pickup address (only when the origin is not the hub).

  • destinationobject

    New drop-off address (only when the destination is not the hub).

  • travelAddonsarray of objects

    The full new list of add-ons.

Responses

OK

  • changeIdinteger · int64

    Id of the change, to pay for it when needed.

  • additionalPaymentRequiredboolean

    True when the change costs more and waits for payment; false when it was applied.

  • previousPriceobject

    Price before the change.

  • newPriceobject

    Price after the change.

Errors this endpoint can return

  • When: Nothing in the request changes the journey.

    What to do: Send at least one of pickupDate, travellerInfo, origin, destination or travelAddons.

  • When: The journey has started, is completed or is cancelled.

    What to do: Check the journey status with Get journey before changing it.

  • 400, failedINVALID_LOCATION

    When: The change moves the hub end of the journey.

    What to do: Use another location, or change only the address that is not the hub.

  • When: Too close to pickup to change the journey.

    What to do: Contact Transferz customer service for changes this close to pickup.

  • When: No price could be calculated for the new details.

    What to do: Try a different time or address, or cancel and book again.