Edit

​Function

Sales Order Edit API is used to modify details about items in existing sales orders. 

URL-{Root URL}/API/SO/ItemEdit/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number Y You must provide either Line_no or UNIQUELN
part_num Part Number Y The part that is being added to the SO or are changing details of such as order qty or status etc. of that part number you provide
revision Part Revision Level Y If providing part number, you must provide Revision
uniq_key Item identifier N Can be used instead of part number and revision
uOfMeas Unit of Measurement N The Item"s unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered N Only required if changing Order Qty Amount
soDet_Desc Item Description N
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliFreq Delivery Frequency N Can be "DY", "WK", or "MO"
note SO Item Note N Can be used to add a note to the item
status SO Item Status N Only need if changing line item status : Can be "Standard", "Priority-1", "Priority-2", "Cancel", "Closed"
w_key Warehouse Unique Record Identifier N Used if the item is a "BUY" or "MAKE" part. 
UNIQUELN Unique Key for Line Item Y You must provide either Line_no or UNIQUELN

Example Strings

Edit Existing SO Item, Changing the Order Qty 

URL- ?SoNo=SONO&UNIQUELN=UNIQUELN&PART_NUM=PARTNUMBERrevision=REVISION&UOFMEAS=EACH&TRANSFER_DAYS=5 &ORD_QTY=20&EACHQTY=2&STATUS=STANDARD&DELIFREQ=MO

JSON-

{ 

"sono":"sales order number", 

"Line_no": "line item number", 

"Part_Num":"part number",

"revision":"revision",

"Ord_Qty":"40"

}

 

Edit Existing SO Item, Changing The status to "Admin Hold"

 

{ 

"sono":"Sales Order number", 

"Uniqueln": "UniqueLN", 

"Part_Num":"Partnumber",

"revision":"revision",

"status":"Admin Hold"

}

 

A successful request returns the following.

The below example I was adding more Order Quantity. 

 

Common Errors

URL Error

If there is a problem with the URL the system will return a HTTP error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI "http://localhost/api/SOItemEdit/123456789".",

"MessageDetail": "No type was found that matches the controller named "SOItemEdit"."

}

API Key Error

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Parameter Error

If there is an error with one of the entered parameters the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

 

Please Note:

If Line item balance is "0",  user cannot not edit Line Item Status without increasing the quantities also.