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.