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