List Sales Orders
unleashed.list_sales_orders
ActionBusiness appsconnection required
Calls the Unleashed Software API with the connection's credentials.
Fetch a page of sales orders, optionally narrowed by status, customer, warehouse or date — including a modified-since window for an incremental sync.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Custom
- Providers
- Unleashed Software
- Secret shape
- {"api_id": "…", "api_key": "…"} — the API ID and API Key from Unleashed
- Resolved by
- config.connection_id, else node.connection_id
Configuration
10 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
page Which page of results to fetch; Unleashed pages from 1. | number | No | 1 | ≥ 1 | — |
page_size How many rows one page holds. Unleashed defaults to 200 and refuses more than 1000. | number | No | 200 | 1–1000 | — |
order_status Only return orders in these statuses; separate several with commas. | string | No | — | — | Completed,Backordered |
order_number Return the single order with this order number, ignoring the other filters. | string | No | — | — | SO-00042 |
customer_code Only return orders whose customer code starts with this value. | string | No | — | — | ACME |
customer_id Only return orders for these customer Guids; separate several with commas. | string | No | — | — | 3d3a9b0f-8c3e-4a6a-9f7e-2b1c4d5e6f70 |
warehouse_code Only return records for this warehouse code. | string | No | — | — | MAIN |
start_date Only return orders dated on or after this date, as YYYY-MM-DD. | string | No | — | matches \d{4}-\d{2}-\d{2} | 2026-01-01 |
end_date Only return orders dated on or before this date, as YYYY-MM-DD. | string | No | — | matches \d{4}-\d{2}-\d{2} | 2026-12-31 |
modified_since Only return records created or edited since this UTC timestamp, which is how an incremental sync avoids re-reading the whole account. | string | No | — | — | 2026-01-01T00:00:00 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"customer_code": "ACME",
"customer_id": "3d3a9b0f-8c3e-4a6a-9f7e-2b1c4d5e6f70",
"end_date": "2026-12-31",
"modified_since": "2026-01-01T00:00:00",
"order_number": "SO-00042",
"order_status": "Completed,Backordered",
"page": 1,
"page_size": 200,
"start_date": "2026-01-01",
"warehouse_code": "MAIN"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
count How many rows this page carried. | number | — |
pagination Unleashed's Pagination block, as returned. | object | — |
page_number The page number this response is. | number | — |
number_of_pages How many pages the filtered set spans. | number | — |
number_of_items How many rows the filtered set holds in total. | number | — |
sales_orders[].Guid The sales order's Guid, which every other node uses as its id. | string | — |
sales_orders[].OrderNumber The human-readable order number, such as SO-00042. | string | — |
sales_orders[].OrderStatus Where the order is in its lifecycle, such as Completed. | string | — |
sales_orders[].OrderDate The date the order was placed. | string | — |
sales_orders[].RequiredDate The date the customer needs the goods by. | string | — |
sales_orders[].CompletedDate The date the order was completed, empty until it is. | string | — |
sales_orders[].Customer The customer the order belongs to. | object | — |
sales_orders[].CustomerRef The customer's own reference for the order. | string | — |
sales_orders[].Warehouse The warehouse the order ships from. | object | — |
sales_orders[].Currency The currency the order is priced in. | object | — |
sales_orders[].SubTotal Order total before tax. | number | — |
sales_orders[].TaxTotal Tax charged on the order. | number | — |
sales_orders[].Total Order total including tax. | number | — |
sales_orders[].DiscountRate Discount applied across the order, as a rate. | number | — |
sales_orders[].SalesOrderLines The order's lines, each with a product and quantity. | array | — |
sales_orders[].Comments Free-text comments stored on the order. | string | — |
sales_orders[].LastModifiedOn Timestamp of the last change to the order. | string | — |
{
"count": 0,
"number_of_items": 0,
"number_of_pages": 0,
"page_number": 0,
"pagination": {},
"sales_orders": [
{
"Comments": "",
"CompletedDate": "",
"Currency": {},
"Customer": {},
"CustomerRef": "",
"DiscountRate": 0,
"Guid": "",
"LastModifiedOn": "",
"OrderDate": "",
"OrderNumber": "",
"OrderStatus": "",
"RequiredDate": "",
"SalesOrderLines": [],
"SubTotal": 0,
"TaxTotal": 0,
"Total": 0,
"Warehouse": {}
}
]
}Related Unleashed Software nodes
See List Sales Orders run in a workflow.
In a technical demo we add the Unleashed Software connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.