> ## Documentation Index
> Fetch the complete documentation index at: https://docs.marzipan.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Search

> Search across products, pages, and other content using a query string. Returns relevant results based on the search term.



## OpenAPI

````yaml api-reference/openapi.json get /search
openapi: 3.0.0
info:
  title: Marzipan API
  version: 1.0.0
servers:
  - url: https://api.marzipan.co/v1
security:
  - tenantAuth: []
tags:
  - name: Account
    description: >-
      Account management endpoints including registration, login, and user
      details
  - name: Carts
    description: Shopping cart management endpoints
  - name: Products
    description: Product catalog and search endpoints
  - name: Subscriptions
    description: Subscription management and renewal endpoints
  - name: CMS
    description: Content management system endpoints
  - name: Messaging
    description: Message and communication endpoints
  - name: Search
    description: Search functionality endpoints
paths:
  /search:
    parameters: []
    get:
      tags:
        - Search
      summary: Search
      description: >-
        Search across products, pages, and other content using a query string.
        Returns relevant results based on the search term.
      parameters:
        - name: query
          in: query
          required: true
          description: Search term to find matching content
          schema:
            type: string
            minLength: 1
          example: malbec
        - name: type
          in: query
          required: false
          description: Filter results by content type. If not specified, searches all types
          schema:
            type: string
            enum:
              - products
              - pages
              - collections
              - events
              - subscription_packages
        - name: limit
          in: query
          required: false
          description: Maximum number of results to return per type
          schema:
            type: integer
            minimum: 1
            maximum: 50
            default: 10
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  query:
                    type: string
                    description: The search query that was executed
                  total_results:
                    type: integer
                    description: Total number of results found across all types
                  results:
                    type: object
                    properties:
                      products:
                        type: array
                        items:
                          $ref: '#/components/schemas/SearchResult'
                        description: Product search results
                      pages:
                        type: array
                        items:
                          $ref: '#/components/schemas/SearchResult'
                        description: Page search results
                      collections:
                        type: array
                        items:
                          $ref: '#/components/schemas/SearchResult'
                        description: Collection search results
                      events:
                        type: array
                        items:
                          $ref: '#/components/schemas/SearchResult'
                        description: Event search results
                      subscription_packages:
                        type: array
                        items:
                          $ref: '#/components/schemas/SearchResult'
                        description: Subscription package search results
                    description: Search results organized by content type
              example:
                query: malbec
                total_results: 3
                results:
                  products:
                    - id: 2e2805a1-738e-4118-8a8b-f9431f0e210c
                      type: product
                      title: Cellar Selection Malbec
                      slug: cellar-selection-malbec-2015
                      url: >-
                        https://api.marzipan.co/products/cellar-selection-malbec-2015
                      excerpt: >-
                        Premium Malbec with rich, full-bodied flavor profile and
                        notes of dark fruit
                      image:
                        id: 0736c529-a33d-4b8c-8126-eb69779dcdad
                        path: 1/0736c529-a33d-4b8c-8126-eb69779dcdad.jpg
                        src: >-
                          https://marzipan-cloud-dev.b-cdn.net/1/0736c529-a33d-4b8c-8126-eb69779dcdad.jpg
                        alt: Cellar Selection Malbec 2015 bottle
                        mimeType: image/jpeg
                        filename: 0736c529-a33d-4b8c-8126-eb69779dcdad.jpg
                      price: £24.99
                      status: active
                  pages:
                    - id: page-wine-guide
                      type: page
                      title: Malbec Wine Guide
                      slug: malbec-wine-guide
                      url: https://api.marzipan.co/pages/malbec-wine-guide
                      excerpt: >-
                        Learn about Malbec wines, their origins, flavor
                        profiles, and perfect food pairings
                      image: null
                      price: null
                      status: published
                  collections:
                    - id: 885ea507-690b-4598-a8fc-095c0528be24
                      type: collection
                      title: Red Wine Collection
                      slug: red-wines
                      url: https://api.marzipan.co/collections/red-wines
                      excerpt: >-
                        Our carefully curated selection of premium red wines
                        including Malbec, Cabernet, and more
                      image:
                        id: 1b978a90-3ecb-4f37-b480-9fb81882176e
                        src: >-
                          https://marzipan-cloud-dev.b-cdn.net/1/1b978a90-3ecb-4f37-b480-9fb81882176e.jpg
                        alt: Red wine collection
                      price: null
                      status: active
                  events: []
                  subscription_packages: []
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
              example:
                message: string
components:
  schemas:
    SearchResult:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the result
        type:
          type: string
          enum:
            - product
            - page
            - collection
            - event
            - subscription_package
          description: Type of search result
        title:
          type: string
          description: Title or name of the result
        slug:
          type: string
          description: URL-friendly identifier
        url:
          type: string
          description: URL to the result
        excerpt:
          type: string
          nullable: true
          description: Brief excerpt or description
        image:
          $ref: '#/components/schemas/ProductImage'
          nullable: true
          description: Associated image if available
        price:
          type: string
          nullable: true
          description: Formatted price for product results
        status:
          type: string
          description: Status of the result
    ProductImage:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier for the image
        path:
          type: string
          description: Relative path to the image file
        src:
          type: string
          format: uri
          description: Full URL to access the image
        alt:
          type: string
          nullable: true
          description: Alternative text for accessibility
        mimeType:
          type: string
          description: MIME type of the image (e.g., image/jpeg, image/png)
        filename:
          type: string
          description: Original filename of the uploaded image
  securitySchemes:
    tenantAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your API token.
      bearerFormat: JWT

````