Returns one sales order with its lines.
Requires ViewSalesOrders. Removed lines are not returned. Response carries a weak ETag; resend it as If-None-Match to get 304 when nothing changed.
Request
- Base URL: https://app.flexonthejob.com
- URL: https://app.flexonthejob.com/api/v1/sales-orders/{id}
- Auth: HTTP bearer
Path parameters
Sales-order id from the list endpoint. Example: 318.
Response
The sales order.
Numeric id used in /api/v1/sales-orders/{id}. Unique within this organization. Example: 318.
Stable cross-device identifier (GUID) — also the pagination cursor value. Example: 7b1e2c3d-4f5a-4b6c-9d8e-0f1a2b3c4d5e.
Order number assigned by the app, SO + two-digit year + two-digit month + a four-digit sequence per month. Example: SO26090007.
Order status. One of Pending (created, lines can be added, fulfilment not started or not covering every line), Picking (a pick transfer covers every line and items are being picked), Packed (everything picked), Shipped (every transfer has shipping info), Delivered (every transfer completed), Complete (terminal: marked complete, or delivered and fully invoiced and paid) and Cancelled (terminal). Legacy rows may still say the deprecated Confirmed. Over the API /fulfill starts fulfilment and the later statuses follow from /pick, /complete-pick, /ship and /deliver, as in the app.
Payment status: Pending, Partial, Paid, Overdue, Refunded, Invoiced or Cancelled. Example: Pending. Null on some legacy rows.
Aggregate status of the order's transfers (the earliest one wins): None (no transfer yet), Draft, Pending, InTransit, AtWaypoint, InTransitToWaypoint, InTransitToDestination, Completed, Cancelled, Failed. Example: Pending.
Customer id (see /api/v1/customers/{id}). Example: 42.
Customer name at read time. Example: Acme Plumbing.
The customer's own purchase-order reference; null when none. Example: PO-7781.
Order date as entered in the app: the organization's local calendar date with no UTC offset (not an instant; do not convert it between time zones). Example: 2026-09-23T00:00:00.
Requested delivery date, same organization-local calendar-date format as orderDate; null when none. Example: 2026-09-30T00:00:00.
Sum of the line totals, in the organization's currency. Example: 1250.00.
Tax rate in percent (8.25 = 8.25 %). 0 for a tax-exempt customer. Example: 8.25.
Tax, subTotal × taxRate / 100, in the organization's currency. Example: 103.13.
Shipping charged on the order, in the organization's currency. Example: 25.00.
Order total, subTotal + taxAmount + shippingCost, in the organization's currency. Example: 1378.13.
Amount paid so far, in the organization's currency. Example: 500.00.
Still owed: totalAmount − amountPaid − store credit applied, in the organization's currency. Example: 878.13.
Number of lines on the order (removed lines excluded). Example: 3.
Creation time, ISO-8601 UTC. Example: 2026-09-23T14:05:00Z.
Last recorded modification (header or line edits, lines added or removed, status change, fulfilment and pick progress, fulfillmentStatus change), ISO-8601 UTC; null when never modified since creation. Payments do not move it (paymentStatus / amountPaid / balanceDue can change without it). Example: 2026-09-23T15:12:00Z.
Id of the customer address the order is delivered to; null when none. Example: 77.
Payment terms text. Example: Net 30. Null when none.
Free-text notes on the order. Example: Leave at loading dock. Null when none.
Changes
No recorded changes to this operation across all 1 revision of this API.