Function
The Sales Order (SO) Get Item Price is used to view the price information of an SO.
URL
{Root URL}/API/SO/PriceGet/{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 | salesTypeID | Sales type ID | N | 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. |
| 9 | plpricelink | Price llnk key | N | Must be unique. |
Example Strings
Add Price
URL
?UNIQUELN=UNIQUELN |
JSON
{ "UNIQUELN":"UNIQUELN", } |
A successful request should return the following:
{ "$id": "1", "Code": "200", "Message": "Sales Order Price details:", "SessionId": "null", "IsValidUser": "true", "-ResponseObject": { "$id": "2", "PLPRICELNK": "GAWG8ODL6Q", "SONO": "0000000789", "DESCRIPTIO": "Loud ", "QUANTITY": "0", "PRICE": "1", "EXTENDED": "0", "TAXABLE": "false", "FLAT": "false", "RECORDTYPE": "P", "SALETYPEID": "RESTOCKING", "UNIQUELN": "A6WDVN62YM", "PL_GL_NBR": "4050000-00-00", "COG_GL_NBR": "5090000-00-00", "OrigPluniqLnk": " " } } |
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/SOPriceGet/23456789'.", "MessageDetail": "No type was found that matches the controller named 'SOPriceGet'." } |
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 Price does not exists.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |