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.
# 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 Brands API
version: 1.0.0
extends: openapi/lightspeed-brands-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: 5
- target: $.paths['/brands'].get
update:
x-apievangelist-phrasing:
intent: List brands
effect: read
questions:
- What product brands are set up in my store?
- Can I include deleted brands in the list?
instructions:
- text: List all product brands.
- text: List brands with the deleted filter set to {deleted}.
slots:
deleted: query.deleted
method: generated
generated: '2026-09-26'
- target: $.paths['/brands'].post
update:
x-apievangelist-phrasing:
intent: Create a brand
effect: write
questions:
- How do I add a new brand to assign products to?
- Can I give a brand a description?
instructions:
- text: Create a brand called {name}.
slots:
name: requestBody.name
- text: Add brand {name} with description {description}.
slots:
name: requestBody.name
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/brands/{brand_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a brand
effect: read
questions:
- What are the details of one brand?
- Can I fetch a brand by its ID?
instructions:
- text: Get brand {brand}.
slots:
brand: path.brand_id
- text: Show me the brand with ID {brand}.
slots:
brand: path.brand_id
method: generated
generated: '2026-09-26'
- target: $.paths['/brands/{brand_id}'].put
update:
x-apievangelist-phrasing:
intent: Update a brand
effect: write
questions:
- Can I rename an existing brand?
- How do I change a brand's description?
instructions:
- text: Rename brand {brand} to {name}.
slots:
brand: path.brand_id
name: requestBody.name
- text: Set brand {brand} name to {name} and description to {description}.
slots:
brand: path.brand_id
name: requestBody.name
description: requestBody.description
method: generated
generated: '2026-09-26'
- target: $.paths['/brands/{brand_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a brand
effect: destructive
questions:
- What happens to products when their brand is deleted?
- Can I remove a brand I no longer sell?
instructions:
- text: Delete brand {brand}.
slots:
brand: path.brand_id
- text: Remove brand {brand} and unlink its products.
slots:
brand: path.brand_id
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.