findMasterListProducts

Look up a Master List product by code. You can use configuration parameter "master_list_min_search_string_length" to set minimum length for the input value. By default 3. You can also use configuration parameter "master_list_max_search_results" to set number of records returned by the request. By default 100.

For other Master List-related API calls, see saveMasterListProducts and copyMasterListProductsToErply.

Input parameters

Parameter name Description Possible value Required
searchCode  Search for a product by code or EAN/UPC. Returns all items where beginning of the code (or the EAN/UPC) matches. If the length of this field's value is less than configuration parameter "master_list_min_search_string_length", API returns error 1014.  String  Yes  

Response

Field name Type Description
productID  Integer  Product ID.  
name  String  Product name.  
code  String  First code of the item (by convention, this is used for company's internal code).  
code2  String  Second code of the item (by convention, this is used for EAN/UPC barcode).  
code3  String  Third code of the item.  
supplierCode  String  Supplier's product code.  
code5  String  Code 5 of the item. "Extra product codes" module must be enabled.  
code6  String  Code 6 of the item. "Extra product codes" module must be enabled.  
code7  String  Code 7 of the item. "Extra product codes" module must be enabled.  
code8  String  Code 8 of the item. "Extra product codes" module must be enabled.  
netPrice  Decimal  Default sales price of the product, excluding VAT  
groupID  Integer  ID of assignment group.  
groupName  String  Name of assignment group.  
categoryID  Integer   
categoryName  String   
brandID  Integer   
brandName  String   
priorityGroupID  Integer   
priorityGroupName  String   
supplierID  Integer   
supplierName  String   
cost  Decimal  Product cost  
status  String  Product status, possible statuses are 'ACTIVE', 'NO_LONGER_ORDERED', 'NOT_FOR_SALE' and 'ARCHIVED'. By default 'ACTIVE'.  
pictureURL  String  Picture URL.  

This API call returns error 1006 if Master list is not enabled on your account.