Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Payment Types API

2 actions 2 updates phrasing extends openapi/lightspeed-payment-types-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['/payment_types'].get

OpenAPI Overlay

Raw ↑ 
# 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 Payment Types API
  version: 1.0.0
extends: openapi/lightspeed-payment-types-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['/payment_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List payment types
      effect: read
      questions:
      - What payment types like cash or card are set up in my store?
      - Can I list only the Lightspeed Payments payment types for an outlet?
      instructions:
      - text: List the payment types for outlet {outlet_id}.
        slots:
          outlet_id: query.outlet_id
      - text: 'List payment types in currency {currency}, only Lightspeed Payments: {only_lspay}.'
        slots:
          currency: query.currency
          only_lspay: query.only_lspay
      method: generated
      generated: '2026-09-26'