Transfers

Scans a barcode into a transfer (the scan dialog): one more unit picked on the matching line.

Requires ManageTransfers and an Idempotency-Key header (use a new key per scan — a replayed key does not scan again). Body: { "barcode": "0012345678905", "locationId": 1 }. The barcode may be a unit's barcode or an item template's; the first line of that item (at locationId when given) that is not fully picked gets one more picked unit. Same state rule as …/lines/{lineId}/pick.

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

Request

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

Path parameters

idinteger required

Transfer id from /api/v1/transfers.

Request body

barcodestring required

The scanned value, 1–200 characters: an item (unit) barcode or an item template barcode. Example: 0012345678905.

locationIdinteger nullable

Optional: only lines whose units are at this location id (lines are grouped by the units' location, as in the app's scan dialog). Omit to match any line. Example: 1.

Response

Transfer id and the matched line's progress (e.g. Scanned Copper 12/2: line 1207 has 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.