Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Outlets API

3 actions 3 updates phrasing extends openapi/lightspeed-outlets-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 3

$.info

$.paths['/outlets'].get

$.paths['/outlets/{outlet_id}'].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 Outlets API
  version: 1.0.0
extends: openapi/lightspeed-outlets-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: 2
- target: $.paths['/outlets'].get
  update:
    x-apievangelist-phrasing:
      intent: List outlets
      effect: read
      questions:
      - Which store locations do I have?
      - Can I include deleted outlets in the list?
      instructions:
      - text: List all my outlets.
      - text: List outlets with the deleted filter set to {deleted}.
        slots:
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/outlets/{outlet_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an outlet
      effect: read
      questions:
      - What address and settings does one store location have?
      - Can I fetch a single outlet by its ID?
      instructions:
      - text: Get outlet {outlet}.
        slots:
          outlet: path.outlet_id
      - text: Show the details of store location {outlet}.
        slots:
          outlet: path.outlet_id
      method: generated
      generated: '2026-09-26'