Functions
Due Date Edit API is used to change existing due dates on sales orders.
URL-{Root URL}/API/SO/DueDateEdit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| SoNo |
Sales Order Number |
Y |
|
| Due_DTS1 |
Due Dates |
Y |
Has to be working day. Enter in YYYY-MM-DD format |
| Ship_Dts |
Ship Date |
Y |
Has to be prior to Due Date. Enter in YYYY-MM-DD format. |
| commit_Dts |
Commit Date |
N |
Defaults from Due Dates, can also be entered manually. |
| Qty |
Scheduled Quantity |
Y |
The total must be less than or equal to order quantity. |
| uniqueLn |
|
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"
}
Successful Requests Should Return
{
"$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 has an error the system will return a "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 exits in SO:'0000000799'.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Missing Required Parameter
If a required parameter is missing 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
}
|