Unleashed icon

Unleashed

Interact with Unleashed inventory management API

Product → Fuzzy Search

AI-generated

Summary

Queries the Unleashed API for products matching one or more search criteria using fuzzy logic and returns matching records sorted by relevance.

Inputs

  • searchInputs — A collection of search fields. Matching is performed on any provided field, and the more fields provided, the higher the match quality. Available options: barcode, brand, productCode, productDescription, productGroup, supplier, supplierCode, supplierProductCode.
  • maxResults — The maximum number of matching products to return (default: 5).
  • minConfidence — The minimum confidence percentage (0-100) required for a result to be included, filtering out low-confidence matches (default: 10).

Output shape

A list of items, each containing detailed product information (including the match confidence score).

The results are sorted by relevance score. An exact match on the 'Product Code' short-circuits the fuzzy search and returns immediately. The API response does not include an envelope indicating success/failure; empty results are returned if no matches meet the confidence threshold.

Examples

Example 1: Find products by partial description.

Search by 'productDescription' = 'chocolate bar'; set maxResults to 10.

Example 2: Find products by brand and barcode.

Search by 'brand' = 'Nestle' and 'barcode' = '12345'; set minConfidence to 50.

Example 3: Search for a known product code.

Search by 'productCode' = 'ABC123'; this triggers an exact match and returns the single product immediately.

Links

Discussion