SalesOrders

Picks one more unit of a line (the Fulfill page's per-line "Pick").

Requires ManageSalesOrders and an Idempotency-Key header; no body. Adds 1 to the line's quantityPicked — a line-level count only: no stock unit or transfer changes (the transfer scan flow is /pick). Refused once the line is picked in full. orderComplete says whether every line is now picked.

post/api/v1/sales-orders/{id}/lines/{lineId}/pick

Request

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

Path parameters

idinteger required

Sales-order id. Example: 318.

lineIdinteger required

Line id. Example: 1502.

Response

Picked; 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.