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 Images API
version: 1.0.0
extends: openapi/lightspeed-product-images-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_images/{product_image_id}'].get
update:
x-apievangelist-phrasing:
intent: Check a product image
effect: read
questions:
- Has a product image finished processing after I uploaded it?
- Can I see the metadata of a single product image?
instructions:
- text: Get product image {image}.
slots:
image: path.product_image_id
- text: Check the upload status of product image {image}.
slots:
image: path.product_image_id
method: generated
generated: '2026-09-26'
- target: $.paths['/product_images/{product_image_id}'].put
update:
x-apievangelist-phrasing:
intent: Reorder a product image
effect: write
questions:
- How do I make a different image the first one shown for a product?
- Can I change the position of an image in a product's gallery?
instructions:
- text: Move product image {image} to position {position}.
slots:
image: path.product_image_id
position: requestBody.position
- text: Set the display position of image {image} to {position}.
slots:
image: path.product_image_id
position: requestBody.position
method: generated
generated: '2026-09-26'
- target: $.paths['/product_images/{product_image_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a product image
effect: destructive
questions:
- Can I remove an image from a product?
- What's the way to delete a product photo I uploaded by mistake?
instructions:
- text: Delete product image {image}.
slots:
image: path.product_image_id
- text: Remove photo {image} from its product.
slots:
image: path.product_image_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.