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

}