Search

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 nameDescriptionPossible valueRequired
searchCodeSearch 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 nameTypeDescription
productIDIntegerProduct ID.
nameStringProduct name.
codeStringFirst code of the item (by convention, this is used for company's internal code).
code2StringSecond code of the item (by convention, this is used for EAN/UPC barcode).
code3StringThird code of the item.
supplierCodeStringSupplier's product code.
code5StringCode 5 of the item. "Extra product codes" module must be enabled.
code6StringCode 6 of the item. "Extra product codes" module must be enabled.
code7StringCode 7 of the item. "Extra product codes" module must be enabled.
code8StringCode 8 of the item. "Extra product codes" module must be enabled.
netPriceDecimalDefault sales price of the product, excluding VAT
groupIDIntegerID of assignment group.
groupNameStringName of assignment group.
categoryIDInteger
categoryNameString
brandIDInteger
brandNameString
priorityGroupIDInteger
priorityGroupNameString
supplierIDInteger
supplierNameString
costDecimalProduct cost
statusStringProduct status, possible statuses are 'ACTIVE', 'NO_LONGER_ORDERED', 'NOT_FOR_SALE' and 'ARCHIVED'. By default 'ACTIVE'.
pictureURLStringPicture URL.

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