SalesOrders

Picks one unit by barcode (the Fulfill page's scanner).

Requires ManageSalesOrders and an Idempotency-Key header. Body: { "barcode": "0012345678905" }. A stock unit's barcode picks the line pinned to that unit; otherwise a catalog item's barcode picks the order's line for that item. The line's quantityPicked rises by 1 — a line-level count only, no stock or transfer changes.

post/api/v1/sales-orders/{id}/scan

Request

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

Path parameters

idinteger required

Sales-order id. Example: 318.

Request body

barcodestring required

The scanned value: a stock unit's barcode or a catalog item's barcode, 1–200 characters. Example: 0012345678905.

Response

Picked; the matched line's quantities and name.

salesOrderIdinteger

The sales order's id. Example: 318.

lineIdinteger nullable

The line picked; null for /lines/pick-all. Example: 1502.

itemNamestring nullable

The picked item's name; null for /lines/pick-all. Example: Copper 12/2 Romex.

quantityPickednumber double

The line's picked quantity after the call (0 for /lines/pick-all). Example: 3.

quantityOrderednumber double

The line's ordered quantity (0 for /lines/pick-all). Example: 10.

orderCompleteboolean

/scan, /lines/{lineId}/pick, /lines/pick-all: every line of the order is now picked in full. Always false for picked-quantity. Example: false.

linesUpdatedinteger

/lines/pick-all: lines raised to their ordered quantity (0 = all were already picked). Example: 2.

unitsAddednumber double

/lines/pick-all: units added across those lines. Example: 7.

statusstring

The order's status after the call (line picks never change it). Example: Picking.

messagestring nullable

Human-readable confirmation, as the app shows it; null for a single scan / pick. Example: Picking progress saved.

Changes

No recorded changes to this operation across all 1 revision of this API.