Function
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 | |
1 | uniq_key | Part unique key | Y | The uniq_key is used to select the part a user wants to add supplier information to. |
2 | uniqmfgrhd | Unique manufacturer information key | Y | The uniqmfgrhd is used to choose the part a user would like to add. |
3 | uniqWh | Warehouse identifier | Y | Used to pick the default warehouse for the item. |
4 | uniqsupno | Unique supplier number | Y | Used to identify the supplier. |
5 | 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 an 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 the 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" } |