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 Product Categories API
version: 1.0.0
extends: openapi/lightspeed-product-categories-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: 3
- target: $.paths['/product_categories'].get
update:
x-apievangelist-phrasing:
intent: List product categories
effect: read
questions:
- How are my product categories arranged into a hierarchy?
- Can I list only the top-level categories or the children of one category?
instructions:
- text: List all product categories.
- text: List the categories under parent {parent}.
slots:
parent: query.parent
- text: List categories under {parent} including {include}.
slots:
parent: query.parent
include: query.include
method: generated
generated: '2026-09-26'
- target: $.paths['/product_categories/bulk'].post
update:
x-apievangelist-phrasing:
intent: Create or update a category hierarchy
effect: write
questions:
- How do I build a nested category tree for my products in one go?
- Can I update several categories at once in bulk?
instructions:
- text: Create or update product categories {categories}.
slots:
categories: requestBody.categories
- text: Save category hierarchy {categories} in bulk.
slots:
categories: requestBody.categories
method: generated
generated: '2026-09-26'
- target: $.paths['/product_categories/bulk'].delete
update:
x-apievangelist-phrasing:
intent: Delete product categories
effect: destructive
questions:
- What happens to products and child categories when I delete a category?
- Can I delete several product categories in one request?
instructions:
- text: Delete product categories {ids}.
slots:
ids: requestBody.category_ids
- text: Remove categories {ids} and their descendants.
slots:
ids: requestBody.category_ids
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.