SalesOrders

Sets a line's picked quantity (the Details page's picked-quantity editor); lowering it unpicks and releases stock.

Requires ManageSalesOrders and an Idempotency-Key header. Body: { "quantityPicked": 3 }. Only while the order is Picking. Same code path as the app: raising the quantity claims that many more available units (the primary source location and already-opened bundles first) onto the order's live transfer — or creates a transfer for the uncovered remainder when there is none; lowering it takes units off the live transfers (secondary locations first), releases them to stock and cancels a transfer left empty. Over-picking is allowed. The order's updatedAt moves and a "Picking progress — X of Y unit(s) picked" entry is written; the status does not change. This is the line-level count; the transfer scan flow is /pick.

put/api/v1/sales-orders/{id}/lines/{lineId}/picked-quantity

Request

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

Path parameters

idinteger required

Sales-order id. Example: 318.

lineIdinteger required

Line id. Example: 1502.

Request body

quantityPickednumber double required

The line's new picked quantity, 0–1,000,000 (more than ordered is allowed, as in the app). Lower than now = unpick. Example: 3.

Response

Saved; the line's quantities.

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.