Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Promo Code API

3 actions 3 updates phrasing extends openapi/lightspeed-promo-code-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['/promocode/bulk'].delete

$.paths['/promocode/bulk/active'].post

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 Promo Code API
  version: 1.0.0
extends: openapi/lightspeed-promo-code-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['/promocode/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete promo codes in bulk
      effect: destructive
      questions:
      - How do I delete a batch of promo codes by their IDs?
      - Can I remove several promo codes in one request?
      instructions:
      - text: Delete these promo codes by ID in bulk.
      - text: Remove the listed promo code IDs from their promotions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/promocode/bulk/active'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether promo codes are active
      effect: read
      questions:
      - Are these promo codes still active?
      - Which promotion is each promo code attached to?
      instructions:
      - text: Check the active status of these promo codes.
      - text: Look up a batch of promo codes along with their associated promotions.
      method: generated
      generated: '2026-09-26'