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