Function
The Sales Order (SO) Get API is used to view details on an existing SO.
URL
{Root URL}/API/SO/Get/{API Key} |
Parameters
Parameter | Description | Required | Comment | |
1 | SoNo | Sales order number | Y | Must be unique. When adding a new sales order this can be left blank. |
2 | custNo | Customer number | Y | Ten digits, and filled to the left with "0." |
3 | blinkAdd | Billing link | N | |
4 | slinkAdd | Shipping address link | N | |
5 | orderDate | Order date | Y | Defaults to the current date. Can be changed using the following date format: MM-DD-YYYY. |
6 | POAck | Purchase order acknowledgment | N | Can be "1" or "0." |
7 | PoNo | Purchase order number | N | Enter the purchase order number related to the sales order. |
8 | SONote | Sales order note | N | User input |
9 | FOB | FOB | N | Can be "ORIGIN-CUST P/U," "ORIGIN-SHIP," or "DESTINATION." |
10 | ShipVia | Ship via | N | Defaults with the customer, and can be "COMPANY TRUCK, "CUST PICK UP," "UPS-GRND TRACK," "UPS-BLUE," "UPS-RED," "FEDX-P1," "FEDX-STD." |
11 | shipCharge | Shipping charge | N | Can be "NO CHARGE," "PREPAY/BILL CUS," "SET RATE:UPS-BR," "SET RATE:UPS-BL," "SET RATE:UPS-RD," or "FEDX-1." |
12 | SoFoot | Sales order footnote | N | User entry, and attaches a footnote to the sales order. |
13 | DELIV_TIME | Delivery time | N | |
14 | Buyer | Buyer name | N | Must be a pre-existing customer. |
15 | ATTENTION | Attention person | N | Must be a contact for the customer. |
16 | SOAMTDSCT | Sales order discount | N | |
17 | SOAPPROVAL | Sales order approval | N | Can be "0" or "1." If "1," then you must enter SOAPPRVINIT. |
18 | SOAPPRVINIT | Sales order approval initial | N | Must be an approved user's initial. |
19 | SOAPPRVDT | Sales order approval date | N | The system automatically uses the current date. |
20 | ACKPO_DOC | Acknowledge PO doc | N | Adds a PO acknowledge doc. |
21 | TERMS | Terms | N | Defaults from customer info, and can be changed by the user. |
22 | BILLACCOUNT | Bill account | N | The system defaults this from customer information and can be changed by the user. |
Example Strings
View SO
URL
?SoNo=SONO |
JSON
{ "SoNo":"SONO", } |
A successful request returns the following:
{ "$id": "1", "Code": "200", "Message": "Sales Order details:", "SessionId": "41imqmhh3cywo2c2e5u1gzsu", "IsValidUser": "true", "-ResponseObject": { "$id": "2", "-SODETAILList": [ -{ "$id": "3", "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" }, -{ "$id": "4", "DueDateList": [ ], "SOPRICESList": [ ], "UNIQUELN": "ABDMRI2RMQ", "UNIQ_KEY": "_44Y0WP6H4", "SONO": "0000000789", "LINE_NO": "0000001", "UOFMEAS": "EACH", "EACHQTY": "2" "ORD_QTY": "20", "SHIPPEDQTY": "0", "BALANCE": "10", "Sodet_Desc": "Loud ", "TRANS_DAYS": "1", "FSTDUEDT": "2014-11-13T00:00:00", "DELIFREQ": "MO", "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" } ], "SONO": "0000000789", "BLINKADD": "_4560WJU2L", "SLINKADD": "_4560WL0MU", "CUSTNO": "0000000008", "SHIPNO": " ", "ORDERDATE": "2014-10-23T16:03:00", "TMPACK": "false", "TMPACKDT": "null", "TMPACKINIT": " ", "POACK": "false", "POACKDT": "null", "POACKINIT": " ", "PORECEIV": "false", "POREINIT": " ", "POREDT": "null", "PONO": " ", "CUSTWONO: " ", "SONOTE": "", "ORDPASSWD": " ", "FOB": "ORIGIN-CUST P/U", "SHIPVIA": "UPS-GRND TRACK ", "SHIPCHARGE": "PREPAY/BILL CUS", "IS_CLOSED": "false", "DATECHG": "null", "SOFOOT": "", "ORD_TYPE": "OPEN ", "DELIV_TIME": "15:30 ", "DELIV_AMPM": " ", "BUYER": " ", "SOAMOUNT": "-12", "ATTENTION": " ", "GLDIVNO": " ", "IS_RMA": "false", "ORIGINSONO": " ", "INVOICENO": " ", "SOAMTDSCT": "0", "SOEXTEND": "0", "SOTAX": "0", "PRINTPRDT": "false", "SOAPPROVAL": "false", "SOAPPRVINT": " ", '"OAPPRVDT": "null", "SAVEINT": "NA ", "SAVEDT": "2014-10-23T16:03:00", "ACKPO_DOC": " ", "TERMS": "NET 15 ", "SOPTAX": "0", "SOSTAX": "0", "SOCHANGES": "", "BILLACOUNT": " ", "CustomerName": "null", "CanApproveSo": "false", "UserId": "00000000-0000-0000-0000-000000000000" } } |
Common Errors
URL Error
If there is a problem with the URL, the system will return an HTTP error:
{ "$id": "1", "Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOGet/123456789?SONO=800'.", "MessageDetail": "No type was found that matches the controller named 'SOGet'." } |
API Key Error:
{ "$id": "1", "Code": "403", "Message": "Invalid API Key.", "SessionId": "null", "IsValidUser": "false", "ResponseObject": "null" } |
Sales Order Does Not Exist
If the SO number entered does not refer to an existing SO, the system will return a "Sales Order does not exist" error message:
{ "$id": "1", "Code": "403", "Message": "Sales Order does not exists.", "SessionId": "m2fhqbextbxo334fl4zg5ty0", "IsValidUser": "true", "ResponseObject": "null" } |