Transfers

Removes picked units from one line (the scan dialog's unpick / reset).

Requires ManageTransfers and an Idempotency-Key header. Body optional: { "quantity": 1 } removes one picked unit; omit it to clear all of the line's picks. Same state rule as …/lines/{lineId}/pick. At 0 picked the line is no longer marked scanned.

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

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

lineIdinteger required

Line id (lines[].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: 1 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.