1. API Details

MANEX APIs allow users to create or use add-ons or outside applications to access and data in the MANEX system. This allows users to add or modify data within the MANEX system without having to use the MANEX system apps as well as not having to worry about causing data errors with the system. 

​API KEYS

There is no application process for MANEX API. The system administrator has to assign each API user a unique 10 character API key in the aspnet_Profile table as shown in the picture below.  

1.1. Item Master
1.1.1. Inventor
1.1.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.1.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.1.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.1.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.1.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.1.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

}

1.1.2. InvtmfHd
1.1.2.1. Add

The Item Master InvtmfHd add API is used to add Manufacturer information to parts in the database. 

URL-{Root URL}/api/ItemMaster/InvtmfHdAdd/{API KEY}

Parameters

Parameter Description Required Comment
uniq_key  Part Unique Key Y The uniq_key is used to select the part you would like to add maufacturer information to.
partmfgr  Part Manufacturer  Y Sets the Part's manufacturer. Must be a manufacturer in your system. 
mfgr_pt_no  Manufacturer Part Number  Y Adds the manufacturer's part number to the part.
matltype  Material Type Y Must be a valid material type in the system.
matltypevalue  Material Type Value Y  
orderpref     
sftystk     
ldisallowbuy    Can be "true" or "false". 
ldisallowkit    Can be "true" or "False".  

Example Strings

Example invtmfHd Add String-

URL-?Uniq_key=_4750SWEOD&PARTMFGR=3G&MFGR_PT_NO=vit-2&MATLTYPE=Unk&MATLTYPEVALUE=&ORDERPREF=1&SFTYSTK=10&LDISALLOWBUY=false&LDISALLOWKIT=false

JSON-

{

'Uniq_key':'_4750SWEOD',

'PARTMFGR':'3G',

'MFGR_PT_NO':'vit-2',

'MATLTYPE':'Unk',

'MATLTYPEVALUE':'',

'ORDERPREF':'1',

'SFTYSTK':'10',

'LDISALLOWBUY':'false',

'LDISALLOWKIT':'false'

}

A successful add should result in:

{

"$id": "1",

"Code": 200,

"Message": "Invtmfgrhd added successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": "SWIWRWPI63"

}

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/InvtmfHdAd/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": "Invtmfgrhd add failed.Combination of Uniq_Key '_4750SWEOD, PartMfgr '3G' and Mfgr_Part_No 'vit-2' is already exist.",

"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.1.2.2. Edit

The Item Master InvtmfHd add API is used to add Manufacturer information to parts in the database. 

URL-{Root URL}/api/ItemMaster/InvtmfHdEdit/{API KEY}

Parameters

Parameter Description Required Comment
uniq_key  Part Unique Key Y The uniq_key is used to select the part you would like to edit maufacturer information for.
uniqmfgrhd  Unique Part Manufacturer Key Unique field used to identify the part manufacturer information.  
partmfgr  Part Manufacturer  N Can be used to change the manufacturer, must be a manufacturer in the system.  
mfgr_pt_no  Manufacturer Part Number  N Can be used t change the manufacturer's part number. 
matltype  Material Type N Must exist within the system. 
matltypevalue  Material Type Value N Identifier value for the material type, must exist within the system.  
orderpref     
sftystk     
ldisallowbuy    Can be "true" or "false". 
ldisallowkit    Can be "true" or "False".  

Example Strings

Example invtmfHd edit String-

URL-?Uniq_key=_4750SWEOD&uniqmfgrhd=UNIQMFGRHD&MFGR_PT_NO=NEWMFGRPARTNUMBER

JSON-

{

'Uniq_key':'_4750SWEOD',

'uniqmfgrhd':'UNIQMFGRHD',

'MFGR_PT_NO':'vit-2'

}

A successful add should result in:

{

"$id": "1",

"Code": 200,

"Message": "Invtmfgrhd edited successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": "SWIWRWPI63"

}

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/InvtmfHdEdi/123456789'.",

"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfHdEdi'."

}

Missing Parameter

If a required parameter is missing the system will return an error message asking for the parameter.

{

"$id": "1",

"Code": 403,

"Message":"Invtmfgrhd edit failed.Uniqmfhd required.",

"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.1.2.3. Get

The Item Master InvtmfHd Get API is used to view Manufacturer information of parts in the database. 

URL-{Root URL}/api/ItemMaster/InvtmfhdGet?apiKey={API KEY}&uniqmfgrHd={UNIQMFGRHD}

Parameters

Parameter Description Required Comment
uniqmfgrhd
Y The uniqmfgrhd is used to select the part you would like to view manufacturer information for.

Example Strings

Example invtmfHd Get String-

URL-?uniqmfgrhd=_4750SWEOD

JSON-

{

'uniqmfgrhd':'_4750SWEOD',

}

A successful add should result in:

{

"$id": "1",

"Code": 200,

"Message": "Invtmfgrhd details:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": {

"$id": "2",

"InvtmfGrList": [ ],

"InvtmfspList": [ ],

"InvtserList": [ ],

"UNIQMFGRHD": "SWIWRWPI63",

"UNIQ_KEY": "_4750SWEOD",

"PARTMFGR": "3G ",

"MFGR_PT_NO": "vit-2 ",

"MARKING": " ",

"BODY": " ",

"PITCH": " ",

"PART_SPEC": " ",

"UNIQPKG": " ",

"IS_DELETED": false,

"MATLTYPE": "Unk ",

"AUTOLOCATION": false,

"ORDERPREF": 99,

"MATLTYPEVALUE": " ",

"LDISALLOWBUY": false,

"LDISALLOWKIT": false,

"SFTYSTK": 0,

"InstoreInstalled": false,

"IsInvtMfhdExist": 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/ItemMaster/InvtmfHdEdi/123456789'.",

"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfHdEdi'."

}

Missing Parameter

If a required parameter is missing the system will return an error message asking for the parameter.

{

"$id": "1",

"Code": 403,

"Message":"Invtmfgrhd edit failed.Uniqmfhd required.",

"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.1.2.4. Delete

The Item Master InvtmfHd Delete API is used to remove Manufacturer information from parts in the database. 

URL-{Root URL}/api/ItemMaster/InvtmfHdDelete/{API KEY}

Parameters

Parameter Description Required Comment
uniqmfgrhd
Y The uniqmfgrhd is used to select the part you would like to delete manufacturer information from.

Example Strings

Example invtmfHd Delete String-

URL-?uniqmfgrhd=_4750SWEOD

JSON-

{

'uniqmfgrhd':'_4750SWEOD',

}

A successful add should result in:

{

"$id": "1",

"Code": 200,

"Message": "Invtmfgrhd deleted 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/ItemMaster/InvtmfHdDelet/123456789'.",

"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfHdDelet'."

}

Missing Parameter

If a required parameter is missing the system will return an error message asking for the parameter.

{

"$id": "1",

"Code": 403,

"Message":"Invtmfgrhd edit failed.Uniqmfhd required.",

"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.1.3. Invtmfsp
1.1.3.1. Add

The Item Master InvtmfSp add API is used to add Supplier information to parts in the database. 

URL-{Root URL}/api/ItemMaster/InvtmfSpAdd/{API KEY}

Parameters

Parameter Description Required Comment
uniq_key  Part Unique Key Y The uniq_key is used to select the part you would like to add supplier information to.
uniqmfgrhd Unique Manufacturer Information Key  Y The uniqmfgrhd is also used to choose the part you would like to add 
UniqWh  Warehouse Identifier Y Used to pick the default warehouse for the item. 
uniqsupno  Unique Supplier Number Y This is used to identify the supplier.
suplpartno  Supplier Part Number Y Set the supplier  part number for the item. 

Example Strings

Example invtmfSp Add String-

URL-?uniq_key=_4750SWEOD&uniqmfgrhd=SWIWRWPI63&UniqWh=_0DM120YNM&uniqsupno=_44L0SDHY2&suplpartno=1131

JSON-

{

'Uniq_key':'_4750SWEOD',

'PARTMFGR':'3G',

'MFGR_PT_NO':'vit-2',

'MATLTYPE':'Unk',

'MATLTYPEVALUE':'',

'ORDERPREF':'1',

'SFTYSTK':'10',

'LDISALLOWBUY':'false',

'LDISALLOWKIT':'false'

}

A successful add should result in:

{

"$id": "1",

"Code": 200,

"Message": "Invtmfsp added successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": "2JT3HLSFLQ"

}

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/InvtmfSpAd/123456789'.",

"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfSpAd'."

}

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": "Invtmfsp add failed.Uniqmfsp with uniqmfgrhd 'SWIWRWPI63', supplier part number '1131' and uniqSupNum '_44L0SDHY2' already exists.",

"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.1.3.2. Edit

The Item Master InvtmfSp Edit API is used to add Supplier information to parts in the database. 

URL-{Root URL}/api/ItemMaster/InvtmfSpEdit/{API KEY}

Parameters

Parameter Description Required Comment
uniq_key  Part Unique Key Y The uniq_key is used to select the part you would like to add manufacturer information to.
Uniqmfsp    
uniqmfgrhd Unique Manufacturer Information Key  N  
UniqWh 
N  
uniqsupno  Unique Supplier Number N  
suplpartno  Supplier Part Number N  

Example Strings

Example invtmfSp Edit String-

URL-?uniq_key=_4750SWEOD&uniqmfgrhd=SWIWRWPI63&UniqWh=_0DM120YNM&uniqsupno=_44L0SDHY2&suplpartno=1131

JSON-

{

'Uniq_key':'_4750SWEOD',

'PARTMFGR':'3G',

'MFGR_PT_NO':'vit-2',

'MATLTYPE':'Unk',

'MATLTYPEVALUE':'',

'ORDERPREF':'1',

'SFTYSTK':'10',

'LDISALLOWBUY':'false',

'LDISALLOWKIT':'false'

}

A successful add should result in:

{

"$id": "1",

"Code": 200,

"Message": "Invtmfsp edited successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": "2JT3HLSFLQ"

}

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/InvtmfSpAd/123456789'.",

"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name InvtmfSpAd'."

}

Missing Parameter

If a required parameter is missing the system will return an error message asking for the parameter.

{

"$id": "1",

"Code": 403,

"Message":"Invtmfsp edit failed.Uniqmfsp required.",

"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.1.3.3. Get

The Item Master InvtmfSp Get API is used to view supplier information for parts in the database. 

URL-{Root URL}/api/ItemMaster/InvtmfSpGet?apiKey={API KEY}&uniqmfsp={UNIQMFSP}

Parameters

Parameter Description Required Comment
uniqmfsp
Y The uniqmfsp is used to select the part you would like to view information for.

Example Strings

Example invtmfSp Get String-

URL-?uniqmfsp=UNIQMFSP

JSON-

{

'uniqmfsp':'UNIQMFSP',

}

A successful add should result in:

{

"$id": "1",

"Code": 200,

"Message": "Invtmfsp details:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": {

"$id": "2",

"Uniqmfsp": "2JT3HLSFLQ",

"Uniqmfgrhd": "SWIWRWPI63",

"Uniqsupno": "_44L0SDHY2",

"Suplpartno": "1131 ",

"Uniq_Key": "_4750SWEOD",

"Pfdsupl": false,

"Is_Deleted": 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/ItemMaster/InvtmfSpGe/123456789'.",

"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfSpGe'."

}

Incorrect Parameter

If an incorrect parameter value is used the system will return an error describing the incorrect parameter.

{

"$id": "1",

"Code": 403,

"Message": "Uniqmfsp not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.1.3.4. Delete

The Item Master InvtmfSp Delete API is used to remove supplier information from parts in the database. 

URL-{Root URL}/api/ItemMaster/InvtmfSpDelete/{API KEY}

Parameters

Parameter Description Required Comment
uniqmfsp
Y The uniqmfsp is used to select the part you would like to view information for.

Example Strings

Example invtmfSp Delete String-

URL-?uniqmfsp=UNIQMFSP

JSON-

{

'uniqmfsp':'UNIQMFSP',

}

A successful delete should result in:

{

"$id": "1",

"Code": 200,

"Message": "Invtmfsp deleted 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/ItemMaster/InvtmfSpDelet/123456789'.",

"MessageDetail": "No action was found on the controller 'ItemMaster' that matches the name 'InvtmfSpDelet'."

}

Incorrect Parameter

If an incorrect parameter value is used the system will return an error describing the incorrect parameter.

{

"$id": "1",

"Code": 403,

"Message": "Uniqmfsp not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2. Work Order API
1.2.1. WO Main
1.2.1.1. WO Add

Functions

WO Add API is used to add a new Work Order. 

URL-{Root URL}/API/WO/Add/{API Key}

Parameters


Parameter  Description Required Comment
 WoNo Work Order Number N  
Uniq_Key Item Unique Identifier Y Used to Choose the item to be built in the Work Order
openclos Work Order Status Y Can be STANDARD, PRIORITY-1, PRIORITY-2, FIRM PLAN, ADMIN HOLD, MFG HOLD, REWORK, REWORK FIRM, CANCEL
Due_Date Work Order Due Date Y Use MM-DD-YYYY format
custNo  Customer Number Y Must be an existing customer
bldQty Build Quantity N Amount to be built in the Work Order

Example Strings

Add Work Order

Url-?uniq_key=UNIQKEY&openclos=STANDARD&Due_Date=MM-DD-YYYY&custno=CUSTOMERNUMBER&bldqty=QTY'

JSON

{

'uniq_key':'UNIQKEY',

'openclos':'STANDARD',

'Due_Date':MM-DD-YYYY',

'custno':'CUSTOMERNUMBER',

'bldqty':'QTY'

}

A successful request should result in

{

$id: "1",

Code: 200,

Message: "WorkOrder added successfully.",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

WONO: "0000000410",

UNIQ_KEY: "FW7064W8L8",

OPENCLOS: "STANDARD",

ORDERDATE: "2014-11-04T14:55:50.9647637-05:00",

DUE_DATE: "2014-11-07T00:00:00",

AUDPLACE: "",

BLDQTY: 100,

COMPLETE: 0,

BALANCE: 100,

WONOTE: "",

IS_CLOSED: false,

DATECHG: null,

PLANTNO: "",

AUDBY: "",

AUDDATE: null,

MATL_CK: "",

ENGR_CK: "",

QLTY_CK: "",

SALE_CK: "",

KIT_NOTE: "",

MRP_DONE: false,

ORD_TYPE: "",

MAT_REQ_DT: null,

MAT_REQ_Q: 0,

MAT_REQ_D: "",

PROD_TIME: 0,

TTSETPTIME: 0,

ISSUED: false,

ENG_APPR: false,

ENG_APPD: null,

ENG_APPT: "",

ENG_APPI: "",

SHFLNOTE: "",

ORIG_DUEDT: null,

BUILDABLE: 0,

SCHED_FB: 0,

IS_ALLOC: false,

KITSTATUS: "",

KITCLOSEDT: null,

START_DATE: null,

CUSTNO: "0000000008",

SONO: "",

KIT: false,

SHTGNOTE: "",

RELEDATE: null,

SERIALYES: false,

UNIQUELN: "",

GLDIVNO: "",

CMPRICELNK: "",

EACHQTY: 0,

FSTDUEDT: null,

DELIFREQ: "",

PRJUNIQUE: "",

ARCSTAT: "",

SQCSTATUS: "",

KITLSTCHDT: null,

KITLSTCHINIT: null,

MRPONHOLD: false,

COMPLETEDT: null,

KITSTARTINIT: null,

KITCLOSEINIT: null,

KITCOMPLETE: false,

KITCOMPLDT: null,

KITCOMPLINIT: null,

LFCSTITEM: true,

LIS_RWK: false,

UNIQUEREC: null,

UNIQUERECID: null

}

}

Common Errors

API Key Error

If there is a problem with the entered API Key the system will return an API Key error message

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the used URL the system will return a HTTP error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'WOAdd'."

}

JSON Error

If there is an error with the JSON string the system will return an "Object Reference" error.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrder add failed.Object reference not set to an instance of an object.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing required parameter

If a required parameter value is missing the system will return an error message describing the missing parameter.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrder add failed.Work Order Uniq_Key is required",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2.1.2. WO Edit

Functions

WO Edit API is used to edit the details of an existing Work Order.

URL-{Root URL}/API/WO/Edit/{API Key}

Parameters


Parameter  Description Required Comment
 WoNo Work Order Number Y  
Uniq_Key Item Unique Identifier Y Used to Choose the item to be built in the Work Order
openclos Work Order Status Y Can be STANDARD, PRIORITY-1, PRIORITY-2, FIRM PLAN, ADMIN HOLD, MFG HOLD, REWORK, REWORK FIRM, CANCEL
Due_Date Work Order Due Date N Use MM-DD-YYYY format
custNo  Customer Number Y Must be an existing customer
bldQty Build Quantity N Amount to be built in the Work Order

Example Strings

Edit Work Order Quantity

Url-?WoNo=WONO&uniq_key=UNIQKEY&openclos=STANDARD&custno=CUSTOMERNUMBER&bldqty=QTY'

JSON

{

'WoNo':'WONO',

'uniq_key':'UNIQKEY',

'openclos':'STANDARD',

'custno':'CUSTOMERNUMBER',

'bldqty':'QTY'

{

A successful edit should result in

{

$id: "1",

Code: 200,

Message: "WorkOrder edited successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is a problem 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 with the used URL the system will return a HTTP error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOEdit/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'WOEdit'."

}

JSON Error

If there is a problem with the setup of the JSON string the system will return a "non-static method" message.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrder edit failed.Non-static method requires a target.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system will return an error message showing the missing parameter.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrder edit failed.Please Provide Work Order Number.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2.1.3. WO Get

Functions

WO Get API is used to find and view information for existing Work Orders

URL-{Root URL}/API/WO/Get/{API Key}

Parameters


Parameter  Description Required Comment
WoNo Work Order Number N  
Uniq_Key Item Unique Identifier Y Used to Choose the item to be built in the Work Order
openclos Work Order Status Y Can be STANDARD, PRIORITY-1, PRIORITY-2, FIRM PLAN, ADMIN HOLD, MFG HOLD, REWORK, REWORK FIRM, CANCEL
Due_Date Work Order Due Date Y Use MM-DD-YYYY format
custNo  Customer Number Y Must be an existing customer
bldQty Build Quantity N Amount to be built in the Work Order

Example Strings

Work Order Get

URL?WoNo=WONO

JSON

{

'WoNo':'WONO'

}

A successful request should result in

{

"$id": "1",

"Code": 200,

"Message": "WorkOrder details:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": [

{

"$id": "2",

"WONO": "0000000410",

"UNIQ_KEY": "FW7064W8L8",

"OPENCLOS": "STANDARD ",

"ORDERDATE": "2014-11-04T14:56:00",

"DUE_DATE": "2014-11-07T00:00:00",

"AUDPLACE": " ",

"BLDQTY": 210,

"COMPLETE": 0,

"BALANCE": 210,

"WONOTE": "",

"IS_CLOSED": false,

"DATECHG": null,

"PLANTNO": " ",

"AUDBY": " ",

"AUDDATE": null,

"MATL_CK": " ",

"ENGR_CK": " ",

"QLTY_CK": " ",

"SALE_CK": " ",

"KIT_NOTE": "",

"MRP_DONE": false,

"ORD_TYPE": " ",

"MAT_REQ_DT": null,

"MAT_REQ_Q": 0,

"MAT_REQ_D": " ",

"PROD_TIME": 0,

"TTSETPTIME": 0,

"ISSUED": false,

"ENG_APPR": false,

"ENG_APPD": null,

"ENG_APPT": " ",

"ENG_APPI": " ",

"SHFLNOTE": "",

"ORIG_DUEDT": null,

"BUILDABLE": 0,

"SCHED_FB": 0,

"IS_ALLOC": false,

"KITSTATUS": "KIT PROCSS",

"KITCLOSEDT": null,

"START_DATE": "2014-11-06T14:33:00",

"CUSTNO": "0000000008",

"SONO": " ",

"KIT": false,

"SHTGNOTE": "",

"RELEDATE": null,

"SERIALYES": false,

"UNIQUELN": " ",

"GLDIVNO": " ",

"CMPRICELNK": " ",

"EACHQTY": 0,

"FSTDUEDT": null,

"DELIFREQ": " ",

"PRJUNIQUE": " ",

"ARCSTAT": " ",

"SQCSTATUS": " ",

"KITLSTCHDT": "2014-11-06T14:33:00",

"KITLSTCHINIT": "T1000 ",

"MRPONHOLD": false,

"COMPLETEDT": null,

"KITSTARTINIT": "T1000 ",

"KITCLOSEINIT": null,

"KITCOMPLETE": false,

"KITCOMPLDT": null,

"KITCOMPLINIT": null,

"LFCSTITEM": true,

"LIS_RWK": false,

"UNIQUEREC": null,

"UNIQUERECID": null

}

]

}

Common Errors

API Key Error

If there is a problem with the entered API key the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOGet/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'WOGet'."

}

Not Enough Information

If not enough information is provided to get a Work Order the system will return a "Not Enough Information" error message.

{

"$id": "1",

"Code": 403,

"Message": "Not enough information to return the data, please provide valid parameters.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Work Order Doesn't Exist

If the Work Order entered does not exist the system will return an error message saying that the work order doesn't exist.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrder does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2.2. WO Schedule
1.2.2.1. WO Schedule Add

Functions

Work Order Schedule Add API is used to add scheduling information to an existing Work Order

URL-{Root URL}/API/WOSchedule/Add/{API Key}

Parameters

Parameters  Description Required Comment
WoNo  Work Order Number Y  
autoSchedule Auto Schedule  Y Can be 'true' or 'false'
qty  Scheduled Quantity N Not required if autoSchedule is 'true'
due_dts  Due Date N Not required if autoSchedule is 'true'. If used enter in MM-DD-YYYY format.
duedt_uniq Due Date Unique Identifier Can be used in place of due_dts, must be unique. 

Example Strings

Add Auto Schedule

URL-?WoNo=WONO&autoschedule=true

JSON

{

'WoNo':'WONO',

'autoSchedule':'true'

}

A successful add should result in

{

$id: "1",

Code: 200,

Message: "WorkOrderSchedule added successfully.",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

DUEDT_UNIQ: "NCJZ0IQGNK",

WONO: "0000000410",

DUE_DTS: "2014-11-25T00:00:00",

QTY: 210,

AUTOSCHEDULE: true

}

}

Add manual schedule

URL-?WoNo=WONO&autoSchedule=false&due_dts=MM-DD-YYYY

JSON

{

'WoNo':'WONO',

'autoSchedue':'false',

'due_dts':'MM-DD-YYYY'

}

A successful add should result in

{

$id: "1",

Code: 200,

Message: "WorkOrderSchedule added successfully.",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

DUEDT_UNIQ: "69F6SVHN7L",

WONO: "0000000410",

DUE_DTS: "2014-11-07T00:00:00",

QTY: 0,

AUTOSCHEDULE: false

}

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an "Invalid API key" error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL the system will return an error describing it.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleAdd'."

}

Parameter Error

If there is an error with one of the entered parameters the system will return a Schedule Add Failed error message.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrderSchedule add failed.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2.2.2. WO Schedule Edit

Functions

Work Order Schedule Add API is used to edit existing schedule information on a Work Order

URL-{Root URL}/API/WOSchedule/Edit/{API Key}

Parameters

Parameters  Description Required Comment
WoNo  Work Order Number N  
autoSchedule Auto Schedule  Y Can be 'true' or 'false'
qty  Scheduled Quantity N Not required if autoSchedule is 'true'
due_dts  Due Date N Not required if autoSchedule is 'true'. If used enter in MM-DD-YYYY format.
duedt_uniq Due Date Unique Identifier Y Used to select Due Date information to edit. 

Example Strings

Edit Schedule

URL-?DueDt_Uniq=DueDt_Uniq&autoschedule=true

JSON

{

'dueDt_Uniq':'DueDt_Uniq',

'autoSchedule':'true'

}

A successful edit should result in

{

$id: "1",

Code: 200,

Message: "WorkOrderSchedule edited successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an "Invalid API key" error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL the system will return an error describing it.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleEdit/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleEdit'."

}

Missing Required Parameter

If a required parameter is missing the system will return an error message describing the missing parameter.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrderSchedule edit failed.Please provide DUEDT_UNIQ to edit work order schedule record.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Parameter Error

If one of the entered parameters is invalid the system will return an error message describing the problem.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrderSchedule edit failed.Work order schedule record for DUEDT_UNIQ does not exists ",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2.2.3. WO Schedule Get

Functions

Work Order Schedule Ge API is used to find and view existing schedule information on a Work Order

URL-{Root URL}/API/WOSchedule/Get/{API Key}

Parameters

Parameters  Description Required Comment
WoNo  Work Order Number Y  

Example Strings

Schedule Get

URL-?WoNo=WONO

JSON

{

'WoNo':'WONO'

}

A Successful Get Should result in

{

$id: "1",

Code: 200,

Message: "WorkOrderSchedule details:",

SessionId: null,

IsValidUser: true,

-ResponseObject: [

-{

$id: "2",

DUEDT_UNIQ: "69F6SVHN7L",

WONO: "410 ",

DUE_DTS: "2014-11-07T00:00:00",

QTY: 0,

AUTOSCHEDULE: false

}

]

}

Common Errors

Invalid API Key

If the entered API key is invalid the system will return an "Invalid API Key" Error Message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If the entered URL is invalid the system will return a "HTTP Error" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleGet/123456789?Wono=410'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleGet'."

}

Schedule Does Not Exist

If the requested schedule information doesn't exist the system will return a "Work Order Schedule does not exist" error message.

{

"$id": "1",

"Code": 403,

"Message": "WorkOrderSchedule does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.2.2.4. WO Schedule Delete

Functions

Work Order Schedule Delete API is used to remove existing schedule information from a Work Order

URL-{Root URL}/API/WOSchedule/Delete/{API Key}

Parameters

Parameters  Description Required Comment
duedtuniq Due Date Unique Identifier Y Used to select Due Date information to delete.

Example Strings

Edit Schedule

URL-?DueDtUniq=DUEDTUNIQ

JSON

{

'DueDtUniq':'DUEDTUNIQ'

}

A successful delete request should result in

{

"$id": "1",

"Code": 200,

"Message": "WorkOrderSchedule deleted successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an "Invalid API key" error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL the system will return an error describing it.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleDelete/123456789?duedtuniq=E8T6A1KF06'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleDelete'."

}

Parameter Error

If there is an error with one of the entered parameters the system will return a HTTP error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/WOScheduleDelete/123456789?duedtuniq=E8T6A1KF0'.",

"MessageDetail": "No type was found that matches the controller named 'WOScheduleDelete'."

}

1.3. KIT API
1.3.1. Kit Issue API

Kit Issue

Kit Issue API is used to issue parts from a warehouse into a Kit

URL-{Root URL}/API/Kit/Issue?{API Key}

Parameters

Parameter  Description Required Comment
WoNo  Work Order Number N  
KASEQNUM Unique Kitting Record Identifier  
WKey Pick From Warehouse Key   
PickQty Amount Being Picked Y  
IssuedSerialNo Serial Number for Picked Part N Required if part is serialized
IssuedSerialUniq  Unique Serial identifier  N Can be used in place of IssuedSerialNo
overIssuedSerialNo Serial Number for over-issued quantity N Only required if there is over-issued quantity
overIssuedSerialUniq Unique Serial identifier for over-issued quantity Only required if there is over-issued quantity
lotCode  Lot Code N Required if the part is lot coded
expDate Expiration Date and time N Required if the part is Lot Coded Format example: 2018-08-08 00:00:00
REFERENCE Issued Reference N Required if the part is Lot Coded Format Example: month/day/year
poNum Purchase Order Number N Part of the Lotcode Identification. Will not be empty if part was received by Purchase Order. But, can be left empty if the part was received by the way of general receiving. 
IpKeyUnique IP Key N

Example Strings

Kit Issue

URL-?KASEQNUM=KASEQNUM&WKey=WKEY&PickQty=QTY

JSON

{

'KASEQNUM':'KASEQNUM',

'WKey':'WKEY',

'PickQty':'QTY'

}

A successful request returns the following

{

"$id": "1",

"Code": 200,

"Message": "Kit issue successfull.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

URL Error

If there is an issue with the URL the system should return an error message showing that there is a problem with the URL

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/Kit/Pick/123456789'.",

"MessageDetail": "No action was found on the controller 'Kit' that matches the request."

}

Not Enough Quantity

If there is not enough quantity in the warehouse to issue the system will return a "Not Enough Quantity" Error

{

"$id": "1",

"Code": 403,

"Message": "Failed:Not enough quantity to pick.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Incorrect Parameter

If one of the parameters entered is incorrect then the system will return an error code describing which parameter has the error.

{

"$id": "1",

"Code": 403,

"Message": "Failed:KaMain record does not exists for Kaseqnum provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.3.2. Kit Update API

Kit Update

Kit Update API is used to update an existing Kit using a current BOM

URL-{Root URL}/API/Kit/Update/{API Key}

Parameters

Parameter  Description Required Comment
 WoNo Work Order Number Y WoNo is the only parameter required to update a kit.

Example Strings

Kit Update

URL-?wono=WONO

JSON

{

'WoNo':'WONO'

}

A successful request returns the following

{

"$id":"1",

"Code":200,

"Placeholder",

"SessionId":null,

"IsValidUser":true,

"ResponseObject":null

}

Common Errors

API Error

If there is a problem with the API Key the system will return an invalid API key message

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Incorrect Parameter

If the parameter used is incorrect the system will return an error code describing it.

{

"$id": "1",

"Code": 403,

"Message": "Failed:The Work Order Number does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Incorrect Parameter Name

If the parameter name used is incorrect the system will read it as a URL error and return a HTTP error message

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/Kit/Open/123456789?won=4101'.",

"MessageDetail": "No action was found on the controller 'Kit' that matches the request."

}

1.4. Shop Floor Tracking API

Shop floor tracking API is used to view where on the shop floor parts are currently being processed through. You can also use the API to transfer the parts between the different work centers of the shop floor. This allows the user to easily interact with the shop floor without having to navigate the MANEX Apps

1.4.1. Shop Floor Tracking Transfer

Transfer

The transfer function of the API is used to move the items of a work order between the different stages of the shop floor.

URL:{Root URL}/api/shopfloortracking/transfer/{API KEY}

Parameter Description  Required  Comment 
WoNo  Work Order Number Y  
FromDeptNumber From Department Number Y Department number where the product is being transferred from. Must be a whole number with no decimals. 
FromDeptKey From Department Key Y Department Key where the product is being transferred from
FromDeptUniqueRec From Department Unique Record Y Department Unique Record where the product is being transferred from
ToDeptNumber To Department Number Y Department Number where the product is being transferred to. Must be a whole number with no decimals. 
ToDeptKey To Department Key Y Department Key where the product is being transferred to
ToDeptUniqueRec To Department Unique Record Y Department Unique Record where the product is being transferred to
 transferQty Transfer Quantity  Y Amount to be transferred
serialNo Serial Number N Required if the part is serialized
fromActvKey From Activity Key N Activity level where the part is being transferred from. Only needed if the work order has activity tracking turned on. 
toActvKey To Activity Key N Activity level where the part is being transferred to. Only needed if the work order has activity tracking turned on. 
 WKey Warehouse Unique Record Identifier N Used to identify FGI when transferring to and from FGI. Required for a FGI transfer. If you have multiple locations, you will be able to provide 'Warehouse' and 'Location' if location is needed and the system will find the Wkey for you.


Example requests

Transfer, no lot code, no serialization

URL- ?Wono=WONO&fromDeptNumber=1&toDeptNumber=2&transferQty=1

JSON

{

'WoNo':'WONO',

'fromDeptNumber':'1',

'toDeptNumber':'2',

'transferQty':'1'

}

Transfer serialized

URL-?wono=WONO&fromDeptNumber=1&toDeptNumber=2&TransferQty=1&SerialNo=000000000000000000000000000000

JSON

{

'WoNo':'WONO',

'fromDeptNumber':'1',

'toDeptNumber':'2',

'TransferQty':'1',

'SerialNo':'000000000000000000000000000000'

}

A successful transfer returns the following

{

"$id":"1",

"Code":200,

"Message":"Shop Floor Tracking transfer successfull.",

"SessionId":null,

"IsValidUser":true,

"ResponseObject":null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

JSON or URL Error

If there is an error with the URL used or some part of the JSON string the system will return a HTTP error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShopFlooTracking/Transfer/123456789?won=4101'.",

"MessageDetail": "No type was found that matches the controller named 'ShopFlooTracking'."

}

Invalid Work Center

If one of the entered work centers is incorrect or does not exist for the work order then the system will return an error describing an invalid work center.

{

"$id": "1",

"Code": 403,

"Message": "Failed:The From and To Work Center/Activity (number/deptkey/uniquerec/actvkey) is not valid.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Bad Work Order

If the entered work order is invalid or does not exist the system will return an error message describing the Work Order error.

{

"$id": "1",

"Code": 403,

"Message": "Failed:The Work Order Number does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

​Permissions 

​The user needs the following checked on ManexCloud for permissions in order to use this API.

"Ignore Forced Routing Steps" needs to be checked for the user. See image below



1.4.2. Shop Floor Tracking Get
Shop Floor Tracking Get API allows you to quickly view the status of work orders on the shop floor. 

Get

The Get function of the shop floor tracking API allows you to view the stages of the shop floor for a selected work order.

URL:{Root URL}/api/shopfloortracking/get/{API KEY}

Parameter Description Required Comment
WoNo Work Order Number Y  
includeActivities Choose whether to include all activities of the shop floor N  Can be 0 or 1, default 0
includeSerialInformation Show all serial information with the results  N  Can be 0 or 1, default 0
serialNo  Show all information related to a specific
serial number 
N Can be empty, if used must be padded with '0' up to 30 characters 
Dept_id  Department ID Name  This value can be used to narrow the results to show a specific department 
deptKey Department Key  This value can be used to narrow down the results to show a specific department 

Example request:(Note that provided example strings are for demonstration only and will not work with your system)

URL- ?Wono=393

JSON

{

'WoNo':'393'

}

Results in the following information

{

"$id":"1",

"Code":200,

"Message":"Shop Floor Tracking details:",

"SessionId":null,

"IsValidUser":true,

"ResponseObject":{

"$id":"2",

"SerializedDeptQtyList":null,

"DeptQtyList": [{

"$id":"3",

"WONO":"0000000393",

"DEPT_ID":"PP-T",

"Dept_Name":"PICK & PLACE SMT,TOP SIDE",

"CURR_QTY":0.0,

"NUMBER":5.0,

"DeptKey":"_26G0V7PBG",

"SERIALSTRT":true

},{

"$id":"4",

"WONO":"0000000393",

"DEPT_ID":"ATE ",

"Dept_Name":"ATE/BURN-IN OF COMPONENTS",

"CURR_QTY":0.0,

"NUMBER":2.0,

"DeptKey":"_26G0V7MLP",

"SERIALSTRT":false

},{

"$id":"5",

"WONO":"0000000393",

"DEPT_ID":"STAG",

"Dept_Name":"Material Staging ",

"CURR_QTY":100.0,

"NUMBER":1.0,

"DeptKey":"_2600WHEBG",

"SERIALSTRT":false

},{

"$id":"6",

"WONO":"0000000393",

"DEPT_ID":"WAVE",

"Dept_Name":"Wave Soldering ",

"CURR_QTY":0.0,

"NUMBER":4.0,

"DeptKey":"_26G0V7OJE",

"SERIALSTRT":false

},{

"$id":"7",

"WONO":"0000000393",

"DEPT_ID":"AI ",

"Dept_Name":"AUTO INSERT-THT COMPONENT",

"CURR_QTY":0.0,

"NUMBER":3.0,

"DeptKey":"_26G0V7NN6",

"SERIALSTRT":false

},{

"$id":"8",

"WONO":"0000000393",

"DEPT_ID":"SCRP",

"Dept_Name":"Scrapped Material ",

"CURR_QTY":0.0,

"NUMBER":7.0,

"DeptKey":"_2600WHEBI",

"SERIALSTRT":false

},{

"$id":"9",

"WONO":"0000000393",

"DEPT_ID":"FGI ",

"Dept_Name":"Finished Goods Inventory",

"CURR_QTY":0.0,

"NUMBER":6.0,

"DeptKey":"_2600WHEBH",

"SERIALSTRT":false

}],

"SftAdditionalDetails":null

}

}

Common Errors

URL Error

If there is an error in 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/ShopFlooTracking/Get/123456789?wono=410'.",

"MessageDetail": "No type was found that matches the controller named 'ShopFlooTracking'."

}

API Key Error

If there is an error with the API key the system will return an error describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Invalid Parameter

If there is an error with a Parameter value the system will return an error message detailing it.

{

"$id": "1",

"Code": 403,

"Message": "Failed:Please provide valid work order number",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.5. Inventory Handling API

Inventory handling API is used to move items between warehouses, receive parts into warehouses, and issue parts from warehouses. 

1.5.1. Inventory Handling Receive API

Functions

Receiving API is used to receive items into Inventory.

URL: {Root URL}/API/InventoryHandling/receive/{API Key}

Parameters

Parameters Description Required Comment
Part_sourc Source of the Part Y Can be 'MAKE', 'BUY', or 'CONSG'
uniq_key Use to identify the part Y When uniq_key is used you do not need part_no
part_no Part number you wish to transfer Y Part_no can be used if you do not have the uniq_key
revision Part revision level N Required when you use part_no if the part has a revision
custpartno Customer Part Number N Use instead of part_no if the part_sourc is CONSG
custrev Customer revision level N Required if custpartno is used and the part has a revision
Partmfgr Part Manufacturer N Used to specify part manufacturer
Mfgr_pt_no Manufacturer part number N Used with partmfgr
Uniqmfgrhd Manufacturer identification N Can be used in place of partmfgr and mfgr_pt_no.
Warehouse Warehouse Name Y Choose which warehouse the part will be received into.
Location Location Name N Used when the part is being received into a specific location in the warehouse.
Uniqwh Warehouse identifier Y Choose which warehouse the part will be received into. Can be used in place of warehouse. Needs location.
WhNo Warehouse Number Y Choose which warehouse the part will be received into. Can be used in place of warehouse and uniqwh. Needs location.
W_Key Inventory Unique Identifier Key Y Choose which warehouse the part will be received into.
LotcodeAndSerialNo
Lot Code or Serialized N Required if the part is lotcoded or Serialized
expDate Expiration Date N Required if the part is lot coded. Use MM-DD-YYYY format.
internalLotReference Internal Lot Reference N Only needed if the part is lot coded
cserialNo Serial No N Required of the part is serialized
QtyRec Received Quantity Y The amount of the part you are receiving
qtyPerPackage
Reason Reason for transfer Y Can be: 'BEGINNING RAW MATL. INV.', 'CONSIGNED MATERIAL', 'FREE SAMPLES', 'MATERIAL ON TRIAL', 'REPAIR RETURN FROM VENDOR', 'WARRANTY REPLACEMENT'
gl_nbr General Ledger Number Y Used to add a record of the transaction to the general ledger
transactionReference Transaction Reference Y User defined field

Example Strings

No Lot Code, No Serialization

URL- ?part_sourc=BUY&part_no=PARTNUMBER&revision=REVISION&W_Key=WKEY&QtyRec=1&reason=CONSIGNED MATERIAL&TransactionReference=New Customer Inventory&Gl_Nbr=GENERALLEDGERNUMBER

JSON-

{

'part_sourc':'BUY',

'part_no':'PARTNUMBER',

'revision':'REVISION',

'W_Key':'WKEY',

'QtyRec':'1',

'reason':'CONSIGNED MATERIAL',

'transactionReference':'New Customer Inventory',

'Gl_Nbr':'GENERALLEDGERNUMBER'

}

Lot Code, Serialization

URL- ?part_sourc=BUY&UNIQ_KEY=UNIQKEY&LotCodeAndSerialNo=LOTCODE@SERIALNUMBER&EXPDATE=MM-DD-YYYY&W_Key=WKEY&QtyRec=1&reason=CONSIGNED MATERIAL&transactionReference=New Customer Inventory&Gl_Nbr=0000000-00-00

JSON-

{

'part_sourc':'BUY',

'UNIQ_KEY':'UNIQKEY',

'lotCodeAndSerialNo':'LOTCODE@SERIALNUMBER',

'EXPDATE':'MM-DD-YYYY',

'W_Key':'WKEY',

'QtyRec':'1',

'reason':'CONSIGNED MATERIALS',

'transactionReference':'New Customer Inventory',

'Gl_Nbr','0000000-00-00'

}

 

Lot Code with Multiple Serial Numbers 

"LotcodeAndSerialNo":"LotCode1@1230120,234455,33333" 

 

Lot Code, No Serialization

Example 1: user provides uniq_key, uniqmfgrhd, no part-no and no mpn

{
 "Part_Sourc":"BUY",
    "uniq_key":"_01F15SZAH",
    "uniqmfgrhd":"_01F15T9BZ",
    "WareHouse" :"MAIN1",
    "Location":"",
    "QtyRec":"16",
    "expDate":"09/04/2017",
 "REFERENCE":"test21",
    "GL_NBR":"1430000-00-00",
    "LotcodeAndSerialno":"Lot-10"

}
Example 2:  User provides uniq_key, uniqmfgrhd, and mpn

{
 "Part_Sourc":"BUY",
    "uniq_key":"_01F15SZAH",
    "uniqmfgrhd":"_01F15T9BZ",
    "partmfgr":"AVX",
    "WareHouse" :"MAIN1",
    "Location":"",
    "QtyRec":"15",
    "mfgr_pt_no":"CR10-2610FT",
 "expDate":"09/04/2017",
 "REFERENCE":"test21",
    "GL_NBR":"1430000-00-00",
    "LotcodeAndSerialno":"Lot-09"
}
Example 3:  user provides Part_no, revision, MPN, no uniq_key,uniqmfgrhd

{
 "Part_Sourc":"BUY",
    "Part_No":"101-0001707",
    "Revision":"",
    "partmfgr":"AVX",
    "WareHouse" :"MAIN1",
    "Location":"",
    "QtyRec":"1",
    "mfgr_pt_no":"CR10-2610FT",
   "expDate":"09/04/2017",
   "REFERENCE":"test21",
    "GL_NBR":"1430000-00-00",
    "LotcodeAndSerialno":"Lot-09"
}

 

No Lot Code, Serialized

URL- ?Part_sourc=BUY&part_no=PARTNUMBER&lotcodeAndSerialNo=000000000000000000000000000000&W_KEY=WKEY&QtyRec=1&reason=CONSIGNED MATERIAL&transactionReference=New Customer Inventory&Gl_Nbr=0000000-00-00

JSON

{

'part_sourc':'BUY',

'part_no':'PARTNUMBER',

'lotCodeAndSerialNo':'000000000000000000000000000000',

'W_Key':'WKEY',

'QtyRec':'1',

'reason','CONSIGNED MATERIAL',

'transactionReference':'New Customer Inventory',

'Gl_Nbr':'0000000-00-00'

}

Successful requests should return the following:

{

"$id":"1",

"Code":200,

"Message":"Inventory added 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

}

Incorrect Parameter

If an incorrect parameter value is used the system will return an error describing the incorrect parameter.

{

"$id": "1",

"Code": 403,

"Message": "Failed:Please provide valid GL_NBR.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

 

The GL_nbr parameter for the "Receive" API has to be on the list for the Inventory Handling GL Defaults for  'Receiving'. 



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'."

}

 

​Keep in mind that if you were to create a new location when transferring you need the following checked.

Inventory Control Management Module, the MFGR that you creating the new location under, needs to have "Allow Auto Creating Location at Receiving" checked.  


Under Sql Setting the warehouse you are receiving into also needs " Allow Auto Create Location at Receiving" checked. 

1.5.2. Inventory Handling Transfer API

Functions

Transfer API is used to transfer items between warehouses.

URL: {Root URL}/API/InventoryHandling/Transfer/{API Key}

Parameters

Parameter Description Required Comment
fromIpKey
SerialNo  Serial Number for the part Y/N Required if the part is serialized
Source of the Part Y Can be 'BUY', 'MAKE', 'CONSG'
uniq_key Identifier for the part Y
part_no Part Number you wish to transfer Y Part_no can be used instead of uniq_key
revision Part Revision Level N Required when using part_no and the part has a revision level
custPartNo Customer Part Number Y/N 
custRev Customer Revision Level N Required when using custPartNo if the part has a revision level
partMfgr Part Manufacturer Y Used to choose the manufacturer of the part when there are multiple manufacturers in the system.
mfgr_pt_no Manufacturer Part Number Y Used in place of partMfgr to choose manufacturer.
uniqmfgrhd Manufacturer Identification N Used in place of partMfgr and mfgr_pt_no to choose manufacturer.
fromWarehouse  Warehouse where the item will be transferred from Y
fromLocation Location where the part will be transferred from N Used when the selected warehouse also has location information assigned to it.
fromWhNo From Warehouse number N Choose transfer from warehouse by number
fromW_Key From Unique Inventory Identifier Key N Selects warehouse, does not require location information
lotCode Lot Code N Required if the part is Lot Coded, use MM-DD-YYYY format
expDate Expiration Date N Required when the part is Lot Coded
internalRef  Internal Lot Reference N Lot Code Reference. Only needed when the part is lot coded
poNum Purchase order Number N Only needed if the part is lot coded. Not needed unless the part was received through purchasing
transferredQuantity Quantity you are transferring Y
reason Reason for Transfer Y Here are some examples 'ENGINEERING TESTING','PRODUCTION CALIBRATION','PRODUCTION TESTING','PROTOTYPE FOR RESALE','PROTOTYPE TO BE SCRAPPED','SPECIAL PROJECTS' . See below for how to add or change your reasons in your system settings.
WoNo Work Order Number N Should remain empty unless created by KIT API
TransRef Transaction Reference N User defined field. Transfer Reference
toIPKEY Transfer to IPKEY N
toMRB Transfer Items to MRB N Can be '1' or '0'. If '1' then parts will be transferred to MRB and no other warhouse information is required
toWarehouse Warehouse where the items will be transferred to Y Selects which warehouse the items will be transferred to. Requires location if the warehouse has location information.
toLocation Warehouse Location N Selects which location the items will be transferred into. Required if the warehouse has location information available
toUniqWh Warehouse Unique Identifier N Can be used instead of toWarehouse
toWhNo To Warehouse Number N Can be used instead of toWhNo
toW_Key Warehouse Unique Identifier N Can be used in place of toWarehouse, toUniqWh, toWhNo

​Example Strings

No Lot Code, no Serialization

URL-?part_sourc=BUY&uniq_key=UNIQKEY&fromW_Key=WKEY&transferredQuantity=1&toW_key=WKEY&reason=SPECIAL PROJECTS&transactionReference=test

JSON-

{

'part_sourc':'BUY',

'uniq_key':'UNIQKEY',

'fromW_Key':'WKEY',

'transferredQuantity':'1',

'toW_Key':'WKEY',

'reason':'SPECIAL PROJECTS'

}

OR

{

 "Part_No":"partnumber",

"revision":"revision",

"PARTMFGR":"partmfgr",

"MFGR_PT_NO":"MFGRpartnumber",

"FromWarehouse":"Warehouse",

"FromLocation":"location",

"ToWarehouse":"Warehouse",

"ToLocation":"Location",

"TransferredQuantity":"quantity",

 "Part_Sourc" :"BUY",

 "Reason": "PRODUCTION TESTING"

}

Lot Code, no serialization 

{

 "Part_No":"Partnumber",

"revision":"revision",

"PARTMFGR":"PartMFGR",

"MFGR_PT_NO":"MFGRpartnumber",

"FromWarehouse":"warehouse",

"FromLocation":"location",

"ToWarehouse":"Warehouse",

"ToLocation":"location",

"TransferredQuantity":"Quantity",

 "Part_Sourc" :"BUY",

 "Reason": "PRODUCTION TESTING",

 "lotcode":"Lot Code",

 "Expdate":"Expdate",

 "Reference":"Reference",

 "Ponum":"POnumber"

 

}

 Lot Code, Serialization

URL- ?Part_sourc=BUY&uniq_key=UNIQKEY&lotcode=LOTCODE&expDate=MM-DD-YYYY&serialNo=000000000000000000000000000001&fromW_Key=WKEY&toW_Key=WKEY&transferredQuantity=1&reason=PRODUCTION TESTING&transactionReference=REFERENCE

JSON-

{

'part_sourc':'BUY',

'uniq_key':'UNIQKEY',

'lotcode':'LOTCODE',

'expDate':'MM-DD-YYYY',

'serialNo':'000000000000000000000000000000',

'fromW_Key':'WKEY',

'toW_Key':'WKEY',

'transferredQty':'1',

'reason':'PRODUCTION TESTING',

'Reference':'REFERENCE'

}

Transfer to MRB

URL- ?Part_sourc=BUY&uniq_key=UNIQKEY&fromW_Key=WKEY&toMRB=1&transferredQuantity=10&reason=PROTOTYPE TO BE SCRAPPED&transactionreference=test 

JSON-

{

'part_sourc':'BUY',

'uniq_key':'UNIQKEY',

'fromW_Key':'WKEY',

'toMRB':'1',

'transferredQty':'10',

'reason':'PROTOTYPE TO BE SCRAPPED',

'Reference':'test'

}

If successful each of the following should result in the following return:

{

"$id":"1",

"Code":200,

"Message":"Inventory transfer successfull.",

"SessionId":null,

"IsValidUser":true,

"ResponseObject":null

}

Common Errors

API Key Error

If there is an error with the API Key the system will return an error describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"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": "Failed:Please provide valid GL_NBR.",

"SessionId": null,

"IsValidUser": true,

"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'."

}

 

 

Here is an example of a transfer that went through successfully.




​Keep in mind that if you were to create a new location when transferring you need the following checked.

Inventory Control Management Module, the MFGR that you are creating the new location under, needs to have "Allow Auto Creating Location at Receiving" checked.  


Under Sql Setting the warehouse you are receiving into also needs " Allow Auto Create Location at Receiving" checked. 


Reason

You can change , add or edit your reason under the system settings. See below image. 

1.5.3. Inventory Handling Issue API

Functions

Issue API is used to issue parts from a warehouse 

URL: {Root URL}​/API/InventoryHandling/Issue/{API Key}

Parameter Description Required Comment
 IPKEY The IPKEY is used to select a part N The IPKEY can be used as the main identifier for the part. If used other parameters will be used to validate the IPKEY
serialNo Serial Number N Required if the part being issued is serialized
serialUniq Serial Information N Alternative to serialNo
part_sourc Part Source Y Can be 'BUY','MAKE',or 'CONSG'
UNIQ_KEY Part Identification Key N Can be used to choose the product.
part_no Part Number Y
Revision Part's Revision Level N Required if the selected part has a revision level
custPartNo Customer Part Number N Used if part source is 'CONSG'
custRev Customer Part Revision Level N Used with custPartNo if the part has a revision level
partMfgr Part Manufacturer N Used to specify which manufacturer the part will come from
mfgr_pt_no Manufacturer's Part Number N Used to specify which manufacturer the part comes from
uniqmfgrhd Manufacturer Part Unique Identifier N Used to specify which manufacturer the part comes from
warehouse Warehouse Name Y Select which warehouse the part will be issued from
location Warehouse Location N Choose the warehouse location the part will be issued from if there is one assigned
uniqWh Warehouse ID Number N Can be used instead of warehouse
W_Key Inventory Unique Identifier N Can be used to specify both warehouse and location
lotCode Lot Code N Required if the selected part is lot coded
expDate N Required if the part is lot coded. Use MM-DD-YYYY format
reference Lot Reference N Can only be used if the part is lot coded
poNum Purchase Order Number N Used only if there is lot code information. Not needed if the part was received through inventory handling
issuedQuantity Issued Quantity Y Amount to be issued
issueTo Where the part will be issued Y User Defined
gl_nbr General Ledger Number for the Transaction Y Not required if the part source is 'CONSG'
WoNo Work Order Number <n<> </n<> Should remain empty unless created by KIT API
reason Reason for Issue Y Can be 'INVENTORY ADJUSTMENTS', 'SCRAP', 'INSTORE ISSUES', 'RETURNS TO VENDORS FROM STOCK'
transactionReference Transaction Reference N User Defined field
inStorReturn      
deptKey Shop Floor Department Key N Used when issuing a part back to WIP from FGI
actvKey Shop Floor Activity Key Used when issuing a part back to WIP from FGI
fk_userid User ID N

Example Strings

Issue no lot code, no serialization.

URL-?part_sourc=buy&uniqmfgrhd=UNIQMFGRHD&uniq_key=UNIQKEY&warehouse=WAREHOUSE&location=LOCATION&IssuedQuantity=1&issueTo=ISSUETO&gl_nbr=0000000-00-00

JSON-

{

'part_sourc':'BUY',

'uniqmfgrhd':'UNIQMFGRHD',

'uniq_key':'UNIQKEY',

'warehouse':'WAREHOUSE',

'location':'LOCATION',

'issuedQuantity':'1',

'issueTo':'ISSUETO',

'gl_nbr':'0000000-00-00'

}

Issue Serialized

URL-?part_sourc=buy&uniqmfgrhd=UNIQMFGRHD&uniq_key=UNIQKEY&serialNo=000000000000000000000000000000&warehouse=WAREHOUSE&location=LOCATION&IssuedQuantity=1&issueTo=ISSUETO&gl_nbr=0000000-00-00

JSON-

{

'part_sourc':'BUY',

'uniqmfgrhd':'UNIQMFGRHD',

'uniq_key':'UNIQKEY',

'serialNo':'000000000000000000000000000000',

'warehouse':'WAREHOUSE',

'location':'LOCATION',

'issuedQuantity':'1',

'issueTo':'ISSUETO',

'gl_nbr':'0000000-00-00'

}

Successful requests should return the following

{

"$id":"1",

"Code":200,

"Message":"Inventory added successfully.",

"SessionId":null,

"IsValidUser":true,

"ResponseObject":null

}

Issue lot code, no serialization.

Note:  If record is lot coded the PONUM is an integral part of the LOT code. Since we will allow the user to enter the same lot code when receiving on a different PO.  You need to provide the PONUM in the string or it will more than likely fail because the PONUM has not been provided as part of the Lot code information 

{
 "Gl_nbr":"1490000-00-00",
 "transactionReference":"PI Adjustment",
 "issuedQuantity":"5000",
 "issueTo":"PI Adjustment",
 "part_sourc":"Buy",
 "uniq_key":"_3WE0OVX9A",
 "uniqmfgrhd":"_3WE0OVX9F",
 "location":"53J-05",
 "warehouse":"STKRM1",
 "lotcode":"6733527",
 "Reference":"",
 "expdate":"01-22-2022",
 "ponum":"000000000129005",
 "reason":"Inventory Adjustment"
}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message describing a failed API key

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"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": "Failed:Please provide valid GL_NBR.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

 

The GL_nbr parameter for the "issue" API has to be on the list for the Inventory Handling GL Defaults for 'Issue'. 


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'."

}

1.6. Purchase Order API
Purchase Order API allows you to easily interact with purchase orders outside of the ManEx Applications. There are three different levels of the PO API, this allows you to specifically interact with the different aspects of the PO without having to rework all parts. The three different levels are PO main, PO item, and PO item schedule. 
1.6.1. PO Main API

Purchase Order API allows you to easily interact with purchase orders outside of the ManEx Applications. There are three different levels of the PO API, this allows you to specifically interact with the different aspects of the PO without having to rework all parts. The three different levels are PO main, PO item, and PO item schedule. 

 

 

1.6.1.1. PO Main Add

The PO add function is used to add a new PO. An item must be added to the PO tables as well. Scheduling does not need to be added at this point.

URL-{Root URL}/api/PO/Add/{API KEY}

Parameters

Parameter Description Required Comment
supName Supplier Name Y  
confirmName Confirm Name N User Input, No validation
poDate Purchase order date. N If not entered manually will default to today’s date
FreightIncluded Freight Included N Can be 1 or 0, default is 0.
buyerName Name of the Buyer N Has to be entered in the following format [LastName, FirstName]. Must be a buyer in the system.
remitToLink The link to the Remit to address N If entered it must be a valid link.
confirmToLink The link to the Confirm to Address N
receiveToLink The link to the receiving address N If entered it must be a valid link
deliveryTime The delivery time for the receiving address N Must be in a 24 hour format, e.g. ‘13:00’
Terms Payment terms for the supplier. N Can be NET 10, NET 15, NET 30, NET 30/2% 10, NET 45, COD, NONE
FOB   N  
shipVia The method of shipping N  
shipCharge
N  
shippingAmount   N Default 0, Entered manually
isShippingTaxable Choose whether or not the shipping is taxable N Can be 0 or 1, default 0
shippingTaxPct The amount of the shipping tax N Default 0.00. If a value is entered here isShippingTaxable must be set as 1
billToLink This links the record to the supplier's billing address. N If entered, it has to be a valid link.
POItemsList N 
POITTYPEPurchase Order Item Type
YCan be INVT PART, MRO, or Services
part_no
Part Number
Y
Used to choose a part
UNIQ_KEY
Part Identifier Key
N
Can be used instead of part number and revision
RevPart Revision
NRequired if Part_no is used
UniqMfgrhdManufacturer Key
NCan be used in place of partmfgr and mfgr_pt_no
PARTMFGRPart Manufacturer
NCan be used to specify a manufacturer for a part. Must be an existing manufacturer for the part
MFGR_PT_NOManufacturer Part Number
NCan be used instead of part_no to choose an item
ORD_QTYOrder Qty
YThe amount ordered
PoitschdList N 
SCHD_QTYScheduled Qty
NMust be equal to or less than order quantity
SCHD_DATESchedule DateNWill default to current date or enter in MM-DD-YYYY format

Example PO Add String-

URL-{Root URL}/api/PO/Add/{API Key}

JSON

{

"supName":supName",

"PoItemsList":

[{

"POITTYPE":"POITTYPE",

"UNIQ_KEY":"UNIQ_KEY",

"part_no":"part_no",

"Rev":"Rev",

"UniqMfgrhd":"UniqMfgrhd",

"PARTMFGR":"PARTMFGR",

"MFGR_PT_NO":"MFGR_PT_NO",

"ORD_QTY":"ORD_QTY",

"PoitschdList":

[{

"SCHD_QTY":"SCHD_QTY",

"SCHD_DATE":"SCHD_DATE"

}]

}]

}

1.6.1.2. PO Main Edit

The PO add function is used to add a new PO. An Item must be added to the PO tables as well. Scheduling does not need to be added at this point.

URL-{Root URL}/api/PO/Edit/{API KEY}

Parameters

Parameter Description Required Comment
supName Supplier Name Y  
confirmName Confirm Name N User Input, No validation
poDate Purchase order date. N If not entered manually will default to today’s date
FreightIncluded Freight Included N Can be 1 or 0, default is 0.
buyerName Name of the Buyer N Has to be entered in the following format [LastName, FirstName]. Must be a buyer in the system.
remitToLink The link to the Remit to address N If entered it must be a valid link.
confirmToLink The link to the Confirm to Address N
receiveToLink The link to the receiving address N If entered it must be a valid link
deliveryTime The delivery time for the receiving address N Must be in a 24 hour format, e.g. ‘13:00’
Terms Payment terms for the supplier. N Can be NET 10, NET 15, NET 30, NET 30/2% 10, NET 45, COD, NONE
FOB   N  
shipVia The method of shipping N  
shipCharge N  
shippingAmount   N Default 0, Entered manually
isShippingTaxable Choose whether or not the shipping is taxable N Can be 0 or 1, default 0
shippingTaxPct The amount of the shipping tax N Default 0.00. If a value is entered here isShippingTaxable must be set as 1
billToLink This links the record to the supplier's billing address. N If entered it has to be a valid link.

Example Strings

PO Add String

URL-?poNUM=PONUMBER&supName=SUPPLIERNAME&POUNIQUE=POUNIQUE

JSON

{

'PoNUM':'PONUMBER',

'supName':'SUPPLIERNAME',

'POUNIQUE':'POUNIQUE',

}

A successful request should result in

{

$id: "1",

Code: 200,

Message: "Purchase Order edited successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

Incorrect Parameters

If there is an error with an entered parameter the system should return a message detailing which parameter there is a problem with.

{

"$id": "1",

"Code": 403,

"Message": "Purchase Order edit failed.UniqSupNo does not exists in SUPINFO Table.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

JSON Error

If there is an error in the JSON string the system will return the following error message.

{

"$id": "1",

"Code": 403,

"Message": "'Purchase Order' Object is not initialized properly.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.6.1.3. PO Main Get

Function

The get function of the PO Main can be used to search the databases for POs based on a variety of parameters.

URL: {Root URL}/api/PO/Get/{API Key}

Parameters

Parameter  Description Required Comment
poNum Purchase Order Number N
supName Supplier Name N Name of the supplier the PO is going to.
uniqSupNo Unique Supplier Identifier Number N Can be used in place of supplier name
partNo  Part Number N Find Purchase Orders containing the part number
revision Part Revision N Used alongside part number
uniqKey Part Unique Identifier  N Used in place of part number and revision
uniqlnno Unique N  
poStatus  Purchase Order Status N Can be Open, Cancelled, Closed
mfgrPtNo Manufacturer Part Number N  
partmfgr Part Manufacturer  N  
withBalance   N  
received  PO Received or Not  N Can be true or false
scheduledPriorTo POs Scheduled Before Date  N Use MM-DD-YYYY format

Example Strings

Purchase Order 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 purchase order details the system will return

{

"$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

}

1.6.2. PO Items API
1.6.2.1. PO Item Add

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  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  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

}

1.6.2.2. PO Item Edit

Functions

URL-{Root URL}/API/PO/ItemEdit/{API Key}

Parameters

 Parameter Description Required Comment
poNum  Purchase Order Number Y
uniqueLnNo  Unique PO Item Identifier Y  
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  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  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&UNIQLNNO=UNIQLNNO&costeach=10&ord_qty=1'

JSON

{

'poNum':'PONUMber',

'UNIQLNNO':'UNIQLNNO',

'costeach':'10',

'ord_qty':'1'

}

A successful request should result in

{

$id: "1",

Code: 200,

Message: "PO Items edited successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

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

}

1.6.2.3. PO Item Delete

Functions

PO Delete Item API is used to remove existing items from Purchase Orders.

URL-{Root URL}/API/PO/ItemDelete/{API Key}

Parameters

Parameter  Description Required Comment
PoNum  Purchase Order Number        
itemNumber Item Number  N Used to choose which item to delete from the PO 
part_no  Part Number N Used to choose which item to delete from the PO
revision Part Revision Used with Part_no to choose an item. 
uniq_key Part Unique Identifier  N Can be used instead of part_no and revision
partMfgr Part Manufacturer N Can be used to choose item to delete from PO by part manufacturer
mfgr_pt_no Manufacturer Part Number  N Used with partMfgr.
uniqmfgrhd Unique manufacturer part identifier N Can be used in place of mfgr_pt_no and uniqmfgrhd
uniqlnno  Unique PO item Identifier N Can be used in place of part_no or partMfgr

 

Example Strings

Delete Item

URL-?PoNum=PONUMBER&UNIQLNNO=UNIQLNNO

JSON

{

'poNum':'PONUMBER'

'UNIQLNNO':'UNIQLNNO'

}

A successful request should return

{

$id: "1",

Code: 200,

Message: "PO Items deleted successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

Incorrect Parameter

If a parameter is incorrect the system will return an error message describing the error

{

"$id": "1",

"Code": 403,

"Message": "PO Items delete failed.Po Item does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return the following error message

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/PO/ItemDelet/123456789'.",

"MessageDetail": "No action was found on the controller 'Po' that matches the name 'ItemDelet'."

}

1.6.2.4. PO Item Get API

Functions

PO Item Get API is used to get information about the items on existing Purchase Orders

URL-{Root URL}/PO/ItemGet/{API Key}

Parameters

Parameter  Description Required Comment
poNum Purchase Order Number N  
supplierName Supplier Name N Can be used to sort POs by supplier
uniqsupno Supplier Identification Number N Can be used in place of supplier name
partNo Part Number N Can be used to sort POs by part
revision Part Revision N Used alongside partNo
uniqKey Part Unique Identifier N Can be used in place of art number and revision
uniqlnno    
poStatus Purchase Order Status  N Can be Open, Cancelled, Closed 
mfgrPtNo Manufacturer Part Number  Can be used to sort POs by manufacturer part number
partmfgr Part Manufacturer N Can be used to sort POs by Manufacturer
withBalance POs with Balace N Can be true or false
received PO Received N Can be true or false
scheduledPriorTo    

Example Strings

Get Item

URL-?PoNum=PONUMBER

JSON

{

'PoNum':'PONUMBER'

}

A successful request should return

{

$id: "1",

Code: 200,

Message: "PO Items details:",

SessionId: null,

IsValidUser: true,

-ResponseObject: [

-{

$id: "2",

UNIQLNNO: "_1ZM0LAXRD",

PONUM: "000000000001749",

UNIQ_KEY: "_4750SWEOD",

ITEMNO: "001",

COSTEACH: 0.88,

ORD_QTY: 100,

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,

DESCRIPT: "",

PARTMFGR: "GENR",

MFGR_PT_NO: "",

PACKAGE: "BULK",

PART_CLASS: "",

PART_TYPE: "",

U_OF_MEAS: "EACH",

PUR_UOFM: "EACH",

S_ORD_QTY: 100,

ISFIRM: false,

UNIQMFGRHD: "_4750SXAYM",

FIRSTARTICLE: false,

INSPEXCEPT: false,

INSPEXCEPTION: "",

INSPEXCINIT: "",

INSPEXCDT: null,

INSPEXCNOTE: "",

INSPEXCDOC: "",

LCANCEL: false,

UNIQMFSP: "",

INSPECTIONOTE: "",

lRemvRcv: false,

POSTATUS: "OPEN",

PODATE: "2014-10-31T13:49:00",

Part_No: "416-110989",

Revision: "b",

Part_Sourc: "BUY",

Supname: "Romp",

Status: "APPROVED",

SUP_TYPE: "INDEPENDENT REP",

Supid: "0000000005"

}

]

}

Common Errors

Not Enough Information

If there is not enough data provided or the parameters provided are invalid to retrieve the PO information the system will return the following error message.

{

"$id": "1",

"Code": 403,

"Message": "PO Items details failed:Not enough information to return the data, please provide valid parameters.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.6.3. PO Schedule API
1.6.3.1. PO Schedule Add

Functions

Schedule add API is used to add scheduling information to existing Purchase Orders.

URL-{Root URL}/API/PO/ScheduleAdd/{API Key}

Parameters


Parameter Description Required Comment
poNum  Purchase Order Number Y
uniqLnNo  PO Unique item identifier Y  
schd_date Schedule Date N Will default to current date or enter in MM-DD-YYYY format. 
req_date  Required Date  N Will default to current date or enter in MM-DD-YYYY format. 
schd_qty Scheduled Quantity  Y Must be equal to or less than order quantity. 
warehouse  Warehouse  N Warehouse where the item will be received into
location Warehouse Location N Used with warehouse to designate a location. 
origcommitdt  Commit Date N Will default to current date or enter in MM-DD-YYYY Format.
schdNotes Schedule Notes N Can be used to attach a schedule note to the PO. 

Example Strings

Add Schedule Information

URL-?poNum=PONUMBER&uniqLnNo=UNIQLNNO&SCHD_DATE=MM-DD-YYYY&REQ_DATE=MM-DD-YYYY&SCHD_QTY=QTY&Warehouse=WAREHOUSE&LOCATION=LOCATION&ORIGCOMMITDT=MM-DD-YYYY&SCHDNOTES=NOTE

JSON

{

'poNum':'PONUMBER',

'uniqLnNo':'UNIQLNNO',

'SCHD_DATE':'MMM-DD-YYYY',

'REQ_DATE':'MMM-DD-YYYY',

'SCHD_QTY':'QTY',

'Warehouse':'WAREHOUSE',

'LOCATION':'LOCATION',

'ORIGCOMMITDT':'MMM-DD-YYYY',

'SCHDNOTES':'NOTE'

}

A successful add should result in

{

$id: "1",

Code: 200,

Message: "PO Schedule added successfully.",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

UNIQDETNO: "O2YHUQB45I",

UNIQLNNO: "_47A0PHH67",

SCHD_DATE: "2014-11-07T00:00:00",

REQ_DATE: "2014-11-07T00:00:00",

SCHD_QTY: 5,

RECDQTY: 0,

BALANCE: 5,

GL_NBR: "",

REQUESTTP: "Invt Recv",

REQUESTOR: "",

UNIQWH: "",

LOCATION: "",

WOPRJNUMBER: "",

COMPLETEDT: null,

PONUM: "1751",

ORIGCOMMITDT: "2014-11-04T00:00:00",

SCHDNOTES: "test",

UNIQMFGRHD: "_44Y0X2L9H",

UNIQ_KEY: "_44Y0WP6H4",

WAREHOUSE: "MAIN1",

ORD_QTY: 0,

RECV_QTY: 0,

POITTYPE: "Invt Part",

ITEMNO: null,

PART_NO: null,

REVISION: null,

PARTMFGR: null,

MFGR_PT_NO: null

}

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP not found error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'POScheduleAdd'."

}

Schedule Add Failed

If the used parameter is invalid or the record being retrieved no longer exists the system will return a Schedule Details Failed message.

{

"$id": "1",

"Code": 403,

"Message": "PO Schedule add failed.An error occurred while executing the command definition. See the inner exception for details.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.6.3.2. PO Schedule Edit

Functions

Schedule Edit API is used to edit scheduling information in Purchase Orders.

URL-{Root URL}/API/PO/ScheduleEdit/{API Key}

Parameters


Parameter Description Required Comment
poNum  Purchase Order Number Y
uniqDetNo PO Schedule Identifier Y  
schd_date Schedule Date N Will default to current date or enter in MM-DD-YYYY format. 
req_date  Required Date  N Will default to current date or enter in MM-DD-YYYY format. 
schd_qty Scheduled Quantity  Y Must be equal to or less than order quantity. 
warehouse  Warehouse  N Warehouse where the item will be received into
location Warehouse Location N Used with warehouse to designate a location. 
origcommitdt  Commit Date N Will default to current date or enter in MM-DD-YYYY Format.
schdNotes Schedule Notes N Can be used to attach a schedule note to the PO. 

Example Strings

Edit Schedule Qty

URL-?poNum=PONUMBER&uniqDetNo=UNIQDETNO&SCHD_QTY=QTY

JSON

{

'poNum':'PONUMBER',

'uniqLnNo':'UNIQLNNO',

'SCHD_QTY':'QTY',

}

A successful add should result in

{

$id: "1",

Code: 200,

Message: "PO Schedule edited successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP not found error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'POScheduleAdd'."

}

Missing Parameter

If there is a missing required parameter the system will return an error detailing which parameter is required.

{

"$id": "1",

"Code": 403,

"Message": "PO Schedule edit failed.UNIQDETNO is required.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.6.3.3. PO Schedule Delete

Functions

Schedule Edit API is used to delete scheduling information in Purchase Orders.

URL-{Root URL}/API/PO/ScheduleDelete/{API Key}

Parameters


Parameter Description Required Comment
poNum  Purchase Order Number Y
uniqDetNo PO Schedule Identifier Y  

Example Strings

Edit Schedule Qty

URL-?poNum=PONUMBER&uniqDetNo=UNIQDETNO

JSON

{

'poNum':'PONUMBER',

'uniqLnNo':'UNIQLNNO',

}

A successful add should result in

{

$id: "1",

Code: 200,

Message: "PO Schedule deleted successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP not found error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/PO/ScheduleDelet/123456789'.",

"MessageDetail": "No action was found on the controller 'Po' that matches the name 'ScheduleDelet'."

}

Schedule Delete Failed

If the used parameter is invalid or the record being retrieved no longer exists the system will return a Schedule Details Failed message.

{

"$id": "1",

"Code": 403,

"Message": "PO Schedule delete failed.An error occurred while executing the command definition. See the inner exception for details.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.6.3.4. PO Schedule Get

Functions

PO Schedule Get API is used to view scheduling information for items on the Purchase Orders.

URL-{Root URL}/API/PO/ScheduleGet/{API Key}

Parameters

 Parameter Description Required Comment
poNum Purchase Order Number Y  
uniqLnNo Unique PO Item Identifier Number Y  

Example Strings

Get Schedule

URL-

?poNum=PONUMBER

JSON

{

'poNum':'PONUMBER'

}

Successful results should result in.

{

$id: "1",

Code: 200,

Message: "PO Schedule details:",

SessionId: null,

IsValidUser: true,

ResponseObject: [

{

$id: "2",

UNIQDETNO: "_44Z0M6ZZW",

UNIQLNNO: "_44Z0M4ZD2",

SCHD_DATE: "2014-09-03T00:00:00",

REQ_DATE: "2014-09-03T00:00:00",

SCHD_QTY: 1,

RECDQTY: 100,

BALANCE: -99,

GL_NBR: "1315000-00-00",

REQUESTTP: "Invt Recv ",

REQUESTOR: " ",

UNIQWH: "_0DM120YNM",

LOCATION: "s4r1 ",

WOPRJNUMBER: " ",

COMPLETEDT: null,

PONUM: "000000000001724",

ORIGCOMMITDT: "2014-09-03T00:00:00",

SCHDNOTES: "",

UNIQMFGRHD: null,

UNIQ_KEY: null,

WAREHOUSE: null,

ORD_QTY: 0,

RECV_QTY: 0,

POITTYPE: null,

ITEMNO: null,

PART_NO: null,

REVISION: null,

PARTMFGR: null,

MFGR_PT_NO: null

}

]

}


Common Errors

API Key Error

If there is an error with the API key the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP not found error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/POScheduleGet/123456789?poNum=410'.",

"MessageDetail": "No type was found that matches the controller named 'POScheduleGet'."

}

Detail Get Failed

If the used parameter is invalid or the record being retrieved no longer exists the system will return a Schedule Details Failed message.

{

"$id": "1",

"Code": 403,

"Message": "PO Schedule details failed:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7. Sales Order API

Sales Order API allows you to easily view and edit sales orders and the items related to the sales orders. 

1.7.1. Sales Order

Sales Order main API is used to interact with sales orders. It allows the user to add a new sales order or edit an existing one. You can also use it to view existing sales orders. 

Functions

Add, Edit, Get

1.7.1.1. Add

Functions

Add API is used to add a new sales order

URL:{Root URL}/API/SO/Add/{API Key}

Parameters

Parameter Description Required Comment
SoNo Sales Order Number Y Must be Unique. When adding a new sales order can be left blank. 
custNo Customer Number Y Ten digits, padded to the left with '0'
blinkAdd Billing Link N >
slinkAdd Shipping Address Link N
orderDate Order Date Y Defaults to the Current date. Can be changed using MM-DD-YYYY forma
POAck Purchase Order Acknowledgement N Can be 1 or 0
PoNo Purchase Order Number N Enter the purchase order number related to the sales order.
SONote Sales Order Note N User Input
FOB FOB N Can be ORIGIN-CUSTOMER P/U, ORIGIN-SHIP, DESTINATION
ShipVia Ship Via N Defaults with customer. Can be 'COMPANY TRUCK', 'CUST PICK UP', 'UPS-GRND TRACK', 'UPS-BLUE', 'UPS-RED', 'FEDX-P1', 'FEDX-STD'.
shipCharge Shipping Charge N Can be NO CHARGE, PREPAY/BILL CUS, SET RATE:UPS-BR, SET RATE:UPS-BL, SET RATE:UPS-RD, FEDX-1
SoFoot  Sales Order Footnote N User Entry, attaches a footnote to the Sales Order
DELIV_TIME Delivery Time N
Buyer Buyer Name N Must be a pre-existing customer.
ATTENTION Attention Person N Must Be a contact for the customer.
SOAMTDSCT Sales Order Discount N
SOAPPROVAL Sales Order Approval N Can be 0 or 1. If 1 must enter SOAPPRVINIT
SOAPPRVINIT Sales Order Approval Initial N Must be an approved user's initial.
SOAPPRVDT Sales Order Approval Date N System automatically uses the current date.
ACKPO_DOC Acknowledge PO Doc N Adds a PO acknowledge doc
TERMS Terms N Defaults from customer info, can be changed by user.
BILLACCOUNT Bill Account N System uses default from customer information, can be changed by user.

Example Strings

New Sales Order, No items

URL- ?SoNo=SONO?custNo=CUSTNO

JSON-

{

'SoNo':'SONO',

'custNo':'CUSTNO'

}

A successful add returns the following

{

"$id":"1",

"Code":200,

"Message":"Sales Order added successfully.",

"SessionId":null,

"IsValidUser":true,

"ResponseObject":null

}

Common Errors

URL Error

If there is a problem with 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/SOAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOAdd'."

}

API Key Error

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Parameter Error

If there is an error with a parameter the system will return an error message detailing the error.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order add failed.Customer does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.1.2. Edit

​Function

Sales Order Edit API is used to modify details in existing sales orders. 

URL-{Root URL}/API/SO/Edit/{API Key}

Parameters

Parameter Description Required Comment
SoNo Sales Order Number Y Must be Unique. When adding a new sales order can be left blank. 
custNo Customer Number Y Ten digits, padded to the left with '0'
blinkAdd Billing Link N >
slinkAdd Shipping Address Link N
orderDate Order Date Y Defaults to the Current date. Can be changed using MM-DD-YYYY forma
POAck Purchase Order Acknowledgement N Can be 1 or 0
PoNo Purchase Order Number N Enter the purchase order number related to the sales order.
SONote Sales Order Note N User Input
FOB FOB N Can be ORIGIN-CUST P/U, ORIGIN-SHIP, DESTINATION
ShipVia Ship Via N Defaults with customer. Can be 'COMPANY TRUCK', 'CUST PICK UP', 'UPS-GRND TRACK', 'UPS-BLUE', 'UPS-RED', 'FEDX-P1', 'FEDX-STD'.
shipCharge Shipping Charge N Can be NO CHARGE, PREPAY/BILL CUS, SET RATE:UPS-BR, SET RATE:UPS-BL, SET RATE:UPS-RD, FEDX-1
SoFoot  Sales Order Footnote N User Entry, attaches a footnote to the Sales Order
DELIV_TIME Delivery Time N
Buyer Buyer Name N Must be a pre-existing customer.
ATTENTION Attention Person N Must Be a contact for the customer.
SOAMTDSCT Sales Order Discount N
SOAPPROVAL Sales Order Approval N Can be 0 or 1. If 1 must enter SOAPPRVINIT
SOAPPRVINIT Sales Order Approval Initial N Must be an approved user's initial.
SOAPPRVDT Sales Order Approval Date N System automatically uses the current date.
ACKPO_DOC Acknowledge PO Doc N Adds a PO acknowledge doc
TERMS Terms N Defaults from customer info, can be changed by user.
BILLACCOUNT Bill Account N System uses default from customer information, can be changed by user.

Example Strings

Edit Existing SO

URL- ?SoNo=SONO?custNo=CUSTNO?FOB=ORIGIN-SHIP

JSON-

{

'SoNo':'SONO',

'custNo':'CUSTNO',

'FOB':'ORIGIN-SHIP

}

A successful request returns the following

{

"$id":"1","Code":200,

"Message":"Sales Order edited successfully.",

"SessionId":null,"IsValidUser":true,

"ResponseObject":null

}

Common Errors

URL Error

If there is a problem with 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/SOEdit/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOEdit'."

}

API Key Error

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Parameter Error

If there is an error with a parameter the system will return an error message detailing the error.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order edit failed.Object reference not set to an instance of an object.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.1.3. Get

​Function

Sales Order Get API is used to view details of existing sales orders. 

URL-{Root URL}/API/SO/Get/{API Key}

Parameters

Parameter Description Required Comment
SoNo Sales Order Number Y Must be Unique. When adding a new sales order can be left blank. 
custNo Customer Number Y Ten digits, padded to the left with '0'
blinkAdd Billing Link N >
slinkAdd Shipping Address Link N
orderDate Order Date Y Defaults to the Current date. Can be changed using MM-DD-YYYY forma
POAck Purchase Order Acknowledgement N Can be 1 or 0
PoNo Purchase Order Number N Enter the purchase order number related to the sales order.
SONote Sales Order Note N User Input
FOB FOB N Can be ORIGIN-CUST P/U, ORIGIN-SHIP, DESTINATION
ShipVia Ship Via N Defaults with customer. Can be 'COMPANY TRUCK', 'CUST PICK UP', 'UPS-GRND TRACK', 'UPS-BLUE', 'UPS-RED', 'FEDX-P1', 'FEDX-STD'.
shipCharge Shipping Charge N Can be NO CHARGE, PREPAY/BILL CUS, SET RATE:UPS-BR, SET RATE:UPS-BL, SET RATE:UPS-RD, FEDX-1
SoFoot  Sales Order Footnote N User Entry, attaches a footnote to the Sales Order
DELIV_TIME Delivery Time N
Buyer Buyer Name N Must be a pre-existing customer.
ATTENTION Attention Person N Must Be a contact for the customer.
SOAMTDSCT Sales Order Discount N
SOAPPROVAL Sales Order Approval N Can be 0 or 1. If 1 must enter SOAPPRVINIT
SOAPPRVINIT Sales Order Approval Initial N Must be an approved user's initial.
SOAPPRVDT Sales Order Approval Date N System automatically uses the current date.
ACKPO_DOC Acknowledge PO Doc N Adds a PO acknowledge doc
TERMS Terms N Defaults from customer info, can be changed by user.
BILLACCOUNT Bill Account N System uses default from customer information, can be changed by 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: " ",

SOAPPRVDT: 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 a 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 Sales Order Number entered does not refer to an existing sales order 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

}

1.7.2. Edit
​Sales Order Item API is used to add, edit, delete, and view the items attached to sales orders

Functions

Add, Edit, Get, Delete

1.7.2.1. Add

Functions

Item Add API is used to add individual items to pre-existing Sales Orders.

URL-{Root URL}/API/SO/ItemADD/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y The Item's unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered N Amount of the item to add to the sales order
soDet_Desc Item Description Y
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliv_time Delivery Time Y Example: 3:00
note SO Item Note N Can be used to add a note to the item
status SO Item Status Y Can be 'Standard', 'Priority-1', 'Priority-2', 'Cancel', 'Closed'
w_key Warehouse Unique Record Identifier N Used if the item is a 'BUY' or 'MAKE' part. 

Example Strings

Add Part

URL-?SoNo=SONO?line_no=LINENUMBER?part_num=PARTNUMBER?revision=REVISION?soDet_Desc=DESCRIPTION?uOfMeas=EACH

JSON

{

'SONO':'SONO',

'line_no':'1=LINENUMBER',

'part_num':'PARTNUMBER',

'revision':'REVISION',

'sodet_desc':'DESCRIPTION',

'uofmeas':'EACH'

}

A successful request should return the following

{

"$id":"1",

"Code":200,

"Message":"Sales Order Item added successfully.",

"SessionId":null,"

IsValidUser":true,"

ResponseObject":null

}

Common Errors

URL Error

If there is a problem with 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/SOItemAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOItemAdd'."

}

API Key Error

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Parameter Error

If there is an error with one of the entered parameters the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.2.2. Edit

​Function

Sales Order Edit API is used to modify details about items in existing sales orders. 

URL-{Root URL}/API/SO/ItemEdit/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number Y You must provide either Line_no or UNIQUELN
part_num Part Number Y The part that is being added to the SO or are changing details of such as order qty or status etc. of that part number you provide
revision Part Revision Level Y If providing part number, you must provide Revision
uniq_key Item identifier N Can be used instead of part number and revision
uOfMeas Unit of Measurement N The Item"s unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered N Only required if changing Order Qty Amount
soDet_Desc Item Description N
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliFreq Delivery Frequency N Can be "DY", "WK", or "MO"
note SO Item Note N Can be used to add a note to the item
status SO Item Status N Only need if changing line item status : Can be "Standard", "Priority-1", "Priority-2", "Cancel", "Closed"
w_key Warehouse Unique Record Identifier N Used if the item is a "BUY" or "MAKE" part. 
UNIQUELN Unique Key for Line Item Y You must provide either Line_no or UNIQUELN

Example Strings

Edit Existing SO Item, Changing the Order Qty 

URL- ?SoNo=SONO&UNIQUELN=UNIQUELN&PART_NUM=PARTNUMBERrevision=REVISION&UOFMEAS=EACH&TRANSFER_DAYS=5 &ORD_QTY=20&EACHQTY=2&STATUS=STANDARD&DELIFREQ=MO

JSON-

"sono":"sales order number", 

"Line_no": "line item number", 

"Part_Num":"part number",

"revision":"revision",

"Ord_Qty":"40"

}

 

Edit Existing SO Item, Changing The status to "Admin Hold"

 

"sono":"Sales Order number", 

"Uniqueln": "UniqueLN", 

"Part_Num":"Partnumber",

"revision":"revision",

"status":"Admin Hold"

}

 

A successful request returns the following.

The below example I was adding more Order Quantity. 

 

Common Errors

URL Error

If there is a problem with 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/SOItemEdit/123456789".",

"MessageDetail": "No type was found that matches the controller named "SOItemEdit"."

}

API Key Error

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Parameter Error

If there is an error with one of the entered parameters the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

 

Please Note:

If Line item balance is "0",  user cannot not edit Line Item Status without increasing the quantities also.

1.7.2.3. Get

​Function

Sales Order Item Get API is used to find and view details about items in existing sales orders. 

URL-{Root URL}/API/SO/ItemGet/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y The Item's unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered Y Amount of the item to add to the sales order
soDet_Desc Item Description Y
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliFreq Delivery Frequency N Can be 'DY', 'WK', or 'MO'
note SO Item Note N Can be used to add a note to the item
status SO Item Status Y Can be 'Standard', 'Priority-1', 'Priority-2', 'Cancel', 'Closed'
w_key Warehouse Unique Record Identifier N Used if the item is a 'BUY' or 'MAKE' part. 

Example Strings

Edit Existing SO

URL- ?UNIQUELN=UNIQUELN

JSON-

{

'UNIQUELN':'UNIQUELN'

}

A successful request returns the following

{

$id: "1",

Code: 200,

Message: "Sales Order Item details:",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

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

}

}

Common Errors

API Key Error

If the entered API Key is invalid the system will return an invalid API Key error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If the entered URL is invalid the system will return a "HTTP" error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOItemGet/23456789?UNIQUELN=_47D0OEV28'.",

"MessageDetail": "No type was found that matches the controller named 'SOItemGet'."

}

Item Does Not Exist

If the entered item does not exist the system will return an "Item Does Not Exist" error message.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order Item does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.2.4. Delete

Functions

SO Item Delete API is used to remove items from existing sales orders.

URL-{Root URL}/API/SO/ItemDelete/{API KEY}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
line_no Line Number N Chooses the line where the part will be added to the SO
part_num Part Number Y The part that is being added to the SO
uniq_key Item identifier N Can be used instead of part number
uOfMeas Unit of Measurement Y The Item's unit of measurement
eachQty Each Delivery Quantity N If used has to be greater than 0 and less than the amount ordered.
ord_qty Quantity Ordered Y Amount of the item to add to the sales order
soDet_Desc Item Description Y
trans_days Transfer Days N Will be automatically entered by the system, can be changed. 
fstduedt First Due Date N Will be automatically entered by the system, can be changed.
deliFreq Delivery Frequency N Can be 'DY', 'WK', or 'MO'
note SO Item Note N Can be used to add a note to the item
status SO Item Status Y Can be 'Standard', 'Priority-1', 'Priority-2', 'Cancel', 'Closed'
w_key Warehouse Unique Record Identifier N Used if the item is a 'BUY' or 'MAKE' part. 

Example Strings

Delete Item

URL-?SONO=SONO?uniqueln=UNIQUELN

JSON

{

'SONO':'SONO',

'uniqueln':'UNIQUELN'

}

A successful request should result in

{

"$id":"1",

"Code":200,

"Message":"Sales Order Item deleted successfully.",

"SessionId":null,

"IsValidUser":true,"

ResponseObject":null

}

Example Strings

Add Part

URL-?SoNo=SONO?line_no=LINENUMBER?part_num=PARTNUMBER?revision=REVISION?soDet_Desc=DESCRIPTION?uOfMeas=EACH

JSON

{

'SONO':'SONO',

'line_no':'1=LINENUMBER',

'part_num':'PARTNUMBER',

'revision':'REVISION',

'sodet_desc':'DESCRIPTION',

'uofmeas':'EACH'

}

A successful request should return the following

{

"$id":"1",

"Code":200,

"Message":"Sales Order Item added successfully.",

"SessionId":null,"

IsValidUser":true,"

ResponseObject":null

}

Common Errors

URL Error

If there is a problem with 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/SOItemDelete/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOItemDelete'."

}

API Key Error

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Parameter Error

If there is an error with one of the entered parameters the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "UniqLn not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.3. Sales Order Item Price

Sales Order Item Price API is used to view, add, and modify price information for the items on the sales orders. 

Functions

Add, Edit, Get, Delete

1.7.3.1. Add

Functions

Add Item Price is used to add a price and price information to the items of a sales order.

URL-{Root URL}/API/SO/PriceAdd/{API Key}

Parameters

Parameter  Description Required Comment
SoNo Sales Order Number Y  
price Sales Order Price Y
taxable Is the SO Taxable N Can be 'true' or 'false'
flat
   
recordType      
saleTypeID Sales Type ID N Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM'
extended    
uniqueLn Unique Sales Order item identifier  Y Must be unique. 
plpricelink Price Link Key N Must be unique. 

Example Strings

 

Add Price

URL-?SoNo=SONO&uniqueln=UNIQUELN&price=1&taxable=1&flat=1&saletypeid=RESTOCKING

JSON

{

'SoNo':'785',

'uniqueln':'UNIQUELN',

'price':'1',

'taxable':'1',

'flat':'1',

'saletypeid':'RESTOCKING'

}

A successful add should return

{

$id: "1",

Code: 200,

Message: "Sales Order Price added successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceAdd/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOPriceAdd'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.3.2. Edit

Functions

Edit Item Price is used to modify a price or price information for the items of a sales order.

URL-{Root URL}/API/SO/PriceEdit/{API Key}

Parameters

Parameter  Description Required Comment
SoNo Sales Order Number Y  
price Sales Order Price Y
taxable Is the SO Taxable N Can be 'true' or 'false'
flat
   
recordType      
saleTypeID Sales Type ID N Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM'
extended    
uniqueLn Unique Sales Order item identifier  Y Must be unique. 
plpricelink Price Link Key N Must be unique. 

Example Strings

 

Add Price

URL-?SoNo=SONO&UNIQUELN=UNIQUELN&PLPRICELNK=PLPRICELNK&price=1.2&taxable=1&flat=1&saletypeid=RESTOCKING

JSON

{

'SoNo':'SONO',

'UNIQUELN':'UNIQUELN',

'PLPRICELNK':'PLPRICELNK',

'price':'1.2',

'taxable':'1',

'flat':'1',

'saletypeid':'RESTOCKING'

}

A successful request should return.

{

$id: "1",

Code: 403,

Message: "Sales Order Price edited successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceEdit/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOPriceEdit'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system an error message describing the parameter will be returned.

{

"$id": "1",

"Code": 403,

"Message": "PlPriceLnk not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.3.3. Get

Functions

Get Item Price is used to view price information of a sales order.

URL-{Root URL}/API/SO/PriceGet/{API Key}

Parameters

Parameter  Description Required Comment
SoNo Sales Order Number Y  
price Sales Order Price Y
taxable Is the SO Taxable N Can be 'true' or 'false'
flat
   
recordType      
saleTypeID Sales Type ID N Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM'
extended    
uniqueLn Unique Sales Order item identifier  Y Must be unique. 
plpricelink Price Link Key N Must be unique. 

Example Strings

 

Add Price

URL-?UNIQUELN=UNIQUELN

JSON

{

'UNIQUELN':'UNIQUELN',

}

A successful request should return.

{

$id: "1",

Code: 200,

Message: "Sales Order Price details:",

SessionId: null,

IsValidUser: true,

-ResponseObject: {

$id: "2",

PLPRICELNK: "GAWG8ODL6Q",

SONO: "0000000789",

DESCRIPTIO: "Loud ",

QUANTITY: 0,

PRICE: 1,

EXTENDED: 0,

TAXABLE: false,

FLAT: false,

RECORDTYPE: "P",

SALETYPEID: "RESTOCKING",

UNIQUELN: "A6WDVN62YM",

PL_GL_NBR: "4050000-00-00",

COG_GL_NBR: "5090000-00-00",

OrigPluniqLnk: " "

}

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceGet/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOPriceGet'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order Price does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.3.4. Delete

Functions

Delete Item Price is used to remove price information from a sales order.

URL-{Root URL}/API/SO/PriceDelete/{API Key}

Parameters

Parameter  Description Required Comment
SoNo Sales Order Number Y  
price Sales Order Price Y
taxable Is the SO Taxable N Can be 'true' or 'false'
flat
   
recordType      
saleTypeID Sales Type ID N Can be 'CABLE/Harn', 'CONSULTING', 'LABOR', 'OTHER', 'PC ASSEMB.', 'PRIORITY', 'REPAIR', 'RESTOCKING', 'REWORK', 'SPARE PART', 'STENCILS', 'SYSTEM'
extended    
uniqueLn Unique Sales Order item identifier  Y Must be unique. 
plpricelink Price Link Key N Must be unique. 

Example Strings

 

Add Price

URL-?SoNo=SONO&UNIQUELN=UNIQUELN&PLPRICELNK=PLPRICELNK}

JSON

{

'SoNo':'SONO',

'UNIQUELN':'UNIQUELN',

'PLPRICELNK':'PLPRICELNK'

}

A successful request should return.

{

$id: "1",

Code: 200,

Message: "Sales Order Price deleted successfully.",

SessionId: null,

IsValidUser: true,

ResponseObject: null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SOPriceDelete/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SOPriceDelete'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order Price does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system an error message describing the parameter will be returned.

{

"$id": "1",

"Code": 403,

"Message": "PlPriceLnk not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.4. Sales Order Item Due Date
1.7.4.1. Add

Functions

Add Item Due Date is used to add a due date to an item on the sales order.

URL-{Root URL}/API/SO/DueDateAdd/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
Due_DTS1 Due Dates Y Has to be working day. Enter in MM-DD-YYYY format
Ship_Dts Ship Date Y Has to be prior to Due Date. Enter in MM-DD-YYYY format.
commit_Dts Commit Date N Defaults from Due Dates, can also be entered manually. 
Qty Scheduled Quantity Y The total must be less than or equal to order quantity.
uniqueLn   Y  


Example Strings

 

Add Due Date

URL-?SONO=0000000000&UNIQUELN=UNIQUELN&QTY=QTY&DUE_DTS1=YYYY-MM-DD

JSON

{

'SONO':'0000000000',

'UNIQUELN':'UNIQUELN',

'QTY':'QTY',

'DUE_DTS1':'YYYY-MM-DD'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date added successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateAdd/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SODueDateAdd'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.4.2. Edit

Functions

Due Date Edit API is used to change existing due dates on sales orders.

URL-{Root URL}/API/SO/DueDateEdit/{API Key}

Parameters

 Parameter Description Required Comment
SoNo Sales Order Number Y  
Due_DTS1 Due Dates Y Has to be working day. Enter in YYYY-MM-DD format
Ship_Dts Ship Date Y Has to be prior to Due Date. Enter in YYYY-MM-DD format.
commit_Dts Commit Date N Defaults from Due Dates, can also be entered manually. 
Qty Scheduled Quantity Y The total must be less than or equal to order quantity.
uniqueLn   Y  

Example Strings

Edit Existing Schedule

URL:?dueDt_Uniq=DUEDT_UNIQ&SONO=0000000000&UNIQUELN=UNIQUELN&QTY=QTY&DUE_DTS1=YYYY-DD-MM

JSON

{

"dueDt_Uniq":"DUEDT_UNIQ",

"SONO":"0000000000",

"UNIQUELN":"UNIQUELN",

"QTY":"QTY",

"DUE_DTS1":"YYYY-MM-DD"

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date edited successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateEdit/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SODueDateEdit'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item Due Date.

{

"$id": "1",

"Code": 403,

"Message": "Sales Order item with uniqueLn:'' does not exits in SO:'0000000799'.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system an error message describing the parameter will be returned.

{

"$id": "1",

"Code": 403,

"Message": "PlPriceLnk not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.4.3. Get

Functions

Due Date Get API is used to view Due Date information from existing Sales Orders

URL-{Root URL}/API/SO/DueDateGet/{API Key}

Parameters

Parameter Description Required Comment
DueDateUniq Unique Due Date Identifier Y  


Example Strings

Get Due Date

URL:?DueDateUniq=DueDateUnique

JSON

{

'DueDateUniq':'DUEDATEUNIQUE'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date details:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": {

"$id": "2",

"DUEDT_UNIQ": "_3X60YA22D",

"SONO": "0000000709",

"DUE_DTS1": "2013-11-28T00:00:00",

"SHIP_DTS": "2013-11-26T00:00:00",

"COMMIT_DTS": "2013-11-28T00:00:00",

"QTY": 0,

"STDCHG": 0,

"PRICHG": 0,

"OTHCHG": 0,

"JOBPRI": " ",

"DAYMIN": 0,

"LOTNO": " ",

"QUOTE_SEL": false,

"START_DTS": null,

"ACT_SHP_QT": -1,

"ON_SCHED": false,

"COMPL_DTS": null,

"UNIQUELN": "_3X60Y9X2N"

}

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateGet/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SODueDateGet'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": ""$$Sales Order Due Date does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.7.4.4. Delete

Functions

Sales Order Due Date Delete API is used to remove existing Due Dates from Existing Sales Orders

URL-{Root URL}/API/SO/DueDateDelete/{API Key}

Parameters

 Parameter Description Required Comment
DueDt_Uniq Unique Due Date Identifier Y  

Example Strings

Delete Schedule Information

URL-?DueDt_Uniq=DUEDT_UNIQ

JSON

{

'DueDt_Uniq':'DUEDT_UNIQ'

}

Successful Requests Should Return

{

"$id": "1",

"Code": 200,

"Message": "$$Sales Order Due Date deleted successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If there is an error with the API key the system will return an error message.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the entered URL has an error the system will return a "HTTP Resource not found" message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/SODueDateDelete/23456789'.",

"MessageDetail": "No type was found that matches the controller named 'SODueDateDelete'."

}

Parameter Error

If one of the entered parameters is invalid the system will fail to add the item price.

{

"$id": "1",

"Code": 403,

"Message": "DueDt_Uniq not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Missing Required Parameter

If a required parameter is missing the system an error message describing the parameter will be returned.

{

"$id": "1",

"Code": 403,

"Message": "DueDt_Uniq not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8. Customer API

The Customer API allows you to make changes to the customers in the database or to add new customer data. It also allows you to quickly view the data for each customer. This API also lets you edit the Billing and Shipping addresses as well as the customer's tax information. 

1.8.1. Customer Main

Customer Main API is used to add new customers or edit a customer's personal information. The get function can be used to view the information about the customers. 

1.8.1.1. Add

Functions

Add API is used to add a new customer to the system

​{Root URL}/API/Customer/Add/{API Key}

Parameters

Parameter Description Required Comment
Custno Customer Number N Must be unique
Custname Customer Name Y  
Status Account Status Y Can be: Active, Inactive, Quote   (please note must be camel-cased)
Phone Customer’s phone number N  
Fax Customer’s fax N  
Territory The customer’s territory N Can be: SOUTHERN CA, NORTHERN CA, EAST, WEST, MIDWEST, NEW ENGLAND, SOUTH, GREAT LAKES, MEXICO, CANADA, UNITED KINGDOM
Terms The customer’s sales terms N Can be: NET 10, NET 15, NET 30, NET 30/2% 10, NET 45, COD, NONE
Credlimit Credit Limit N This is the customer’s credit limit. Must be Greater than or equal to 0
Creditok Credit Status N Can be: OK, HOLD, REJECT
Ar_highBal Accounts Receivable balance N Must be greater than or equal to 0
Acct_date Date the account was created N In MM/DD/YYYY format
Saledsctid Sales Discount Id N  
Acctaxable Account Taxable N  

​Example Strings

Add new customer

URL:?CustName=CustomerName&Status=Active'

JSON

{

 "Custname": "CustomerName",

 "Status": "Active"

}

 

A successful add should result in

{

"$id": "1",

"Code": 200,

"Message": "Customer added successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": {

"$id": "2",

"CUSTNO": "0000000010",

"CUSTNAME": "CustomerName",

"PHONE": "",

"FAX": "",

"BLINKADD": "",

"SLINKADD": "",

"TERRITORY": "",

"TERMS": "",

"CREDLIMIT": 0,

"PROFILE": "",

"CUSTNOTE": "",

"ACCTSTATUS": "",

"DIVISION": "",

"SREPS": "",

"CREDITOK": "",

"RESL_NO": "",

"AR_CALDATE": null,

"AR_CALTIME": "",

"AR_CALBY": "",

"AR_CALNOTE": "",

"AR_HIGHBAL": 0,

"CREDITNOTE": "",

"ACCT_DATE": "2014-11-19T10:09:57.041868-05:00",

"SAVEINIT": "",

"OUT_MARGIN": 0,

"TL_MARGIN": 0,

"MAT_MARGIN": 0,

"LAB_MARGIN": 0,

"MIN_ORDAMT": 0,

"SCRAP_FACT": 0,

"COMMITEM": 0,

"CUSTSPEC": 0,

"LABOR": false,

"MATERIAL": false,

"SPLIT1": 0,

"SPLIT2": 0,

"SPLITAMT": 0,

"SPLITPERC": 0,

"TOOLING": false,

"SIC_CODE": "",

"SIC_DESC": "",

"DELIVTIME": "",

"STATUS": "Active",

"SERIFLAG": false,

"OVERHEAD": 0,

"IS_EDITED": "",

"SALEDSCTID": "",

"CUSTPFX": "",

"ACTTAXABLE": false,

"INACTDT": null,

"INACTINIT": "",

"modifiedDate": null,

"UserId": null,

"LinkAddList": null

}

}

Common Errors

URL Error

If there is an error with the entered URL the system will return a HTTP error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/CustomerAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'CustomerAdd'."

}

Parameter Error

If a required parameter is missing, or the entered value is incorrect the system will return an object reference error message.

{

"$id": "1",

"Code": 403,

"Message": "Customer add failed.Object reference not set to an instance of an object.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

API Key Error

If there is a problem with the used API key the system will return an error describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

1.8.1.2. Edit

Functions

Customer edit API is used to modify existing customer information

​{Root URL}/API/Customer/Edit/{API Key}

Parameters

Parameter Description Required Comment
Custno Customer Number Y Must be unique and ten digits. 
Custname Customer Name N  
Phone Customer’s phone number N  
Fax Customer’s fax N  
Territory The customer’s territory N Can be: SOUTHERN CA, NORTHERN CA, EAST, WEST, MIDWEST, NEW ENGLAND, SOUTH, GREAT LAKES, MEXICO, CANADA, UNITED KINGDOM
Terms The customer’s sales terms N Can be: NET 10, NET 15, NET 30, NET 30/2% 10, NET 45, COD, NONE
Credlimit Credit Limit N This is the customer’s credit limit. Must be Greater than or equal to 0
Creditok Credit Status N Can be: OK, HOLD, REJECT
Resl_no Reseller Number N
Ar_highBal Accounts Receivable balance N Must be greater than or equal to 0
Acct_date Date the account was created N In MM/DD/YYYY format
Status Account Status N Can be: ACTIVE, INACTIVE, QUOTE
Saledsctid Sales Discount Id N  
Acctaxable Account Taxable N  
Inactdt Account inactive date N Must be in MM/DD/YYYY
Inactinit Inactive initial N  
modifieddate Account Modified Date N Must be in MM/DD/YYYY format.

​Example Strings

Edit Customer Details

URL:?CUSTNO=0000000000&CUSTNAME=CustomerName&ACCT_DATE=YYYY-MM-DD00:00:00&STATUS=Active&territory=NEW ENGLAND'

{

'CUSTNO':'0000000000',

'CUSTNAME':'CustomerName',

'ACCT_DATE':'YYYY-MM-DD00:00:00',

'STATUS':'Active',

'territory':'NEW ENGLAND'

}

A successful edit should result in

{

"$id": "1",

"Code": 200,

"Message": "Customer edited successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Errors

API Key Error

If there is an error with the API Key the system will return an error message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the used URL the system will return a HTTP error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/CustomerEdit/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'CustomerEdit'."

}

Parameter Error

If there is an error with one of the used parameters the system will return an error message describing the error.

{

"$id": "1",

"Code": 403,

"Message": "Customer edit failed.Customer Number or Customer Name is Required",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.1.3. Get

Functions

Add

​{Root URL}/API/Customer/Get/{API Key}

Parameters

Parameter Description Required Comment
CustNumOrName Customer Number or Customer Name Y Use either the customer number or the customer name to get customer information.

​Example Strings

Get Customer Information

URL:?CustNumOrName=Customer

JSON

{

'CustNumOrName':'Customer'

}

A successful request should result in

{

"$id": "1",

"Code": 200,

"Message": "Customer details:",

"SessionId": null,

"IsValidUser": true,

-"ResponseObject": {

"$id": "2",

"LinkAddList": null,

"CUSTNO": "0000000010",

"CUSTNAME": "Customer ",

"PHONE": " ",

"FAX": " ",

"BLINKADD": " ",

"SLINKADD": " ",

"TERRITORY": "NEW ENGLAND ",

"TERMS": " ",

"CREDLIMIT": 0,

"PROFILE": "",

"CUSTNOTE": "",

"ACCTSTATUS": " ",

"DIVISION": " ",

"SREPS": " ",

"CREDITOK": " ",

"RESL_NO": " ",

"AR_CALDATE": null,

"AR_CALTIME": " ",

"AR_CALBY": " ",

"AR_CALNOTE": "",

"AR_HIGHBAL": 0,

"CREDITNOTE": "",

"ACCT_DATE": "2014-11-19T13:28:00",

"SAVEINIT": " ",

"OUT_MARGIN": 0,

"TL_MARGIN": 0,

"MAT_MARGIN": 0,

"LAB_MARGIN": 0,

"MIN_ORDAMT": 0,

"SCRAP_FACT": 0,

"COMMITEM": 0,

"CUSTSPEC": 0,

"LABOR": false,

"MATERIAL": false,

"SPLIT1": 0,

"SPLIT2": 0,

"SPLITAMT": 0,

"SPLITPERC": 0,

"TOOLING": false,

"SIC_CODE": " ",

"SIC_DESC": " ",

"DELIVTIME": " ",

"STATUS": "Active ",

"SERIFLAG": false,

"OVERHEAD": 0,

"IS_EDITED": " ",

"SALEDSCTID": " ",

"CUSTPFX": " ",

"ACTTAXABLE": false,

"INACTDT": null,

"INACTINIT": " ",

"modifiedDate": "2014-11-19T13:27:49.25",

"UserId": null

}

}

Common Errors

Incorrect URL

If there is a problem with the URL or the parameter entered the system will return a HTTP error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/Customer/Get/123456789?CustName=CustomerName'.",

"MessageDetail": "No action was found on the controller 'Customer' that matches the request."

}

Non-Existent Customer

If the entered customer does not exist the system will return a message describing it.

{

"$id": "1",

"Code": 403,

"Message": "Customer does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.2. Customer Address

Customer Address API is used to add or modify shipping and billing addresses for customers. The Get function is used to view addresses for a customer. The delete function is used to remove addresses from a customer's information.  

1.8.2.1. Add

Customer Address add API is used to add Ship to Address and Bill to Address

URL:{Root URL}/Api/ShipBill/Add/{API Key}

 

Parameters

Parameter Description Required Comment
Linkadd    
Custno Customer Number Y  
Shipto Ship to Name N The person you are shipping to
Address1 First line of the address N  
Address2 Second Line of the address N
City City N Ship to City
State State N Ship to State
Zip Zip Code N Ship to Zip code
Country Country N Ship to country
Phone Phone number N Ship to Phone Number
Fax Fax N Ship to fax address
Email Email N Ship to email address
Attention Attention N Attention notice for the shipping
recordtype The type of record N Can be C for Confirm to or R for Remit to

Example Strings

Add Address

URL:?custno=0000000000&shipTo=Test&recordType=S

JSON

{

'custno':'0000000000',

'shipTo':'Test',

'recordType':'S'

}

A successful add should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipBill added successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": {

"$id": "2",

"LINKADD": "056RU7J15B",

"CUSTNO": "0000000010",

"SHIPTO": "Test",

"ADDRESS1": "",

"ADDRESS2": "",

"CITY": "",

"STATE": "",

"ZIP": "",

"COUNTRY": "",

"PHONE": "",

"FAX": "",

"E_MAIL": "",

"TRANSDAY": 0,

"FOB": "",

"SHIPCHARGE": "",

"SHIPVIA": "",

"ATTENTION": "",

"RECORDTYPE": "S",

"BILLACOUNT": "",

"SHIPTIME": "",

"SHIPNOTE": "",

"SHIP_DAYS": 0,

"RECV_DEFA": false,

"CONFIRM": "",

"PKFOOTNOTE": "",

"INFOOTNOTE": "",

"TAXEXEMPT": "",

"FOREIGNTAX": false,

"ModifiedDate": null

}

}

Common Errors

API Key Error

If there is an error with the entered API key the system will return an error message describing an API key error.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipBillAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'ShipBillAdd'."

}

Parameter Value Error

If there is a problem with one of the entered parameter values or a required parameter is missing the system will return an error message describing the problem.

{

"$id": "1",

"Code": 403,

"Message": "ShipBill add failed.Customer does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.2.2. Edit

Customer Address edit API is used to modify existing customer address information. 

URL:{Root URL}/Api/ShipBill/Edit/{API Key}

Parameters

Parameter Description Required Comment
Linkadd   Y  
Custno Customer Number Y  
ShipCharge  Ship Charge Can be NO CHARGE, PREPAY/BILL CUS, SET RATE:UPS-BR, SET RATE:UPS-BL, SET RATE:UPS-RD, SET RATE:FEDX-1 
ShipVia  Ship Via Y Can be COMPANY TRUCK, CUST PICK UP, UPS-GRND TRACK, UPS-BLUE, UPS-RED, FEDX-1, FEDX-STD 
FOB FOB Y Can be ORIGIN-CUST P/U, ORIGIN-SHIP, DESTINATION
Shipto Ship to Name N The person you are shipping to
Address1 First line of the address N  
Address2 Second Line of the address N
City City N Ship to City
State State N Ship to State
Zip Zip Code N Ship to Zip code
Country Country N Ship to country
Phone Phone number N Ship to Phone Number
Fax Fax N Ship to fax address
Email Email N Ship to email address
Attention Attention N Attention notice for the shipping
recordtype The type of record N Can be C for Confirm to or R for Remit to

Example Strings

Address Edit

URL:?LinkAdd=LINKADD&Custno=0000000000&Shipto=TestShipping&RecordType=B&Foreightax=false&FOB=ORIGIN-CUST P/U&SHIPCHARGE=PREPAY/BILL CUS&SHIPVIA=COMPANY TRUCK

JSON

{

'LinkAdd':'LINKADD',

'Custno':'0000000000',

'Shipto':'TestShipping',

'RecordType':'B',

'Foreightax':'false',

'FOB':'ORIGIN-CUST P/U',

'SHIPCHARGE':'PREPAY/BILL CUS',

'SHIPVIA':'COMPANY TRUCK'

}

A successful edit should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipBill 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 message describing an API key error.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipBillEdit/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'ShipBillEdit'."

}

Parameter Value Error

If there is a problem with one of the entered parameter values or a required parameter is missing the system will return an error message describing the problem.

{

"$id": "1",

"Code": 403,

"Message": "ShipBill edit failed.Link address does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.2.3. Delete

Customer Address delete API is used to remove customer address information from the customer record. 

URL:{Root URL}/Api/ShipBill/Delete/{API Key}

Parameters

Parameter Description Required Comment
Linkadd   Y  
Custno Customer Number N  
Shipto Ship to Name N The person you are shipping to
Address1 First line of the address N  
Address2 Second Line of the address N
City City N Ship to City
State State N Ship to State
Zip Zip Code N Ship to Zip code
Country Country N Ship to country
Phone Phone number N Ship to Phone Number
Fax Fax N Ship to fax address
Email Email N Ship to email address
Attention Attention N Attention notice for the shipping
recordtype The type of record N Can be C for Confirm to or R for Remit to

Example Strings

Delete Address

URL:?LinkAdd=LINKADD

JSON

{

'LinkAdd':'LINKADD'

}

A successful delete should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipBill deleted successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Error

API Key Error

If there is a problem with the used 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 issue with the entered URL the system will return a HTTP error

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipBill/Delete/23456789'.",

"MessageDetail": "No action was found on the controller 'ShipBill' that matches the request."

}

Missing Required Parameter

If a required parameter is missing the system will return an error message specifying which parameter.

{

"$id": "1",

"Code": 403,

"Message": "Please provide LinkAddress",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.2.4. Get

Customer Address get API is used to find and view existing customer address information. 

URL:{Root URL}/Api/ShipBill/Get/{API Key}

Parameters

Parameter Description Required Comment
Linkadd Customer Address Key   
Custno Customer Number N  
Shipto Ship to Name N The person you are shipping to
Address1 First line of the address N  
Address2 Second Line of the address N
City City N Ship to City
State State N Ship to State
Zip Zip Code N Ship to Zip code
Country Country N Ship to country
Phone Phone number N Ship to Phone Number
Fax Fax N Ship to fax address
Email Email N Ship to email address
Attention Attention N Attention notice for the shipping
recordtype The type of record N Can be C for Confirm to or R for Remit to

Example Strings

Get Address

URL:?LinkAdd=LINKADD

{

'LinkAdd','LINKADD'

}

A successful request should return

{

"$id": "1",

"Code": 200,

"Message": "ShipBill details:",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": {

"$id": "2",

"LINKADD": "_4560WJU2L",

"CUSTNO": "0000000008",

"SHIPTO": "TestShipping ",

"ADDRESS1": "12 West St ",

"ADDRESS2": " ",

"CITY": "Swilton ",

"STATE": "NH ",

"ZIP": "02343 ",

"COUNTRY": "USA ",

"PHONE": "6035555555 ",

"FAX": " ",

"E_MAIL": "",

"TRANSDAY": 0,

"FOB": "ORIGIN-CUST P/U",

"SHIPCHARGE": "PREPAY/BILL CUS",

"SHIPVIA": "COMPANY TRUCK ",

"ATTENTION": " ",

"RECORDTYPE": "B",

"BILLACOUNT": " ",

"SHIPTIME": " ",

"SHIPNOTE": "",

"SHIP_DAYS": 0,

"RECV_DEFA": false,

"CONFIRM": " ",

"PKFOOTNOTE": "",

"INFOOTNOTE": "",

"TAXEXEMPT": " ",

"FOREIGNTAX": false,

"ModifiedDate": "2014-12-01T09:31:36.737"

}

}

Common Errors

API Key Error

If there is a problem with the used 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 a problem with the entered URL the system will return an HTTP error

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipBill/Get/123456789'.",

"MessageDetail": "No action was found on the controller 'ShipBill' that matches the request."

}

Parameter Error

If the entered parameter does not link to an existing Ship Bill record the system will return a "ShipBill does not exist" error message.

{

"$id": "1",

"Code": 403,

"Message": "ShipBill does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.3. Customer Tax

Customer Tax API is used to add or edit Tax information for customers. The Get function for Tax API is used to view the tax information for a customer. The Delete function is used to remove tax information from a customer record. 

1.8.3.1. Add

Functions

Customer Add Tax API is used to add tax information to a customer's information.

Parameters

Parameter Description Required Comment
unqshiptax Primary Tax Key Y Must be Unique
Linkadd Link to Ship Bill Table Y Links the tax info to the shipping info
Custno Customer Number Y  
Taxdesc Tax Description Y  
tax_rate Tax Rate Y  
Tax_id Tax ID Y  
recordtype Record Type Y  
ptProd Primary Tax Product N  
ptFr Primary Tax Freigh N  
stProd Secondary Tax Product N  
stFrt Secondary Tax Freight N  
stTx Secondary Tax N  
modifiedDate Last Modified Date N  

Example Strings

Add new tax information

URL:?Linkadd=LINKADD&Custno=0000000011&Taxdesc=SANTA CLARA CNTY. USE TAX&Taxtype=S&Tax_Rate=8.2500&Tax_id=CA USE&Recordtype=S

JSON

{

'Linkadd':'LINKADD',

'Custno':'0000000011',

'Taxdesc':'SANTA CLARA CNTY. USE TAX',

'Taxtype':'S',

'Tax_Rate':'8.2500' ,

'Tax_id':'CA USE ',

'Recordtype':'S'

}

A successful add should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipTax added 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 message describing an API key error.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipTaxAdd/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'ShipTaxAdd'."

}

Parameter Value Error

If there is a problem with one of the entered parameter values or a required parameter is missing the system will return an error message describing the problem.

{

"$id": "1",

"Code": 403,

"Message": "'ShipTax' Object is not initialized properly.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.3.2. Edit

Functions

Customer Tax edit API is used to modify existing tax information.

URL:{Root URL}/API/ShipTax/Edit/{API Key}

Parameters

Parameter Description Required Comment
unqshiptax Primary Tax Key Y Must be Unique
Linkadd Link to Ship Bill Table Y Links the tax info to the shipping info
Custno Customer Number Y  
Taxdesc Tax Description N  
tax_rate Tax Rate N  
Tax_id Tax ID N  
recordtype Record Type N  
ptProd Primary Tax Product N  
ptFr Primary Tax Freigh N  
stProd Secondary Tax Product N  
stFrt Secondary Tax Freight N  
stTx Secondary Tax N  
modifiedDate Last Modified Date N  

Example Strings

Edit Tax Details

URL:?UNQSHIPTAX=UniqShipTa&Custno=0000000011&Taxdesc=ORANGE COUNTY&Taxtype=S&Tax_Rate=7.5&Tax_id=CA USE&Recordtype=S

{

'UNQSHIPTAX':'USQNT0M26L',

'Custno':'0000000011',

'Taxdesc':'ORANGE COUNTY',

'Taxtype':'S',

'Tax_Rate':'7.5' ,

'Tax_id':'CA USE ',

'Recordtype':'S'

}

A successful edit should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipTax 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 message describing an API key error.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

URL Error

If there is an error with the URL the system will return a HTTP error message.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipTaxEdit/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'ShipTaxEdit'."

}

Parameter Value Error

If there is a problem with one of the entered parameter values or a required parameter is missing the system will return an error message describing the problem.

{

"$id": "1",

"Code": 403,

"Message": "'ShipTax' Object is not initialized properly.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.3.3. Delete

Functions

Customer Tax delete API is used to remove tax information from a customer's records

URL:{Root URL}/API/Customer/TaxDelete/{API Key}

Parameters

Parameter Description Required Comment
Custno Customer Number Y  

Example Strings

Delete tax information

URL?CustNo=0000000011

JSON

{

'CustNo','0000000011'

}

A successful delete request should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipTax deleted successfully.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

Common Error

API Key Error

If there is a problem with the used 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 issue with the entered URL the system will return a HTTP error

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipTax/Delete/23456789'.",

"MessageDetail": "No action was found on the controller 'ShipTax' that matches the request."

}

Missing Required Parameter

If a required parameter is missing the system will return an error message specifying which parameter.

{

"$id": "1",

"Code": 403,

"Message": "Customer number or customer name not provided.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.8.3.4. Get

Functions

Customer Tax get API is used to find and view existing tax information

URL:{Root URL}/API/ShipTax/Get/{API Key}

Parameters

Parameter Description Required Comment
Linkadd Link to Ship Bill Table Y Links the tax info to the shipping info

Example Strings

Get Tax Information

URL:?LinkAdd=LINKADD

JSON

{

'LinkAdd':'LINKADD'

}

A successful get request should result in

{

"$id": "1",

"Code": 200,

"Message": "ShipTax details:",

"SessionId": null,

"IsValidUser": true,

-"ResponseObject": [

-{

"$id": "2",

"ShipBill": null,

"UNQSHIPTAX": "_41X0YBZJX",

"LINKADD": "_41X0YBRKE",

"CUSTNO": "0000000007",

"ADDRESS1": " ",

"TAXDESC": "SANTA CLARA CNTY. USE TAX",

"TAXTYPE": "S",

"TAX_RATE": 8.25,

"TAX_ID": "CA USE ",

"RECORDTYPE": "S",

"PTPROD": false,

"PTFRT": false,

"STPROD": false,

"STFRT": false,

"STTX": false,

"ModifiedDate": null

},

{

"$id": "3",

"ShipBill": null,

"UNQSHIPTAX": "_41X0YC231",

"LINKADD": "_41X0YBRKE",

"CUSTNO": "0000000007",

"ADDRESS1": " ",

"TAXDESC": "SANTA CLARA CNTY. USE TAX",

"TAXTYPE": "C",

"TAX_RATE": 8.25,

"TAX_ID": "CA USE ",

"RECORDTYPE": "S",

"PTPROD": false,

"PTFRT": false,

"STPROD": false,

"STFRT": false,

"STTX": false,

"ModifiedDate": null

}

]

}

Common Errors

URL Error

If there is an error with the entered URL the system will return a HTTP error.

{

"$id": "1",

"Message": "No HTTP resource was found that matches the request URI 'http://localhost/api/ShipTaxGet/123456789'.",

"MessageDetail": "No type was found that matches the controller named 'ShipTaxGet'."

}

API Key Error

If there is a problem with the used API key the system will return an error describing it.

{

"$id": "1",

"Code": 403,

"Message": "Invalid API Key.",

"SessionId": null,

"IsValidUser": false,

"ResponseObject": null

}

Parameter Error

If a required parameter is missing, or the entered value is incorrect the system will return an object reference error message.

{

"$id": "1",

"Code": 403,

"Message": "ShipTax does not exists.",

"SessionId": null,

"IsValidUser": true,

"ResponseObject": null

}

1.9. Q & A API's

 Question: Whats the difference between GET and POST for API's? 


 Answer: GET should be used for getting the information without changing the server's state. POST and DELETE are used for updating the server's state. 

In Manex, we only POST and DELETE for updating the server's state.