Functions
Item Add API is used to add items to existing Purchase Orders.
URL-{Root URL}/API/PO/ItemAdd/{API Key}
Parameters
| Parameter |
Description |
Required |
Comment |
| POITTYPE |
Purchase Order Item Type |
Y |
Can be INVT PART, MRO, or Services |
| part_no |
Part Number |
Y |
Used to choose a part |
| revision |
Part Revision |
N |
Required if Part_no is used |
| uniq_key |
Part Identifier Key |
N |
Can be used in place of part number and revision |
| partmfgr |
Part Manufacturer |
N |
Can be used to specify a manufacturer for a part. Must be an existing manufacturer for the part |
| mfgr_pt_no |
Manufacturer Part Number |
N |
Can be used instead of part_no to choose an item |
| uniqmfgrhd |
Manufacturer Key |
Y |
Can be used in place of partmfgr and mfgr_pt_no |
| uniqmfsp |
|
N |
|
| overage |
overage |
N |
Percentage of parts that can be received over the ordered qty. |
| package |
Package |
N |
The item's package size. Can be AMMO BELT, BULK, CARTON, EACH, REAM, REEL, TRAY, TUBE |
| updatePLT |
Update Purchase Lead Time |
N |
|
| pur_ltime |
Purchase Lead Time |
N |
Must be numerical, followed by DY, WK, Mo |
| updateMinOrdMult |
Update Minimum/Multi order values. |
N |
|
| minorder |
Minimum Order |
N |
Minimum amount required per order. |
| ordmult |
Multiple Order |
N |
Amount that must be ordered over the min order. |
| COSTEACH |
Cost Each |
N |
Cost of each ordered |
| ORD_QTY |
Order Quantity |
Y |
The amount ordered |
| updateMaterialCost |
Update Material Cost |
N |
|
| updateTargetPrice |
Update Target Price |
N |
|
| IS_TAX |
It the PO taxable |
N |
|
| ISFIRM |
Is Firm Planned |
N |
Selects if the order is firm planned, preventing the MRP from overwriting it. |
| FIRSTARTICLE |
First Article Inspection |
N |
Does the PO require first article inspaction |
| supplierPartNumber |
Supplier Part Number |
N |
|
| INSPEXCNOTE |
Inspection Exception Note |
N |
|
| INSPEXCDOC |
Inspection Exception Code |
N |
|
| PUR_UOFM |
Purchase Unit of Measurement |
N |
|
| 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, YARD |
Example Strings
Add Item
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
{
$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
}
|
