Function
The Sales Order (SO) Add Item Price is used to add the item's price and other price-related information to the items on an SO.
URL
{Root URL}/API/SO/PriceAdd/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | SoNo | Sales order number | Y | |
| 2 | price | Sales order price | Y | |
| 3 | taxable | Is the SO taxable | N | Can be "true" or "false." |
| 4 | flat | |||
| 5 | recordType | |||
| 6 | saleTypeID | Sales type ID | Y | Can be: “CABLE/Harn”, “CONSULTING”, “LABOR”, “OTHER”, “PC ASSEMB.”, “PRIORITY”, “REPAIR”, “RESTOCKING”, “REWORK”, “SPARE PART”, “STENCILS”, or “SYSTEM.” |
| 7 | extended | |||
| 8 | uniqueLn | Unique sales order item identifier | Y | Must be unique, and you cannot use a line number (i.e., line_no). |
| 9 | plpricelink | Price link key | N | Must be unique. |
Example Strings
SO Add Item Price
URL
?SoNo=SONO&uniqueln=UNIQUELN&price=1&taxable=1&flat=1&saletypeid=RESTOCKING |
JSON
{ “SoNo”:”785”, “uniqueln”:”UNIQUELN”, “price”:”1”, “taxable”:”1”, “flat”:”1”, “saletypeid”:”RESTOCKING” } |
A successful add should return the following:
{ "$id": "1", "Code": "200", "Message": "Sales Order Price added 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, the system will return an "HTTP Resource not found" message:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceAdd/23456789'.", "MessageDetail": "No type was found that matches the controller named 'SOPriceAdd'." } |
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" } |