SalesOrders

Finishes picking a transfer (the scan dialog's "Complete"): the transfer leaves the warehouse (In Transit).

Requires ManageSalesOrders and an Idempotency-Key header. Body optional: { "transferId": 904 }; omitted = the order's single Pending transfer. Every line of the transfer must be fully picked (/pick). The transfer becomes InTransit, the history records "Transfer dispatched (via API key '…')" and the order's status is recalculated — Packed once every line is picked and covered. Stock stays reserved to the transfer until /deliver.

post/api/v1/sales-orders/{id}/complete-pick

Request

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

Path parameters

idinteger required

Sales-order id. Example: 318.

Request body

transferIdinteger nullable

The order's transfer to act on. Omit when the order has exactly one transfer in the state the step needs (Pending for complete-pick, in transit for deliver). Example: 904.

Response

Transfer in transit; the recalculated order status.

salesOrderIdinteger

The sales order's id. Example: 318.

statusstring

Order status after the step: Pending, Picking, Packed, Shipped, Delivered, Complete or Cancelled. Recalculated from the order's transfers, so always read it rather than assuming the next status. Example: Packed.

fulfillmentStatusstring nullable

Aggregate status of the order's transfers (None, Pending, InTransit, AtWaypoint, Completed, Cancelled…), as fulfillmentStatus on the order. Example: InTransit.

transferIdinteger nullable

The transfer the step acted on (resolved when the request did not name one); null for /complete and /cancel. Example: 904.

messagestring nullable

Human-readable confirmation, as the app shows it. Example: Transfer status updated to In Transit.

unitsPickedinteger

/pick: units marked picked by this call (0 for other steps). Example: 10.

itemsReturnedinteger

/cancel: delivered units returned to inventory (0 for other steps). Example: 0.

transfersCancelledinteger

/cancel: transfers cancelled (0 for other steps). Example: 1.

Changes

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