Lightspeed Commerce · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for 2026-07 Loyalty Adjustments [BETA] API

2 actions 2 updates phrasing extends openapi/lightspeed-loyalty-adjustments-beta-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 2

$.info
$.paths['/loyalty/adjustments/bulk'].post

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 Loyalty Adjustments [BETA] API
  version: 1.0.0
extends: openapi/lightspeed-loyalty-adjustments-beta-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/loyalty/adjustments/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Adjust loyalty balances for many customers at once
      effect: write
      questions:
      - Can I change the loyalty balance of a whole batch of customers in one request?
      - How do I stop a bulk loyalty adjustment from being applied twice if I resend it?
      - What permission does a bulk loyalty balance update need in Lightspeed Retail?
      instructions:
      - text: 'Apply these loyalty balance adjustments to multiple customers in one bulk operation: {adjustments}.'
        slots:
          adjustments: requestBody.adjustments
      - text: Run the bulk loyalty adjustment {adjustments} with session ID {session_id} so a retry is only applied once.
        slots:
          adjustments: requestBody.adjustments
          session_id: requestBody.session_id
      method: generated
      generated: '2026-10-02'