Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Search API

2 actions 2 updates phrasing extends openapi/lightspeed-search-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Lightspeed Commerce's API. It is a proposal applied on top of the contract, not a document Lightspeed Commerce publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/search'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Search API
  version: 1.0.0
extends: openapi/lightspeed-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search sales, products or customers
      effect: read
      questions:
      - How do I find all sales made by a customer between two dates?
      - Can I search products by SKU, supplier or brand?
      - What's the way to look up a customer by email or phone number?
      instructions:
      - text: Search {type} records for email {email}.
        slots:
          type: query.type
          email: query.email
      - text: Search {type} from {date_from} to {date_to} for customer {customer_id}.
        slots:
          type: query.type
          date_from: query.date_from
          date_to: query.date_to
          customer_id: query.customer_id
      - text: Search {type} with SKU {sku} from supplier {supplier_id}.
        slots:
          type: query.type
          sku: query.sku
          supplier_id: query.supplier_id
      method: generated
      generated: '2026-09-26'