Get Sales Order¶

GET /api/sales-order/{id}

Required privilege: Demand / View

Returns a single sales order with all of its line items.

Path Parameters¶

Parameter	Type	Required	Description
`id`	integer	Yes	Internal SO identifier

Response¶

{
  "data": {
    "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",
      "Ship To Id": 9,
      "Ship To Number": "ST-09",
      "Ship To Name": "Beta East Warehouse",
      "SO List Document Status": "Open",
      "SO List Servicenow Id": null,
      "details": [
        {
          "id": 201,
          "Item Id": 55,
          "Item Number": "ITEM-A",
          "Item Description": "Widget Assembly - Type A",
          "Sub Item Id": null,
          "Sub Item Number": null,
          "Warehouse Id": 3,
          "Warehouse Number": "WH-01",
          "Warehouse Name": "Main Distribution Center",
          "SO Details Quantity": 200,
          "SO Details Price": 25.00,
          "SO Details Order Date": "2024-03-10",
          "SO Details Ship Date": "2024-03-18",
          "SO Details Actual Ship Date": null,
          "SO Details Actual Delivery Date": null,
          "SO Details Document Status": "Open",
          "SO Details Tracking": null,
          "SO Details Unique Id": "ERP-SO-001",
          "SO Details Servicenow Id": null
        }
      ]
    }
  }
}

Detail Line Fields¶

Field	Type	Description
`id`	integer	Internal line item identifier
`Item Number`	string	Item reference code
`Item Description`	string	Item display name
`Sub Item Number`	string \| null	Sub-item reference
`Warehouse Number`	string	Fulfilling warehouse
`SO Details Quantity`	number	Ordered quantity
`SO Details Price`	number \| null	Unit price
`SO Details Order Date`	string \| null	Line-level order date
`SO Details Ship Date`	string \| null	Expected ship date
`SO Details Actual Ship Date`	string \| null	Actual ship date
`SO Details Actual Delivery Date`	string \| null	Actual delivery date
`SO Details Document Status`	string	Line status
`SO Details Tracking`	string \| null	Tracking / BOL reference
`SO Details Unique Id`	string \| null	External unique identifier
`SO Details Servicenow Id`	string \| null	ServiceNow reference

Errors¶

Status	Code	Description
400	`SalesOrderList.NotFound`	No SO with this ID
403	`User.NotPrivileged`	Insufficient privilege

Code Examples¶

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

response = session.get("https://acme.knosc.com/api/sales-order/88")
so = response.json()["data"]["rows"]
for line in so["details"]:
    print(f"{line['Item Number']} x{line['SO Details Quantity']}")