Function
The Sales Order (SO) Item Delete API is used to remove items from an existing SO.
URL
{Root URL}/API/SO/ItemDelete/{API KEY} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | SoNo | Sales order number | Y | |
| 2 | line_no | Line number | N | Chooses the line where the part will be added to the SO. |
| 3 | part_no | Part number | Y | The part that is being added to the SO. |
| 4 | uniq_key | Item identifier | N | Can be used instead of a part number. |
| 5 | uOfMeas | Unit of measurement | Y | The Item's unit of measurement. |
| 6 | eachQty | Each delivery quantity | N | If this parameter is used, then it must be greater than "0" and less than the amount ordered. |
| 7 | ord_qty | Quantity ordered | Y | Amount of the item to add to the SO. |
| 8 | soDet_Desc | Item description | Y | |
| 9 | trans_days | Transfer days | N | Will be automatically entered by the system, and can be changed. |
| 10 | fstduedt | First due date | N | Will be automatically entered by the system, and can be changed. |
| 11 | deliFreq | Delivery frequency | N | Can be "DY", "WK", or "MO." |
| 12 | note | SO item note | N | Can be used to add a note to the item. |
| 13 | status | SO item status | Y | Can be "Standard", "Priority-1", "Priority-2", "Cancel", or "Closed." |
| 14 | w_key | Warehouse unique record identifier | N | Used if the item is a "BUY" or "MAKE" part. |
Example Strings
SO Item Delete
URL
?SONO=SONO?uniqueln=UNIQUELN |
JSON
{ “SONO”:”SONO”, “uniqueln”:”UNIQUELN” } |
A successful request should result in
{ "$id":"1", "Code":"200", "Message":"Sales Order Item deleted successfully.", "SessionId":"null", "IsValidUser":"true", "ResponseObject":"null" } |
Example Strings
Add Part
URL
?SoNo=SONO?line_no=LINENUMBER?part_num=PARTNUMBER?revision=REVISION?soDet_Desc=DESCRIPTION?uOfMeas=EACH |
JSON
{ “SONO”:”SONO”, “line_no”:”1=LINENUMBER”, “part_num”:”PARTNUMBER”, “revision”:”REVISION”, “sodet_desc”:”DESCRIPTION”, “uofmeas”:”EACH” } |
A successful request should return the following:
{ "$id":"1", "Code":"200", "Message":"Sales Order Item added successfully.", "SessionId":"null", "IsValidUser":"true", "ResponseObject":"null" } |
Common Errors
URL Error
If there is a problem with the URL, the system will return an HTTP error:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOItemDelete/123456789'.", "MessageDetail": "No type was found that matches the controller named 'SOItemDelete'." } |
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": "UniqLn not provided.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |