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

# Global search

> Search across all entity types: products, orders, sweeps, staff, customers, retailers, and locations.



## OpenAPI

````yaml api-reference/v1/openapi.yaml get /v1/search
openapi: 3.1.0
info:
  title: Goods API
  version: 1.0.0
  description: >-
    API for Goods grocery operations - scanner app, admin dashboard, and
    customer features
  contact:
    name: Goods Team
    url: https://goods.app
servers:
  - url: http://localhost:3000
    description: Local development
  - url: https://dev.api.switchyard.run
    description: Development
  - url: https://api.switchyard.run
    description: Production
security: []
tags:
  - name: v1
    description: API v1 - unified domain-based endpoints
  - name: Scanner
    description: Scanner app endpoints for drivers and pickers
  - name: Sweeps
    description: Sweep management - retail store pickup operations
  - name: RFC Picks
    description: Ready-for-checkout picking operations
  - name: Inventory
    description: Inventory management and barcode lookup
  - name: Admin
    description: Admin dashboard endpoints
  - name: Orders
    description: Order management
  - name: Products
    description: Product catalog management
  - name: Notifications
    description: Push, email, SMS, and Slack notification management
paths:
  /v1/search:
    get:
      tags:
        - Search
      summary: Global search
      description: >-
        Search across all entity types: products, orders, sweeps, staff,
        customers, retailers, and locations.
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 200
            description: Search query
            example: john
          required: true
          name: q
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 20
            default: 5
            description: Max items per category
            example: 5
          required: false
          name: limit
          in: query
      responses:
        '200':
          description: Global search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum:
                            - product
                            - scraped_product
                            - order
                            - sweep
                            - staff
                            - customer
                            - retailer
                            - location
                        title:
                          type: string
                        subtitle:
                          type: string
                        badge:
                          type: string
                        badgeVariant:
                          type: string
                        secondBadge:
                          type: string
                        secondBadgeVariant:
                          type: string
                        imageUrl:
                          type: string
                        logoUrl:
                          type: string
                      required:
                        - id
                        - type
                        - title
                      description: Global search result item
                  scrapedProducts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum:
                            - product
                            - scraped_product
                            - order
                            - sweep
                            - staff
                            - customer
                            - retailer
                            - location
                        title:
                          type: string
                        subtitle:
                          type: string
                        badge:
                          type: string
                        badgeVariant:
                          type: string
                        secondBadge:
                          type: string
                        secondBadgeVariant:
                          type: string
                        imageUrl:
                          type: string
                        logoUrl:
                          type: string
                      required:
                        - id
                        - type
                        - title
                      description: Global search result item
                  orders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum:
                            - product
                            - scraped_product
                            - order
                            - sweep
                            - staff
                            - customer
                            - retailer
                            - location
                        title:
                          type: string
                        subtitle:
                          type: string
                        badge:
                          type: string
                        badgeVariant:
                          type: string
                        secondBadge:
                          type: string
                        secondBadgeVariant:
                          type: string
                        imageUrl:
                          type: string
                        logoUrl:
                          type: string
                      required:
                        - id
                        - type
                        - title
                      description: Global search result item
                  sweeps:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum:
                            - product
                            - scraped_product
                            - order
                            - sweep
                            - staff
                            - customer
                            - retailer
                            - location
                        title:
                          type: string
                        subtitle:
                          type: string
                        badge:
                          type: string
                        badgeVariant:
                          type: string
                        secondBadge:
                          type: string
                        secondBadgeVariant:
                          type: string
                        imageUrl:
                          type: string
                        logoUrl:
                          type: string
                      required:
                        - id
                        - type
                        - title
                      description: Global search result item
                  staff:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum:
                            - product
                            - scraped_product
                            - order
                            - sweep
                            - staff
                            - customer
                            - retailer
                            - location
                        title:
                          type: string
                        subtitle:
                          type: string
                        badge:
                          type: string
                        badgeVariant:
                          type: string
                        secondBadge:
                          type: string
                        secondBadgeVariant:
                          type: string
                        imageUrl:
                          type: string
                        logoUrl:
                          type: string
                      required:
                        - id
                        - type
                        - title
                      description: Global search result item
                  customers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum:
                            - product
                            - scraped_product
                            - order
                            - sweep
                            - staff
                            - customer
                            - retailer
                            - location
                        title:
                          type: string
                        subtitle:
                          type: string
                        badge:
                          type: string
                        badgeVariant:
                          type: string
                        secondBadge:
                          type: string
                        secondBadgeVariant:
                          type: string
                        imageUrl:
                          type: string
                        logoUrl:
                          type: string
                      required:
                        - id
                        - type
                        - title
                      description: Global search result item
                  retailers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum:
                            - product
                            - scraped_product
                            - order
                            - sweep
                            - staff
                            - customer
                            - retailer
                            - location
                        title:
                          type: string
                        subtitle:
                          type: string
                        badge:
                          type: string
                        badgeVariant:
                          type: string
                        secondBadge:
                          type: string
                        secondBadgeVariant:
                          type: string
                        imageUrl:
                          type: string
                        logoUrl:
                          type: string
                      required:
                        - id
                        - type
                        - title
                      description: Global search result item
                  locations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        type:
                          type: string
                          enum:
                            - product
                            - scraped_product
                            - order
                            - sweep
                            - staff
                            - customer
                            - retailer
                            - location
                        title:
                          type: string
                        subtitle:
                          type: string
                        badge:
                          type: string
                        badgeVariant:
                          type: string
                        secondBadge:
                          type: string
                        secondBadgeVariant:
                          type: string
                        imageUrl:
                          type: string
                        logoUrl:
                          type: string
                      required:
                        - id
                        - type
                        - title
                      description: Global search result item
                required:
                  - products
                  - scrapedProducts
                  - orders
                  - sweeps
                  - staff
                  - customers
                  - retailers
                  - locations
                description: Global search response

````