Evolve Storefront
Evolve Storefront is already pre-integrated with Image Search. This page will walk you through the necessary configuration to enable the image search functionality.
Image Search API credentials (origin, client ID, and client secret) are required. See the Integration Overview for authentication and design details.
Configuration
Set the following configuration values in the Evolve Storefront instance.
| Environment Variable | Feature Flag | Description |
|---|---|---|
| EVOLVE_IS_API_ORIGIN | feature.evolveImageSearchOrigin | The Evolve Image Search API origin. For example, https://api-<tenant id>.evolvestorefront.com. |
| EVOLVE_IS_API_CLIENT_ID | feature.evolveImageSearchClientId | Evolve Image Search Client ID for authentication. |
| EVOLVE_IS_API_CLIENT_SECRET | feature.evolveImageSearchClientSecret | Evolve Image Search Client Secret for authentication. |
Product Catalog Indexing
Before image search can return results, your product catalog must be indexed with the Evolve Image Search service. This is a one-time setup (with ongoing delta updates as your catalog changes) and is done outside of the storefront configuration.
- Create a Data File — Build a CSV file mapping product IDs and part numbers to their image paths.
- Upload Assets — Upload your product images and data files via SFTP.
- Index Data — Trigger a bulk import via the API to index your products.
For ongoing catalog changes, use delta data files containing only changed products to minimize processing time and API request usage.
Storefront Behavior
Once configured, an image search icon appears in the search bar. Clicking the icon opens an upload panel.
Upload options:
- Drag and drop an image onto the upload area.
- Browse to select an image file from the device.
- Camera (mobile devices) — take a photo directly from the device camera.
After uploading, the user is navigated to the /image-search page where matching products are displayed in a grid layout. The results page includes:
- A crop tool that lets the user select a specific region of the image to refine search results.
- A text search field for combined image + text search (e.g., upload a photo of a coat, then type "blue" to find similar blue coats).
Search types supported:
| Type | Description |
|---|---|
| By image | Returns products with visually similar images. |
| By image and text | Returns products that are visually similar and semantically match the provided text. |
Image Requirements
- User-uploaded images must be JPEG or PNG format.
- Images are automatically scaled to a maximum of 2048 x 2048 pixels before being sent to the API.
- Maximum upload file size: 20 MB.
- Maximum base64-encoded image size accepted by the API: 5,376 KB.