Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Registers API

8 actions 8 updates phrasing extends openapi/lightspeed-registers-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 8

$.info
$.paths['/button_layouts'].get
$.paths['/button_layouts/{button_layout_id}'].get
$.paths['/registers'].get
$.paths['/registers/{register_id}'].get
$.paths['/registers/{register_id}/actions/close'].put
$.paths['/registers/{register_id}/actions/open'].put
$.paths['/registers/{register_id}/payments_summary'].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 Registers API
  version: 1.0.0
extends: openapi/lightspeed-registers-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: 7
- target: $.paths['/button_layouts'].get
  update:
    x-apievangelist-phrasing:
      intent: List register button layouts
      effect: read
      questions:
      - What quick key button layouts are set up for my registers?
      - Can I include deleted quick key layouts in the list?
      instructions:
      - text: List all register button layouts.
      - text: List quick key layouts with the deleted filter set to {deleted}.
        slots:
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/button_layouts/{button_layout_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a register button layout
      effect: read
      questions:
      - How are the quick key buttons arranged in one layout?
      - Can I fetch a single quick key layout by ID?
      instructions:
      - text: Get button layout {layout}.
        slots:
          layout: path.button_layout_id
      - text: Show the quick keys in layout {layout}.
        slots:
          layout: path.button_layout_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/registers'].get
  update:
    x-apievangelist-phrasing:
      intent: List registers
      effect: read
      questions:
      - Which registers are set up across my outlets?
      - Can I see registers that have been deleted?
      instructions:
      - text: List all registers in my store.
      - text: List registers with the deleted filter {deleted}.
        slots:
          deleted: query.deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/registers/{register_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a register
      effect: read
      questions:
      - Is a particular register currently open or closed?
      - What settings does one register have?
      instructions:
      - text: Get register {register}.
        slots:
          register: path.register_id
      - text: Show the details of till {register}.
        slots:
          register: path.register_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/registers/{register_id}/actions/close'].put
  update:
    x-apievangelist-phrasing:
      intent: Close a register
      effect: write
      questions:
      - How do I close a till at the end of the day?
      - Can I record counted payment totals when closing a register?
      instructions:
      - text: Close register {register}.
        slots:
          register: path.register_id
      - text: Close register {register} with counted payments {payments}.
        slots:
          register: path.register_id
          payments: requestBody.payments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/registers/{register_id}/actions/open'].put
  update:
    x-apievangelist-phrasing:
      intent: Open a register
      effect: write
      questions:
      - How do I open a till before trading starts?
      - Can I set the time a register was opened?
      instructions:
      - text: Open register {register}.
        slots:
          register: path.register_id
      - text: Open register {register} at {time}.
        slots:
          register: path.register_id
          time: requestBody.register_open_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/registers/{register_id}/payments_summary'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a register's payment totals
      effect: read
      questions:
      - How much cash and card has one register taken?
      - Can I see payment totals by payment type for a till?
      instructions:
      - text: Summarize payments for register {register}.
        slots:
          register: path.register_id
      - text: Show totals per payment type on register {register}.
        slots:
          register: path.register_id
      method: generated
      generated: '2026-09-26'