| 1.1. Get |
The Item Master get API is used to view item details and find information such as item unique ID numbers.
Example URL-{Root URL of your Manexcloud site}/api/ItemMaster/Get?apiKey={Your API KEY}&uniqkey={uniq_key from inventor table}
Note: PartMFGR or MPN can be used in place of uniqkey in above URL.
Parameters
| Parameter |
Description |
Required |
Comment |
| uniqkey |
Item Unique Identifier Key |
Y (Or partnum) |
Used to select the part. |
| partnum |
Part Number |
Y (Or uniqkey) |
Can be used instead of uniqkey to select a part. |
| revision |
Revision |
N |
Used with partnum to select a part. |
Example Strings
Edit Part Description
URL-?uniqkey=UNIQUEKEY
JSON
{
'uniqkey':'UNIQUEKEY'
}
A successful request should result in
{
"$id": "1",
"Code": 200,
"Message": "Inventor details:",
"SessionId": null,
"IsValidUser": true,
-"ResponseObject": {
"$id": "2",
-"InvtmfHdList": [
-{
"$id": "3",
"InvtmfGrList": [
-{
"$id": "4",
"W_Key": "_4750SXAYN",
"Uniq_Key": "_4750SWEOD",
"Qty_Oh": 0,
"Reserved": 0,
"Netable": true,
"Count_Dt": null,
"Count_Type": " ",
"Rstk_Ord": 0,
"Count_Init": " ",
"Location": " ",
"Instore": false,
"Reordpoint": 0,
"Reorderqty": 0,
"Marking": " ",
"Pkg": " ",
"Body": " ",
"Width": 0,
"Pitch": 0,
"Safetystk": 0,
"Countflag": " ",
"Is_Deleted": false,
"Is_Validated": false,
"Uniqmfgrhd": "_4750SXAYM",
"Uniqwh": "_0DM120YNM",
"Uniqsupno": " ",
"InstoreInstalled": false,
"InvtLotList": [ ]
}
],
"InvtmfspList": [ ],
"InvtserList": [ ],
"UNIQMFGRHD": "_4750SXAYM",
"UNIQ_KEY": "_4750SWEOD",
"PARTMFGR": "GENR ",
"MFGR_PT_NO": " ",
"MARKING": " ",
"BODY": " ",
"PITCH": " ",
"PART_SPEC": " ",
"UNIQPKG": " ",
"IS_DELETED": false,
"MATLTYPE": " ",
"AUTOLOCATION": false,
"ORDERPREF": 99,
"MATLTYPEVALUE": " ",
"LDISALLOWBUY": false,
"LDISALLOWKIT": false,
"SFTYSTK": 0,
"InstoreInstalled": false,
"IsInvtMfhdExist": false
}
],
"Uniq_Key": "_4750SWEOD",
"Part_Class": "AUDIO ",
"Part_Type": "SPEAKER ",
"Custno": " ",
"Part_No": "416-110989 ",
"Revision": "b ",
"Prod_Id": " ",
"Custpartno": " ",
"Custrev": " ",
"Descript": "Loud ",
"U_Of_Meas": "EACH",
"Pur_Uofm": "EACH",
"Ord_Policy": "Lot for Lot ",
"Package": "BULK ",
"No_Pkg": 0,
"Inv_Note": "",
"Buyer_Type": " ",
"Stdcost": 1,
"Minord": 0,
"Ordmult": 0,
"Usercost": 0,
"Pull_In": 0,
"Push_Out": 0,
"Ptlength": 0,
"Ptwidth": 0,
"Ptdepth": 0,
"Fginote": "",
"Status": "Active ",
"Perpanel": 0,
"Abc": "B",
"Layer": " ",
"Ptwt": 0,
"Grosswt": 0,
"Reorderqty": 0,
"Reordpoint": 0,
"Part_Spec": " ",
"Pur_Ltime": 3,
"Pur_Lunit": "WK",
"Kit_Ltime": 0,
"Kit_Lunit": " ",
"Prod_Ltime": 0,
"Prod_Lunit": " ",
"Udffield1": " ",
"Wt_Avg": 0,
"Part_Sourc": "BUY ",
"Insp_Req": false,
"Cert_Req": false,
"CERT_TYPE": " ",
"Scrap": 0,
"Setupscrap": 0,
"Outsnote": "",
"Bom_Status": " ",
"Bom_Note": "",
"Bom_Lastdt": null,
"Serialyes": false,
"Loc_Type": " ",
"Day": 0,
"Dayofmo": 0,
"Dayofmo2": 0,
"Saletypeid": " ",
"Feedback": "",
"Eng_Note": "",
"Bomcustno": " ",
"Laborcost": 0,
"Int_Uniq": " ",
"Eau": 0,
"Require_Sn": false,
"Ohcost": 0,
"Phant_Make": false,
"Cnfgcustno": " ",
"Confgdate": null,
"Confgnote": "",
"Xferdate": null,
"Xferby": " ",
"Prodtpuniq": " ",
"Mrp_Code": 0,
"Make_Buy": false,
"Labor_Oh": 0,
"Matl_Oh": 0,
"Matl_Cost": 1,
"Overhead": 0,
"Other_Cost": 0,
"Stdbldqty": 0,
"Usesetscrp": false,
"Configcost": 0,
"Othercost2": 0,
"Matdt": "2014-10-30T13:31:00",
"Labdt": null,
"Ohdt": null,
"Othdt": null,
"Oth2Dt": null,
"Stddt": "2014-10-30T13:31:00",
"Arcstat": " ",
"Is_Ncnr": false,
"Toolrel": false,
"Toolreldt": null,
"Toolrelint": " ",
"Pdmrel": false,
"Pdmreldt": null,
"Pdmrelint": " ",
"Itemlock": false,
"Lockdt": null,
"Lockinit": " ",
"Lastchangedt": "2014-10-30T13:30:00",
"Lastchangeinit": "T1000 ",
"Bomlock": false,
"Bomlockinit": " ",
"Bomlockdt": null,
"Bomlastinit": " ",
"Routrel": false,
"Routreldt": null,
"Routrelint": " ",
"Targetprice": 0,
"Firstarticle": false,
"Mrc": " ",
"Targetpricedt": null,
"Ppm": 0,
"Matltype": "Unk ",
"Newitemdt": "2014-10-30T13:30:00",
"Bominactdt": null,
"Bominactinit": " ",
"Mtchgdt": "2014-10-30T13:30:00",
"Mtchginit": "T1000 ",
"Bomitemarc": false,
"Cnfgitemarc": false,
"C_Log": "",
"Importid": null,
"useipkey": false,
"InstoreInstalled": false,
"SerializationRequired": false,
"NewPartNo": null,
"NewRevision": null,
"RevOnly": false
}
}
Common Errors
API Key Error
If there is an error with the entered API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error within the URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/InventoryHandling/Ge/123456789'.",
"MessageDetail": "No action was found on the controller 'InventoryHandling' that matches the name 'Ge'."
}
Missing Required Parameter
If a required parameter is missing the system will return an error describing the incorrect parameter.
{
"$id": "1",
"Code": 403,
"Message": "Inventor edit failed.Unique_key required.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.2. Add |
The Item Master add API is used to insert new items into the database.
URL-{Root URL}/api/ItemMaster/Add/{API KEY}
Parameters
| Parameter |
Description |
Required |
Comment |
| part_class |
Part Class |
Y |
Used to designate the new part's class. Must be a valid part class. |
| part_type |
Part Type |
Y |
Used to designate the new part's type. Must be a valid part type. |
| part_sourc |
Part Source |
Y |
Used to designate the new part's source. Must be a valid part source. |
| U_of_Meas |
Unit of Measurement |
Y |
The part's unit of measurement. Must be a valid unit of measurement in the system.
|
| Pur_UOfM |
Purchasing Unit of Measurement |
Y |
The part's purchasing unit of measurement. Must be a valid unit of measurement. |
| CustNo |
Customer Identifier Number |
Y |
The customer number is used to select the customer for the part. |
| CustPartNo |
Customer Part Number |
Y |
Used to set the Customer's part number. |
| CustRev |
Customer Revision |
Y |
Used to set the revision level on the customer part. |
| part_No |
Part Number |
Y |
Used to set the part number. |
| status |
Part Status |
Y |
Used to set the part's status, can be "active" or "inactive". |
| serialYes |
Serial Number Yes or No |
Y |
Can be "true" or "false". |
| descript |
Description |
Y |
Can be true or false. |
Example Strings
Example ItemMaster Add String-
URL-?Part_Class=CAP-SMT&Part_Type=0402&Part_Sourc=make&U_Of_Meas=Each&Pur_UOfM=Each&Custno=0000000001&custpartno=n7105&custrev=Q&part_no=121-1000003&status=Active&SerialYes=False&descript=test
JSON-
{
'Part_Class':'CAP-SMT',
'Part_Type':'0402',
'Part_Sourc':'make',
'U_Of_Meas':'Each',
'Pur_UOfM':'Each',
'Custno':'0000000001',
'custpartno':'n7105',
'custrev':'Q',
'part_no':'121-1000003',
'status':'Active',
'SerialYes':'False',
'descript':'test'
}
A successful add should result in:
{
"$id": "1",
"Code": 200,
"Message": "Inventor added successfully.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": "0CQOOPKEFK"
}
Add New Item with InvtmfHD Information.
Adding InvtmfHd information at the same time as the basic part information. For InvtmfHd parameters see InvtmfHd Add API.
Example ItemMaster Add string with InvtmfHd Information
JSON
{'Part_Class':'PARTCLASS','Part_Type':'PARTTYPE','Part_Sourc':'SOURCE','U_Of_Meas':'UOM','Pur_UOfM':'PURCHASEUOM','Custno':'CUSTOMERNUMBER','custPartNo':'CUSTPARTNUMBER','part_no':'PARTNUMBER','status':'Active','SerialYes':'false','Descript':'new add',
InvtmfHdList: [{'partmfgr':'MANUFACTURER','mfgr_pt_no':'MANUFACTURER PARTNUMBER','MATLTYPE':'MATERIALTYPE','MATLTYPEVALUE':'','ORDERPREF':'1','SFTYSTK':'10','LDISALLOWBUY':'false','LDISALLOWKIT':'false',
}]
}
A successful should result in.
{
"$id": "1",
"Code": 200,
"Message": "Inventor added successfully.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": "UO2PKV74UE"
}
Common Errors
API Key Error
If there is an error with the entered API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error within the URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ItemMaster/Ad/123456789'.",
"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'Ad'."
}
Part Already in System
If the part number being added is already being used the system will return an error message describing it.
{
"$id": "1",
"Code": 403,
"Message": "Inventor add failed.Part number '121-1000003' and Revision '' already exists for customer '0000000001'.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Missing Parameter
If a required parameter is missing the system will return an error message asking for the parameter.
{
"$id": "1",
"Code": 403,
"Message":"Inventor add failed.Please provide description for Inventor.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Incorrect Parameter
If an incorrect parameter value is used the system will return an error describing the incorrect parameter.
{
"$id": "1",
"Code": 403,
"Message": "Inventor edit failed.Unique_key required.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.3. Edit |
The Item Master edit API is used to modify item details in the database.
URL-{Root URL}/api/ItemMaster/Edit/{API KEY}
Parameters
| Parameter |
Description |
Required |
Comment |
| part_class |
Part Class |
N |
Used to designate the new part's class. Must be a valid part class. |
| part_type |
Part Type |
N |
Used to designate the new part's type. Must be a valid part type. |
| part_sourc |
Part Source |
N |
Used to designate the new part's source. Must be a valid part source. |
| U_of_Meas |
Unit of Measurement |
N |
The part's unit of measurement. Must be a valid unit of measurement in the system.
|
| Pur_UOfM |
Purchasing Unit of Measurement |
N |
The part's purchasing unit of measurement. Must be a valid unit of measurement. |
| CustNo |
Customer Identifier Number |
N |
The customer number is used to select the customer for the part. |
| CustPartNo |
Customer Part Number |
N |
Used to set the Customer's part number. |
| CustRev |
Customer Revision |
N |
Used to set the revision level on the customer part. |
| part_No |
Part Number |
N |
Used to set the part number. |
| status |
Part Status |
N |
Used to set the part's status, can be "active" or "inactive". |
| serialYes |
Is the Part Serialized Yes or No |
N |
Use the values true or false |
| descript |
Description |
N |
|
| uniq_key |
Item Unique Identifier Key |
Y |
Used to select the item which item is being edited. |
| abc |
Item abc Code |
Y |
Can be A, M, or D |
Example Strings
Edit Part Description
URL-?uniq_key=UNIQUEKEY&Description=EditedDescription&status=active&abc=D
{
'uniq_key':'UNIQUEKEY',
'Description':'EditedDescription',
'status':'active',
'abc':'D'
}
A Successful Edit Request Will Return
{
"$id": "1",
"Code": 200,
"Message": "Inventor edited successfully.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Common Errors
API Key Error
If there is an error with the entered API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error within the URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/InventoryHandling/Receiv/123456789'.",
"MessageDetail": "No action was found on the controller 'InventoryHandling' that matches the name 'Receiv'."
}
Missing Required Parameter
If a required parameter is missing the system will return an error describing the incorrect parameter.
{
"$id": "1",
"Code": 403,
"Message": "Inventor edit failed.Unique_key required.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.4. Delete |
The Item Master Delete API is used to delete items from the database.
URL-{Root URL}/api/ItemMaster/Delete/{API KEY}
Parameters
| Parameter |
Description |
Required |
Comment |
| uniqkey |
Item Unique Identifier Key |
Y |
Used to select the part. |
Example Strings
Edit Part Description
URL-?uniqkey=UNIQUEKEY
JSON
{
'uniqkey':'UNIQUEKEY'
}
A successful request should result in
Common Errors
API Key Error
If there is an error with the entered API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error within the URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/InventoryHandling/Delet/123456789'.",
"MessageDetail": "No action was found on the controller 'InventoryHandling' that matches the name 'Delet'."
}
Missing Required Parameter
If a required parameter is missing the system will return an error describing the incorrect parameter.
{
"$id": "1",
"Code": 403,
"Message": "Inventor edit failed.Unique_key required.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.5. Copy |
The Item Master cop API is used to copy an item's details to a new part number.
URL-{Root URL}/api/ItemMaster/copy/{API KEY}
Parameters
| Parameter |
Description |
Required |
Comment |
| uniqkey |
Item Unique Identifier Key |
Y |
Used to select the part. |
| part_no |
Part Number |
N |
Part_no can also be used to select part. |
| newPartNumber |
New Part Number |
N |
Use newPartNumber to select which part number the item details will be copied to. |
| newRevision |
New Revision |
N |
Use newRevision to set the revision of the part the items are being copied to. |
Example Strings
Edit Part Description
URL-?uniqkey=UNIQUEKEY&newPartNumber=PartNumber&newRevision=Revision
JSON
{
'uniqkey':'UNIQUEKEY',
'newPartNumber':'PartNumber',
'newRevision':'Revision'
}
A successful request should result in
{
"$id": "1",
"Code": 200,
"Message": "Inventory copied, newly generated uniq_key:",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": "1K5DOWK6G1"
}
Common Errors
API Key Error
If there is an error with the entered API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error within the URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/InventoryHandling/Cop/123456789'.",
"MessageDetail": "No action was found on the controller 'InventoryHandling' that matches the name 'Cop'."
}
Missing Required Parameter
If a required parameter is missing the system will return an error describing the incorrect parameter.
{
"$id": "1",
"Code": 403,
"Message": "Inventor edit failed.Unique_key required.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
| 1.6. Next PN |
The Item Master NextPn API is used to insert a new item into the database with the next available part number or revision.
URL-{Root URL}/api/ItemMaster/NextPn/{API KEY}
Parameters
| Parameter |
Description |
Required |
Comment |
| uniqkey |
Item Unique Identifier Key |
Y |
Used to select the part. |
| revOnly |
Revision Only |
N |
RevOnly is used to note whether or not to increase next part by part number, or to increase by revision only. |
| part_class |
Part Class |
N |
You can change the part class for the next part number. |
| part_type |
Part Type |
N |
You can change the part type for the next part number. |
Example Strings
Edit Part Description
URL-?uniqkey=UNIQUEKEY&revOnly=true
JSON
{
'uniqkey':'UNIQUEKEY',
'revOnly':'true'
}
A successful request should result in
{
"$id": "1",
"Code": 200,
"Message": "Inventor next part number generated successfully. Part number:'121-1000003' and Revision:'1'",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
Common Errors
API Key Error
If there is an error with the entered API key the system will return an error describing it.
{
"$id": "1",
"Code": 403,
"Message": "Invalid API Key.",
"SessionId": null,
"IsValidUser": false,
"ResponseObject": null
}
URL Error
If there is an error within the URL the system will return a HTTP error.
{
"$id": "1",
"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/InventoryHandling/NexPn/123456789'.",
"MessageDetail": "No action was found on the controller 'InventoryHandling' that matches the name 'NexPn'."
}
Missing Required Parameter
If a required parameter is missing the system will return an error describing the incorrect parameter.
{
"$id": "1",
"Code": 403,
"Message": "Inventor edit failed.Unique_key required.",
"SessionId": null,
"IsValidUser": true,
"ResponseObject": null
}
|
|