1. Edit
​Sales Order Item API is used to add, edit, delete, and view the items attached to sales orders

Functions

Add, Edit, Get, Delete

1.1. Add

Functions

Item Add API is used to add individual items to pre-existing Sales Orders.

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

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y 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 Amount of the item to add to the sales order
soDet_Desc Item Description Y
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.
deliv_time Delivery Time Y Example: 3:00
note SO Item Note N Can be used to add a note to the item
status SO Item Status Y 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. 

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 a HTTP error.

{

"$id": "1",

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

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

}

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

}

1.2. 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.

1.3. Get

​Function

Sales Order Item Get API is used to find and view details about items in existing sales orders. 

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

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y 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 Y Amount of the item to add to the sales order
soDet_Desc Item Description Y
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 Y 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. 

Example Strings

Edit Existing SO

URL- ?UNIQUELN=UNIQUELN

JSON-

{

'UNIQUELN':'UNIQUELN'

}

A successful request returns the following

{

$id: "1",

Code: 200,

Message: "Sales Order Item details:",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

DueDateList: [ ],

SOPRICESList: [ ],

UNIQUELN: "A6WDVN62YM",

UNIQ_KEY: "_44Y0WP6H4",

SONO: "0000000789",

LINE_NO: "0000002",

UOFMEAS: "each",

EACHQTY: 0,

ORD_QTY: 0,

SHIPPEDQTY: 0,

BALANCE: 0,

Sodet_Desc: "Loud ",

TRANS_DAYS: 1,

FSTDUEDT: "2014-11-13T00:00:00",

DELIFREQ: " ",

CATEGORY: "000000000~",

NOTE: "",

EXTENDED: 0,

BULLETIN: "",

WONOFLAG: false,

QTYFROMINV: 0,

STATUS: "STANDARD ",

W_KEY: "_4500WBEBA",

ORIGINUQLN: " ",

PRJUNIQUE: " ",

ARCSTATUS: " ",

PRODTPUNIQ: " ",

PRODTPUKLN: " ",

CNFGQTYPER: 0,

MRPONHOLD: false,

SOURCEINSP: false,

FIRSTARTCL: false,

LFCSTITEM: false,

LWARRANTY: false,

PART_NUM: null,

PRJCT_NUM: null,

REVISION: null

}

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an invalid API Key error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If the entered URL is invalid the system will return a "HTTP" error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOItemGet/23456789?UNIQUELN=_47D0OEV28'.",

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

}

Item Does Not Exist

If the entered item does not exist the system will return an "Item Does Not Exist" error message.

{

"$id": "1",

"Code": 403,

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

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.4. Delete

Functions

SO Item Delete API is used to remove items from existing sales orders.

URL-{Root URL}/API/SO/ItemDelete/{API KEY}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y 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 Y Amount of the item to add to the sales order
soDet_Desc Item Description Y
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 Y 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. 

Example Strings

Delete Item

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 a 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

}