Function
The Sales Order (SO) Item Get API is used to find and view details about items on an existing SO.
URL
{Root URL}/API/SO/ItemGet/{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 used, then has to be greater than "0" and less than the amount ordered. |
| 7 | ord_qty | Quantity ordered | Y | Amount of the item to add to the sales order. |
| 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 Get
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 an 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" } |