Transfers

Marks an in-transit standalone transfer failed (the Details page's "Mark as Failed").

Requires ManageTransfers and an Idempotency-Key header; no body. Only a standalone transfer in InTransit. Its units keep their current location and their in-transit flags are cleared; the transfer becomes Failed. To record that only some lines failed, complete the transfer with failedLines instead.

post/api/v1/transfers/{id}/fail

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/transfers/{id}/fail
  • Auth: HTTP bearer

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

Response

Transfer id and confirmation message.

idinteger

Id of the resource the operation acted on (e.g. the job id).

messagestring nullable

Human-readable confirmation from the service (e.g. "Job started."). May be null.

warningstring nullable

Non-fatal problem encountered while completing the operation (e.g. a notification email that could not be sent). Null when there was none.

Changes

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