| Edit |
Functions
Edit Item Price is used to modify a price or price information for the items of a sales order.
URL-{Root URL}/API/SO/PriceEdit/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| SoNo |
Sales Order Number |
Y |
|
| price |
Sales Order Price |
Y |
|
| taxable |
Is the SO Taxable |
N |
Can be 'true' or 'false' |
| flat |
|
|
|
| recordType |
|
|
|
| saleTypeID |
Sales Type ID |
N |
Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM' |
| extended |
|
|
|
| uniqueLn |
Unique Sales Order item identifier
|
Y |
Must be unique. |
| plpricelink |
Price Link Key |
N |
Must be unique. |
Example Strings
Add Price
URL-?SoNo=SONO&UNIQUELN=UNIQUELN&PLPRICELNK=PLPRICELNK&price=1.2&taxable=1&flat=1&saletypeid=RESTOCKING
JSON
{
'SoNo':'SONO',
'UNIQUELN':'UNIQUELN',
'PLPRICELNK':'PLPRICELNK',
'price':'1.2',
'taxable':'1',
'flat':'1',
'saletypeid':'RESTOCKING'
}
A successful request should return.
{
$id: "1",
Code: 403,
Message: "Sales Order Price 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/SOPriceEdit/23456789'.",
"MessageDetail": "No type was found that matches the controller named 'SOPriceEdit'."
}
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
}
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
}
|
|