Skip to content

Update Sales Order

PUT /api/sales-order/{id}

Required privilege: Demand / Edit Content-Type: application/json CSRF header required: X-XSRF-TOKEN

Replaces the sales order and its line items. Include all existing lines you wish to keep (with their id). Omitted lines may be removed. New lines use "id": null.


Path Parameters

Parameter Type Required Description
id integer Yes Internal SO identifier

Request Body

Same schema as Create Sales Order. Provide Sales Order Id matching the path id.

{
  "SO List Number": "SO-2024-001",
  "SO List Document Status": "Shipped",
  "Customer Number": "CUST-004",
  "Sales Order Id": 88,
  "details": [
    {
      "id": 201,
      "Item Number": "ITEM-A",
      "Warehouse Number": "WH-01",
      "Ship To Number": "ST-09",
      "SO Details Quantity": 200,
      "SO Details Document Status": "Shipped",
      "SO Details Actual Ship Date": "2024-03-18"
    }
  ]
}

Response

{
  "message": "Sales order updated successfully.",
  "notification_type": "Success"
}

Errors

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

All creation validation rules also apply - see Create Sales Order.