Skip to content

List Sales Orders

GET /api/sales-order

Required privilege: Demand / View

Returns a paginated, filterable list of all sales order headers.

Query Parameters

Parameter Description
filter Filter expression
sort Sort column and direction
page / page_size Pagination
scenario Integer - scope results to a scenario analysis

Response

{
  "data": {
    "headers": [
      { "key": "SO List Number", "format": "string-link", "alias": "SO #" },
      { "key": "Customer Name", "format": "string-link" },
      { "key": "SO List Document Status", "format": "string", "alias": "Status" },
      { "key": "SO List Order Date", "format": "date" },
      { "key": "SO Total Items", "format": "number" },
      { "key": "SO List Quantity", "format": "number" }
    ],
    "sort": { "key": "SO List Order Date", "type": "Ascending" },
    "rows": [
      {
        "id": 88,
        "SO List Number": "SO-2024-001",
        "SO List Order Date": "2024-03-10",
        "Customer Id": 4,
        "Customer Name": "Beta Distributors",
        "Customer Number": "CUST-004",
        "SO Total Items": 2,
        "SO List Quantity": 300,
        "SO List Document Status": "Open",
        "SO List Servicenow Id": null
      }
    ]
  },
  "extra": { "page": 1, "page_size": 50, "total": 18 }
}

Row Fields

Field Type Description
id integer Internal SO identifier
SO List Number string Sales order document number
SO List Order Date string | null Order date (ISO 8601)
Customer Id integer Internal customer ID
Customer Name string Customer display name
Customer Number string Customer reference code
SO Total Items integer Count of distinct line items
SO List Quantity number Sum of ordered quantities
SO List Document Status string Order status
SO List Servicenow Id string | null External ServiceNow reference

Code Examples

curl -b cookies.txt "https://acme.knosc.com/api/sales-order"

response = session.get("https://acme.knosc.com/api/sales-order")
orders = response.json()["data"]["rows"]