Function
The Sales Order (SO) Due Date Edit API is used to change the existing due date on an SO.
URL
{Root URL}/API/SO/DueDateEdit/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | SoNo | Sales order number | Y | |
| 2 | Due_DTS | Due dates | Y | Must be a work day. Use the following date format: YYYY-MM-DD. |
| 3 | Ship_Dts | Ship date | Y | Must be prior to the due date. Use the following date format: YYYY-MM-DD. |
| 4 | commit_Dts | Commit date | N | Defaults from due dates, and can also be entered manually. |
| 5 | Qty | Scheduled quantity | Y | The total must be less than or equal to the order quantity. |
| 6 | uniqueLn | Y | Must be unique, and you cannot use a line number (i.e, line_no). | |
| 7 | DueDt_Uniq | Unique due date identifier | Y |
Example Strings
Edit Existing Schedule
URL
?dueDt_Uniq=DUEDT_UNIQ&SONO=0000000000&UNIQUELN=UNIQUELN&QTY=QTY&DUE_DTS1=YYYY-DD-MM |
JSON
{ "dueDt_Uniq":"DUEDT_UNIQ", "SONO":"0000000000", "UNIQUELN":"UNIQUELN", "QTY":"QTY", "DUE_DTS1":"YYYY-MM-DD" } |
A successful request should return the following:
{ "$id": "1", "Code": "200", "Message": "$$Sales Order Due Date edited successfully.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Common Errors
API Key Error
If there is an error with the API key, the system will return an error message:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
URL Error
If there is an error with the entered URL, the system will return an "HTTP resource not found" message:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateEdit/23456789'.", "MessageDetail": "No type was found that matches the controller named 'SODueDateEdit'." } |
Parameter Error
If one of the entered parameters is invalid, the system will fail to add the item due date:
{ "$id": "1", "Code": "403", "Message": "Sales Order item with uniqueLn:'' does not exist in SO:'0000000799'.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Missing Required Parameter
If a required parameter is missing from the system, an error message describing the parameter will be returned:
{ "$id": "1", "Code": "403", "Message": "PlPriceLnk not provided.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |