Transfers

Starts a picked standalone transfer ("Mark as In Transit").

Requires ManageTransfers and an Idempotency-Key header; no body. The transfer must be a standalone transfer, Pending, not awaiting approval, and every line fully picked (POST /api/v1/transfers/{id}/pick). The transfer and its lines become InTransit and its units are flagged in transit until it is completed or failed.

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

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

Response

Transfer id and confirmation message (Transfer is in transit.).

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.