Skip to content

Create action

POST/actions

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

Creates action for specified journey

Reports an event during the journey that Transferz must know about. Supported types: TRAVELLER_NO_SHOW (the traveller did not show up) and DRIVER_LEFT_PICKUP (the driver left after waiting). Send the driver's position; attach proof such as a photo with Upload attachment.

Guides: Report a no-show or a delay, Constants

Headers

  • X-Request-IDstring

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

Request body

application/json · required

  • journeyIdinteger · int64

    The journey the action is about.

  • typeenum

    What happened. Supported are TRAVELLER_NO_SHOW and DRIVER_LEFT_PICKUP.

    DRIVER_DELAYED
    The driver will be late.
    TRAVELLER_NO_SHOW
    The traveller did not show up at the pickup point.
    ADDITIONAL_PROOF_TRAVELLER_NO_SHOW
    Extra proof for an earlier no-show report.
    DRIVER_LEFT_PICKUP
    The driver left the pickup point after waiting.
  • positionobject

    Where the driver was.

Responses

OK

  • idinteger · int64
  • journeyIdinteger · int64
  • createdstring · date-time
  • updatedstring · date-time
  • typeenum
    DRIVER_DELAYED
    The driver will be late.
    TRAVELLER_NO_SHOW
    The traveller did not show up at the pickup point.
    ADDITIONAL_PROOF_TRAVELLER_NO_SHOW
    Extra proof for an earlier no-show report.
    DRIVER_LEFT_PICKUP
    The driver left the pickup point after waiting.
  • attachmentFileIdsarray of integers · int64

    Ids of files attached with Upload attachment.

    Unique items

Errors this endpoint can return

  • 400, failedINVALID_REQUEST

    When: journeyId or type is missing.

    What to do: Read message, correct the request and send it again.

  • 500, failedUNKNOWN

    When: A type other than TRAVELLER_NO_SHOW or DRIVER_LEFT_PICKUP is sent (known issue).

    What to do: For 400, read message and correct the request. For 500, retry once; if it persists, contact Transferz support with the X-Request-ID you sent.

  • When: The journey is not assigned to your company (also returned for an unknown id).

    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.