Transfers

Completes (receives) an in-transit standalone transfer ("Complete Transfer"), optionally with lines that did not arrive.

Requires ManageTransfers and an Idempotency-Key header. Body optional: { "failedLines": [ { "lineId": 911, "reason": "Damaged in transit" } ] } marks those lines failed first (the app's per-line "Mark as Failed"); they stay where they are and end Returned. Every other unit moves to its line's destination, its in-transit flag is cleared, quantityDelivered is recorded and the transfer becomes Completed (the transfer.completed webhook fires). Only standalone transfers in an in-transit status (InTransit, InTransitToWaypoint, AtWaypoint, InTransitToDestination) can be completed; job-site and sales-order transfers are completed from their job or order.

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

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

Request body

Response

Transfer id and confirmation message (e.g. Transfer completed.).

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.