TRtransferz
Journeys

Cancel journey

Cancels a previously created journey

post/journeys/{journeyId}/cancel

Request

  • Base URL
    https://warpdrive.staging.transferz.com/partners
  • URL
    https://warpdrive.staging.transferz.com/partners/journeys/{journeyId}/cancel
  • Auth
    API key in header X-API-Key

Path parameters

journeyIdinteger required

The id of the journey to cancel

Headers

X-Request-IDunknown

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

Request body

reason'NOT_NEEDED_ANYMORE' | 'DRIVER_NO_SHOW' | 'NO_AVAILABILITY' | 'ADDRESS_INVALID' | 'INSUFFICIENT_TRAVELLER_DETAILS' | 'TECHNICAL_ISSUE' | 'TRAVELLER_NO_SHOW' | 'PRICE_CALCULATION_ERROR' | 'STRIKE_OR_ROAD_CLOSURE' | 'NO_FLIGHT_NUMBER' | 'ADD_ON_ISSUE' | 'CANT_FULFILL_CUSTOMER_REQUEST' | 'PAX_BAGS_CONFIGURATION' | 'FORCE_MAJEURE' | 'OTHER' required
acceptChargesboolean

Response

OK

idinteger
codestring
quoteIdinteger
vehicleCategory'SEDAN' | 'STATIONWAGON' | 'SUV' | 'MINIVAN' | 'BUSINESS_LIMOUSINE' | 'BUSINESS_SEDAN' | 'STRETCH_LIMOUSINE' | 'MINIBUS' | 'TOURING_CAR' | 'STANDARD_ELECTRIC_CAR' | 'EXCLUSIVE_MINIVAN' | 'LUXURY_SEDAN' | 'HIGH_END_ELECTRIC_CAR' | 'SHUTTLE' | 'ECONOMY_SEDAN' | 'HELICOPTER' | 'VAN' | 'BUS' | 'MPV' | 'COACH' | 'SPEEDY_SHUTTLE' | 'EVENT_SHUTTLE' | 'DIRECT_SHUTTLE'
pickupTimeAdjustmentMethod'PENDING' | 'NONE' | 'FLIGHT_TRACKING' | 'MANUAL'
status'NOT_PAID' | 'AWAITING_APPROVAL' | 'PENDING' | 'CONFIRMED' | 'PLANNED' | 'DRIVER_UNDERWAY' | 'DRIVER_ARRIVED' | 'JOURNEY_IN_PROGRESS' | 'COMPLETED' | 'CANCELLED_FREE' | 'CANCELLED_WITH_COSTS' | 'BOOKER_CANCELLED' | 'SUPPLIER_CANCELLED'
travellerAppUrlstring

Changes

No recorded changes to this operation across all 1 revision of this API.