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