# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Lightspeed Restaurant K Series Rich Item API version: 1.0.0 extends: openapi/lightspeed-rich-item-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: 10 - target: $.paths['/i/allergens'].get update: x-apievangelist-phrasing: intent: List allergens available for rich items effect: read questions: - Which allergens can I tag on a menu item? - Where do I get the list of allergen codes for rich items? instructions: - text: List every allergen I can add to a rich item. - text: Show the allergen codes supported for item descriptions. method: generated generated: '2026-09-26' - target: $.paths['/i/locales/{businessId}'].get update: x-apievangelist-phrasing: intent: Get a business's item languages effect: read questions: - Which languages are my item descriptions set up in? - How do I check the locales configured for a business? instructions: - text: Get the item locales for business {businessId}. slots: businessId: path.businessId - text: Show which languages business {businessId} uses for items. slots: businessId: path.businessId method: generated generated: '2026-09-26' - target: $.paths['/i/locales/{businessId}'].put update: x-apievangelist-phrasing: intent: Set a business's item languages effect: write questions: - How do I add French as an item language for my business? - Can item languages use regional codes like en_US? instructions: - text: Update the item languages for business {businessId}. slots: businessId: path.businessId - text: Set the supported locales on business {businessId} to English and French. slots: businessId: path.businessId method: generated generated: '2026-09-26' - target: $.paths['/i/richItem/{businessId}'].get update: x-apievangelist-phrasing: intent: List all rich items for a business effect: read questions: - How do I get all rich item descriptions and allergens for my business? - Can I page and sort through the full rich item catalog? instructions: - text: List all rich items for business {businessId}. slots: businessId: path.businessId - text: Get rich items for business {businessId}, page {page}, sorted by {sort}. slots: businessId: path.businessId page: query.page sort: query.sort method: generated generated: '2026-09-26' - target: $.paths['/i/richItem/{businessId}/{sku}'].get update: x-apievangelist-phrasing: intent: Get one rich item by SKU effect: read questions: - How do I fetch the rich content for a single SKU? - What allergens and descriptions are stored for one item? instructions: - text: Get the rich item for SKU {sku} in business {businessId}. slots: sku: path.sku businessId: path.businessId - text: Show the description and allergens for item {sku} at business {businessId}. slots: sku: path.sku businessId: path.businessId method: generated generated: '2026-09-26' - target: $.paths['/i/richItem/{businessId}/{sku}'].put update: x-apievangelist-phrasing: intent: Create or update a rich item's details effect: write questions: - How do I add allergens and descriptions to a menu item? - Can I change an item's SKU when updating its rich content? instructions: - text: Set allergens {allergenCodes} on rich item {sku} for business {businessId}. slots: allergenCodes: requestBody.allergenCodes sku: path.sku businessId: path.businessId - text: Create or update the rich item descriptions {descriptions} for SKU {sku} at business {businessId}. slots: descriptions: requestBody.descriptions sku: path.sku businessId: path.businessId method: generated generated: '2026-09-26' - target: $.paths['/i/richItem/{businessId}/{sku}'].delete update: x-apievangelist-phrasing: intent: Delete a rich item effect: destructive questions: - How do I remove the rich content for an item? - Can I delete a rich item by its SKU? instructions: - text: Delete the rich item {sku} from business {businessId}. slots: sku: path.sku businessId: path.businessId - text: Remove rich content for SKU {sku} at business {businessId}. slots: sku: path.sku businessId: path.businessId method: generated generated: '2026-09-26' - target: $.paths['/i/richItem/{businessId}/{sku}'].patch update: x-apievangelist-phrasing: intent: Set the picture on a rich item effect: write questions: - How do I upload a photo for a menu item? - Can I send a raw picture along with its file type? instructions: - text: Set the picture for rich item {sku} at business {businessId} to {picture}. slots: sku: path.sku businessId: path.businessId picture: requestBody.picture - text: Upload raw picture {rawPicture} of type {fileType} to item {sku} in business {businessId}. slots: rawPicture: requestBody.rawPicture fileType: requestBody.fileType sku: path.sku businessId: path.businessId method: generated generated: '2026-09-26' - target: $.paths['/i/richItem/{businessId}/itemsBySkus'].post update: x-apievangelist-phrasing: intent: Get rich items for a list of SKUs effect: read questions: - Can I fetch rich content for several specific SKUs at once? - How do I get rich items for just the SKUs on an order? instructions: - text: Get rich items for a list of SKUs in business {businessId}. slots: businessId: path.businessId - text: Look up rich content for these specific SKUs at business {businessId}. slots: businessId: path.businessId method: generated generated: '2026-09-26' - target: $.paths['/i/richItem/{businessId}/pictureSpec'].get update: x-apievangelist-phrasing: intent: Get picture requirements for rich items effect: read questions: - What size and format must a rich item picture be? - Which picture specifications apply before I upload an item photo? instructions: - text: Get the rich item picture specifications for business {businessId}. slots: businessId: path.businessId - text: Show the image requirements for item photos at business {businessId}. slots: businessId: path.businessId method: generated generated: '2026-09-26'