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 Tags API
version: 1.0.0
extends: openapi/lightspeed-tags-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['/tags'].get
update:
x-apievangelist-phrasing:
intent: List product tags
effect: read
questions:
- What tags am I using to group products?
- Can I see deleted product tags too?
instructions:
- text: List all product tags.
- text: List product tags with the deleted filter set to {deleted}.
slots:
deleted: query.deleted
method: generated
generated: '2026-09-26'
- target: $.paths['/tags'].post
update:
x-apievangelist-phrasing:
intent: Create a product tag
effect: write
questions:
- How do I create a new tag to label products?
- Can I add a tag like 'clearance' for grouping items?
instructions:
- text: Create a product tag named {name}.
slots:
name: requestBody.name
- text: Add new tag {name} for labelling products.
slots:
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/tags/{tag_id}'].get
update:
x-apievangelist-phrasing:
intent: Get a product tag
effect: read
questions:
- What is the name of a tag with a given ID?
- Can I fetch one product tag by its ID?
instructions:
- text: Get product tag {tag}.
slots:
tag: path.tag_id
- text: Show me the tag with ID {tag}.
slots:
tag: path.tag_id
method: generated
generated: '2026-09-26'
- target: $.paths['/tags/{tag_id}'].put
update:
x-apievangelist-phrasing:
intent: Rename a product tag
effect: write
questions:
- Can I rename a tag without retagging all its products?
- How do I fix a typo in a tag's name?
instructions:
- text: Rename tag {tag} to {name}.
slots:
tag: path.tag_id
name: requestBody.name
- text: Change the name of product tag {tag} to {name}.
slots:
tag: path.tag_id
name: requestBody.name
method: generated
generated: '2026-09-26'
- target: $.paths['/tags/{tag_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a product tag
effect: destructive
questions:
- What happens to products when I delete their tag?
- Can I remove a tag I no longer use?
instructions:
- text: Delete product tag {tag}.
slots:
tag: path.tag_id
- text: Remove tag {tag} and detach it from its products.
slots:
tag: path.tag_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.