Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Taxes API

4 actions 4 updates phrasing extends openapi/lightspeed-taxes-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 4

$.info

$.paths['/taxes'].get

$.paths['/taxes'].post

$.paths['/taxes/{tax_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 Taxes API
  version: 1.0.0
extends: openapi/lightspeed-taxes-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: 3
- target: $.paths['/taxes'].get
  update:
    x-apievangelist-phrasing:
      intent: List sales taxes
      effect: read
      questions:
      - What sales tax rates are set up in my store?
      - Can I page through all the taxes configured?
      instructions:
      - text: List all taxes.
      - text: List taxes, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/taxes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sales tax
      effect: write
      questions:
      - How do I add a new sales tax rate?
      - Can a tax exempt clothing and footwear under a threshold?
      instructions:
      - text: Create a tax named {name} at rate {rate}.
        slots:
          name: requestBody.name
          rate: requestBody.rate
      - text: Add tax {name} at {rate} with a clothing and footwear exemption threshold of {clothing_footwear_threshold_value}.
        slots:
          name: requestBody.name
          rate: requestBody.rate
          clothing_footwear_threshold_value: requestBody.clothing_footwear_threshold_value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/taxes/{tax_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single tax
      effect: read
      questions:
      - What rate does a particular tax apply?
      - How do I look up one tax by its ID?
      instructions:
      - text: Get tax {tax_id}.
        slots:
          tax_id: path.tax_id
      - text: Show the rate and settings of tax {tax_id}.
        slots:
          tax_id: path.tax_id
      method: generated
      generated: '2026-09-26'