Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Product Types API

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

$.info

$.paths['/product_types'].get

$.paths['/product_types/{product_type_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 Product Types API
  version: 1.0.0
extends: openapi/lightspeed-product-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: 2
- target: $.paths['/product_types'].get
  update:
    x-apievangelist-phrasing:
      intent: List product types (deprecated)
      effect: read
      questions:
      - What product types exist in my catalog under the older classification?
      - Can I still list the deprecated product types instead of categories?
      instructions:
      - text: List all product types.
      - text: List deprecated product types with the deleted filter {deleted}.
        slots:
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/product_types/{product_type_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product type
      effect: read
      questions:
      - What is the name of a particular legacy product type?
      - Can I fetch one product type by ID?
      instructions:
      - text: Get product type {type}.
        slots:
          type: path.product_type_id
      - text: Show the legacy product type with ID {type}.
        slots:
          type: path.product_type_id
      method: generated
      generated: '2026-09-26'