1. Sales Order Item Due Date
1.1. Add

Functions

Add Item Due Date is used to add a due date to an item on the sales order.

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

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
Due_DTS1 Due Dates Y Has to be working day. Enter in MM-DD-YYYY format
Ship_Dts Ship Date Y Has to be prior to Due Date. Enter in MM-DD-YYYY 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

 

Add Due Date

URL-?SONO=0000000000&UNIQUELN=UNIQUELN&QTY=QTY&DUE_DTS1=YYYY-MM-DD

JSON

{

'SONO':'0000000000',

'UNIQUELN':'UNIQUELN',

'QTY':'QTY',

'DUE_DTS1':'YYYY-MM-DD'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date added 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/SODueDateAdd/23456789'.",

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

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2. Edit

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

}

1.3. Get

Functions

Due Date Get API is used to view Due Date information from existing Sales Orders

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

Parameters

Parameter Description Required Comment
DueDateUniq Unique Due Date Identifier Y  


Example Strings

Get Due Date

URL:?DueDateUniq=DueDateUnique

JSON

{

'DueDateUniq':'DUEDATEUNIQUE'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date details:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": {

"$id": "2",

"DUEDT_UNIQ": "_3X60YA22D",

"SONO": "0000000709",

"DUE_DTS1": "2013-11-28T00:00:00",

"SHIP_DTS": "2013-11-26T00:00:00",

"COMMIT_DTS": "2013-11-28T00:00:00",

"QTY": 0,

"STDCHG": 0,

"PRICHG": 0,

"OTHCHG": 0,

"JOBPRI": " ",

"DAYMIN": 0,

"LOTNO": " ",

"QUOTE_SEL": false,

"START_DTS": null,

"ACT_SHP_QT": -1,

"ON_SCHED": false,

"COMPL_DTS": null,

"UNIQUELN": "_3X60Y9X2N"

}

}

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/SODueDateGet/23456789'.",

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

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": ""$$Sales Order Due Date does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4. Delete

Functions

Sales Order Due Date Delete API is used to remove existing Due Dates from Existing Sales Orders

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

Parameters

 Parameter Description Required Comment
DueDt_Uniq Unique Due Date Identifier Y  

Example Strings

Delete Schedule Information

URL-?DueDt_Uniq=DUEDT_UNIQ

JSON

{

'DueDt_Uniq':'DUEDT_UNIQ'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date deleted 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/SODueDateDelete/23456789'.",

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

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "DueDt_Uniq not provided.",

"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": "DueDt_Uniq not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}