Function
The Purchase Order (PO) Main Get function can be used to search the databases for POs based on a variety of PO-related parameters.
URL
{Root URL}/api/PO/Get/{API Key} |
Parameters
| Parameter | Description | Required | Comment | |
| 1 | poNum | Purchase order number | N | |
| 2 | supName | Supplier name | N | Name of the supplier the PO is going to. |
| 3 | uniqSupNo | Unique supplier identifier number | N | Can be used in place of a supplier name. |
| 4 | partNo | Part number | N | Find Purchase orders containing the part number |
| 5 | revision | Part revision | N | Used alongside the part number |
| 6 | uniqKey | Part unique identifier | N | Used in place of part number and revision. |
| 7 | uniqlnno | Unique number | N | |
| 8 | poStatus | Purchase order status | N | Can be "Open," "Cancelled," or "Closed." |
| 9 | mfgrPtNo | Manufacturer part number | N | |
| 10 | partmfgr | Part manufacturer | N | |
| 11 | withBalance | N | ||
| 12 | received | PO received or not | N | Can be "true" or "false." |
| 13 | scheduledPriorTo | POs scheduled before date | N | Use the following date format: MM-DD-YYYY. |
Example Strings
PO Get
URL
?PoNum=PONUM |
JSON
{ "PoNum":"PONUM" } |
A successful request should result in the following:
{ "$id": "1", "Code": 200, "Message": "Purchase Order details:", "SessionId": "null", "IsValidUser": "true", "-ResponseObject": [ { "$id": "2", "PONUM": "000000000001745", "PODATE": "2014-09-18T10:40:00", "POSTATUS": "OPEN", "CONUM": "0", "VERDATE": "2014-10-28T16:38:00", "BUYER": "", "APPVNAME": "T1000", "FINALNAME": "T1000", "POTAX": "0", "POTOTAL": "25", "TERMS": "NET 30/2% 10", "PONOTE": "", "POFOOTER": "", "CLOSDDATE": "null", "IS_PRINTED": "true", "C_LINK": "_1D50WHB6G", "R_LINK": "_1D50WGLC4", "I_LINK": "_0TG0WZ7T2", "B_LINK": "_3I30XB5DF", "SHIPCHG": "1", "IS_SCTAX": "true", "SCTAXPCT": "8.25", "CONFNAME": "", "CONFIRMBY": "", "SHIPCHARGE": "", "FOB": "ORIGIN-CUST P/U", "SHIPVIA": "CUST PICK UP", "DELTIME": "12:00", "ISINBATCH": "false", "RECONTODT": "0", "ARCSTAT": "", "POPRIORITY": "Standard", "POACKNDOC": "", "VERINIT": "T1000", "UNIQSUPNO": "_1D50WFSWT", "POCHANGES": "New PO created by User: T1000, on 09/18/2014 10:39:34, PO Total: $25.00", "LFREIGHTINCLUDE": "false", "POUNIQUE": "_45Z0MUI59", "CurrChange": "", "Acknowledged": "false", "RecVer": "AAAAAAAuqVI=", "Supname": "Anixter", "Status": "APPROVED", "SUP_TYPE": "DISTRIBUTOR", "Supid": "0000000003" } ] } |
Common Errors
Incorrect Parameters
If incorrect parameters are used, the system will return the following:
{ "$id": "1", "Code": "403", "Message": "Purchase Order details failed:", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Not Enough Information
If the information provided is not enough to pull PO details, the system will return the following:
{ "$id": "1", "Code": "403", "Message": "Purchase Order details failed:Not enough information to return the data, please provide valid parameters.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |