Transfers

Picks units of one line (the scan dialog's per-line pick).

Requires ManageTransfers and an Idempotency-Key header. Body optional: { "quantity": 2 } picks two more units; omit it to pick the rest of the line. Only on a standalone transfer that is Pending and not awaiting approval. The line's quantityPicked rises (never above quantity); once every line is fully picked the transfer can be started (POST …/start). POST …/pick picks every line at once.

post/api/v1/transfers/{id}/lines/{lineId}/pick

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

lineIdinteger required

Line id (lines[].id of GET /api/v1/transfers/{id}).

Request body

quantityinteger nullable

Whole units to pick (at most what is left to pick) or to unpick (at most what is picked), 1–1000; null = all. Example: 2.

Response

Transfer id and the line's progress (e.g. Line 1207: 2 of 3 picked.).

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.