Transfers

Reduces the number of units one line moves.

Requires ManageTransfers and an Idempotency-Key header. Body: { "quantity": 2 }. A line can only shrink (1 up to its current quantity): it keeps its first units, the others are released and become available again, and quantityPicked is capped at the new quantity. To move more, create another transfer — growing a line could cross the approval threshold. Only on a standalone transfer that is Pending and not awaiting approval, and only for a line that carries stock units.

patch/api/v1/transfers/{id}/lines/{lineId}

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

lineIdinteger required

Line id (lines[].id).

Request body

quantityinteger

New number of units, 1 up to the line's current quantity (a line can only shrink; the other units are released). Example: 2.

Response

Transfer id and confirmation (e.g. Line quantity reduced from 3 to 2; 1 unit(s) released.).

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.