Skip to main content

Product Search Overview

Integrate the Product Search API to deliver intelligent, relevant results from your catalog. This guide provides a comprehensive overview of search functionality and available endpoints.

Introduction​

The Search API provides intelligent product search capabilities for your catalog. It processes search queries and returns relevant product matches with pagination support.

Key Features​

  • Product Search: Find products by name, category, or attributes
  • Pagination: Handle large result sets efficiently
  • Session Tracking: Track user search behavior
  • Multi-language Support: Search in different languages
  • Real-time Results: Fast response times for better user experience

Endpoint​

POST https://catalog.api.fashionai.dev/api/v1/products/protected/search?page={page}&limit={limit}&query={query}

Quick Start​

  1. Get Your Token: Obtain your API token from the dashboard
  2. Make a Request: Send a POST request with your search query
  3. Handle Results: Process the returned product IDs
  4. Implement Pagination: Use page and limit parameters for large datasets

Request Flow​

sequenceDiagram
    Client->>API: POST /search with query
    API->>Database: Search products
    Database->>API: Return matching products
    API->>Client: Return product IDs + pagination

Response Structure​

The API returns a consistent response structure:

{
  "totalItems": 47,
  "totalPages": 5,
  "currentPage": 1,
  "items": ["147748", "149250", "148070"]
}

Next Steps​