SalesOrders

Marks a delivered sales order complete (the app's "Mark Complete").

Requires ManageSalesOrders and an Idempotency-Key header; no body. Only a Delivered order can be completed; the history records "Order marked as complete (via API key '…')". Complete is terminal. An order whose invoices are fully paid may already have become Complete on delivery.

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

Request

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

Path parameters

idinteger required

Sales-order id. Example: 318.

Response

Completed.

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.