Function
The Purchase Order (PO) Item Add API is used to add items to existing POs.
URL
{Root URL}/API/PO/ItemAdd/{API Key} |
Parameters
| Parameter | Description | Required | Comment |
1 | POITTYPE | Purchase order item type | Y | Can be "INVT PART," "MRO," or "Services." |
2 | PoNum | Purchase order number | Y |
|
3 | part_no | Part number | Y | Used to choose a part. |
4 | revision | Part revision | N | Required if Part_no is used. |
5 | uniq_key | Part identifier key | N | Can be used in place of part number and revision. |
6 | partmfgr | Part manufacturer | N | Can be used to specify a manufacturer for a part. Must be an existing manufacturer for the part. |
7 | mfgr_pt_no | Manufacturer part number | N | Can be used instead of part_no to choose an item. |
8 | uniqmfgrhd | Manufacturer key | Y | Can be used in place of partmfgr and mfgr_pt_no. |
9 | overage | Overage | N | Percentage of parts that can be received over the ordered quantity. |
10 | package | Package | N | The item's package size. Can be AMMO BELT," "BULK," "CARTON," "EACH," "REAM," "REEL," "TRAY," or "TUBE." |
11 | updatePLT | Update purchase lead time | N |
|
12 | pur_ltime | Purchase lead time | N | Must be numerical, and followed by DY, WK, and MO. |
13 | updateMinOrdMult | Update minimum/multi-order values. | N |
|
14 | minorder | Minimum order | N | The minimum amount required per order. |
15 | ordmult | Multiple order | N | The amount that must be ordered over the min order. |
16 | COSTEACH | Cost each | N | The cost of each order. |
17 | ORD_QTY | Order quantity | Y | The amount ordered. |
18 | updateMaterialCost | Update material cost | N |
|
19 | updateTargetPrice | Update target price | N |
|
20 | IS_TAX | Is the PO taxable | N |
|
21 | ISFIRM | Is firm planned | N | Selects if the order is firm planned, and prevents MRP from overwriting it. |
22 | FIRSTARTICLE | First article inspection | N | Indicate if the PO requires first article inspection. |
23 | supplierPartNumber | Supplier part number | N |
|
24 | INSPEXCNOTE | Inspection exception note | N |
|
25 | INSPEXCDOC | Inspection exception code | N |
|
26 | PUR_UOFM | Purchase unit of measurement | N |
|
27 | U_OF_MEAS | Unit of measurement | N | Can be "EACH," "IN," "DOZ," "REEL," "LOT," "BULK," "SQIN," "SQFT," "SQYD," "SQMM," "SQCM," "SQME," "GRAM," "KGRM," "MLTR," 'LITR," "CC," "OUNC," "PINT," "QUAR," "GAL," "M," "FT," "CM," "LB," or "YARD." |
28 | NOTE1 | Note specific to a PO line item | N |
|
29 | TAX_PCT | Tax percentage (if the line item is marked taxable) | N |
|
30 | DESCRIPT | Description of PO item | N |
|
31 | PART_CLASS | Part class | N |
|
32 | PART_TYPE |
| N |
|
33 | INSPEXCEPTION | Does the item have an inspection exception | N |
|
34 | INSPEXCINIT | Initials of who added inspection exception on the line item | N |
|
35 | INSPEXCDT | Date the inspection exception was added to the line item | N |
|
36 | LCANCEL | Is the line canceled | N |
|
37 | INSPECTIONOTE | Inspection note | N |
|
38 | ITEMNO | PO line Item number | N |
Example Strings
PO Item Add
URL
?poNum=PONUMBER&POITTYPE=INVT PART&part_no=PARTNUMBER&revision=REVISION&uniqmfgrhd=UNIQMFGRHD |
JSON
{ "poNum":"PONUMBER", "POITTYPE":"INVT PART", "part_no":"PARTNUMBER", "revision":"REVISION", "uniqmfgrhd":"UNIQMFGRHD" } |
A successful request should result in the following:
{ "$id: "1", "Code": "200", "Message": "PO Items added successfully.", "SessionId": "null", "IsValidUser: true", "-ResponseObject: { "$id": "2", "UNIQLNNO": "65ENDLS6VN", "PONUM": "1748", "UNIQ_KEY": "_45Z0YNRSR", "ITEMNO": "002", "COSTEACH": "0", "ORD_QTY": "0", "RECV_QTY": "0", "REJ_QTY": "0", "ACPT_QTY": "0", "NOTE1": "", "IS_TAX": "false", "TAX_PCT": "0", "IS_CONTR": "false", "OVERAGE": "5", "POITTYPE": "INVT PART", "L_PRINT": "false", "NO_PKG": "0", "PART_NO": "416-242424", "REVISION": "", "DESCRIPT": "", "PARTMFGR": "GENR", "MFGR_PT_NO": "416-242424", "PACKAGE": "EACH", "PART_CLASS": "", "PART_TYPE": "", "U_OF_MEAS": "EACH" , "PUR_UOFM": "EACH", "S_ORD_QTY": "0", "ISFIRM": "false", "UNIQMFGRHD": "_45Z0YOITA", "FIRSTARTICLE": "false", "INSPEXCEPT": "false", "INSPEXCEPTION": "", "INSPEXCINIT": "", "INSPEXCDT": "null", "INSPEXCNOTE": "", "INSPEXCDOC": "", "LCANCEL": "false", "UNIQMFSP": "", "INSPECTIONOTE": "", "lRemvRcv": "false", "UNIQSUPNO": "_1D50WFSWT", "pur_ltime": "0", "pur_lunit": "", "updatePLT": "false", "minorder": "0", "ordmult": "0", "updateMinOrdMult": "false", "updateMaterialCost": "false", "Targetprice": "0", "updateTargetPrice": "false", "supplierPartNumber": "", "PoitschdList": "[ ]" } |
Common Error Messages
JSON Error
If there is an error with the setup of the JSON string (such as a misplaced comma or other punctuation), the system will return the following error:
{ "$id": "1", "Code": "403, "Message": "'PO Items' Object is not initialized properly.", "SessionId": "null", "IsValidUser": "true", "ResponseObject": "null" } |
Parameter Error
If there is an error with an individual parameter, the system will return an error message describing the error:
{ "$id": "1", "Code": "403", "Message": "PO Items add failed.UniqMfgrhd is Invalid.", "SessionId": “null”, "IsValidUser": “true”, "ResponseObject": “null” } |