> ## Documentation Index > Fetch the complete documentation index at: https://docs-pos.solya.app/llms.txt > Use this file to discover all available pages before exploring further. # Global cross-entity search > Searches products, customers and brands in one call, matched case-insensitively on name / label / SKU references. Each source is scanned in full — the route pages every product / customer / brand directory to completion before matching — so a hit is never hidden behind a page cap, even on a book of thousands. Returns a flat list grouped by source in display order (products, then customers, then brands). `q` is the free-text term — a blank/absent `q` returns an empty set (the search is dormant until you type). `limit` (1..50, default 10) caps the RETURNED hits (not what is scanned); a non-numeric value clamps to the default rather than erroring. Always a 200 — a read narrows, it never fails on bad input. ## OpenAPI ````yaml /openapi.json get /v1/search openapi: 3.0.3 info: title: Solya POS API version: 1.0.0 description: >- The Solya POS backend HTTP surface. Every documented operation is agent-ready: it carries an `operationId`, an agent-facing `description`, the `pos.*` scopes it enforces (`x-required-permissions`) and an `x-agent-tier`. Success responses return the payload as raw JSON; failures return the `ErrorResponse` envelope (`{ error: { code, message, statusCode } }`). servers: - url: / description: The backend, relative to its deployed origin. security: [] paths: /v1/search: get: tags: - Catalog summary: Global cross-entity search description: >- Searches products, customers and brands in one call, matched case-insensitively on name / label / SKU references. Each source is scanned in full — the route pages every product / customer / brand directory to completion before matching — so a hit is never hidden behind a page cap, even on a book of thousands. Returns a flat list grouped by source in display order (products, then customers, then brands). `q` is the free-text term — a blank/absent `q` returns an empty set (the search is dormant until you type). `limit` (1..50, default 10) caps the RETURNED hits (not what is scanned); a non-numeric value clamps to the default rather than erroring. Always a 200 — a read narrows, it never fails on bad input. operationId: search parameters: - schema: type: string in: query name: q required: false - schema: type: string in: query name: limit required: false responses: '200': description: The matched hits, grouped by source in display order. content: application/json: schema: type: object properties: results: type: array items: type: object properties: type: type: string enum: - product - customer - brand id: type: string label: type: string sublabel: type: string required: - type - id - label additionalProperties: false required: - results additionalProperties: false description: The matched hits, grouped by source in display order. example: results: - type: product id: prod-espresso label: Espresso Blend 1kg sublabel: cafe - type: brand id: brand-solya label: Maison Solya sublabel: France '400': description: >- The request failed schema validation; `error.fieldErrors` lists the fields. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': description: No valid credential was presented — send a bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: The actor is authenticated but lacks the required `pos.*` scope. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: An unexpected server error — safe to retry idempotent requests. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ValidationErrorResponse: type: object required: - error additionalProperties: false description: >- A `VALIDATION_FAILED` envelope carrying the offending fields in `fieldErrors`. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED message: type: string statusCode: type: integer fieldErrors: type: array description: >- One entry per rejected field: the field path and why it was rejected. items: type: object required: - field - message additionalProperties: false properties: field: type: string description: Dot-path of the offending field. message: type: string description: Why the field was rejected. ErrorResponse: type: object required: - error additionalProperties: false description: The uniform failure envelope every non-2xx response returns. properties: error: type: object required: - code - message - statusCode additionalProperties: false properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHORIZED - FORBIDDEN - NOT_FOUND - CONFLICT - BUSINESS_RULE_VIOLATION - INTERNAL_ERROR description: >- Machine-readable kernel `ResultCode` — branch on this, not on `message`. message: type: string description: >- Human-readable explanation. Safe to surface; never leaks server internals. statusCode: type: integer description: >- The HTTP status, mirrored into the body so a client need not read headers. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- `Authorization: Bearer `. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same `pos.*` scope vocabulary the route guards enforce. ````