Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Serial Numbers API

5 actions 5 updates phrasing extends openapi/lightspeed-serial-numbers-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 5

$.info
$.paths['/serialnumbers'].get
$.paths['/serialnumbers'].post
$.paths['/serialnumbers/{serialnumber_id}'].get
$.paths['/serialnumbers/{serialnumber_id}'].delete

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 Serial Numbers API
  version: 1.0.0
extends: openapi/lightspeed-serial-numbers-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: 4
- target: $.paths['/serialnumbers'].get
  update:
    x-apievangelist-phrasing:
      intent: List serial numbers
      effect: read
      questions:
      - Which serial numbers are recorded for a product?
      - Can I find the serial number sold on a specific sale?
      instructions:
      - text: List serial numbers for product {product_id}.
        slots:
          product_id: query.product_id
      - text: Show serial numbers attached to sale {sale_id} at outlet {outlet_id}.
        slots:
          sale_id: query.sale_id
          outlet_id: query.outlet_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/serialnumbers'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a serial number for a product
      effect: write
      questions:
      - How do I register a serial number for an item at an outlet?
      - What do I need to record a new serial number?
      instructions:
      - text: Create serial number {code} for product {product_id} at outlet {outlet_id}.
        slots:
          code: requestBody.code
          product_id: requestBody.product_id
          outlet_id: requestBody.outlet_id
      - text: Record serial {code} on product {product_id} in outlet {outlet_id}.
        slots:
          code: requestBody.code
          product_id: requestBody.product_id
          outlet_id: requestBody.outlet_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/serialnumbers/{serialnumber_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single serial number
      effect: read
      questions:
      - How do I look up one serial number record by ID?
      - Which product and outlet does a serial number record belong to?
      instructions:
      - text: Get serial number record {serialnumber_id}.
        slots:
          serialnumber_id: path.serialnumber_id
      - text: Show the details of serial number {serialnumber_id}.
        slots:
          serialnumber_id: path.serialnumber_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/serialnumbers/{serialnumber_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a serial number
      effect: destructive
      questions:
      - How do I remove a serial number that was entered by mistake?
      - Can I delete a serial number record?
      instructions:
      - text: Delete serial number {serialnumber_id}.
        slots:
          serialnumber_id: path.serialnumber_id
      - text: Remove the mistaken serial number record {serialnumber_id}.
        slots:
          serialnumber_id: path.serialnumber_id
      method: generated
      generated: '2026-09-26'