Lightspeed Retail X-Series

Returns a paginated list of brands.

Returns a single brand with a requested ID

Creates a new brand.

Return a paginated list of consignments.

Returns a single consignment with the requested ID.

Creates a new consignment.

Updates the given consignment.

Returns a paginated list of customers.

Returns a single customer with a requested ID.

Creates a new customer.

Updates the customer with the requested ID.

Deletes the customer with the requested ID.

Returns a paginated list of gift cards.

Finds and returns the given card number. Returns a 404 if the card does not exist.

Returns a paginated list of inventory records.

Returns a paginated list of stock adjustments for the authenticated retailer.

Creates one or more stock adjustments in a single batch (1–1000 items per request).

Returns a collection of outlets.

Returns a single outlet with the requested ID.

Returns a paginated collection of payment types.

Returns a paginated list of price books.

Returns a single price book with a requested ID

Returns a paginated list of price book products.

Returns a paginated list of products.

Returns a single product object with a given ID.

Creates a new product.

Update an existing product.

Deletes a single product. If a variant ID is provided, that single variant is removed.

List product categories

Create and update a product category hierarchy

Returns the metadata for a single product image with a given ID.

Allows for changing the image position in the list

DEPRECATED We recommend using the product_categories endpoint instead.

Returns a single product type with a given ID.

This endpoint lists all promotions for a retailer.

This will retrieve a single promotion using the given ID.

This endpoint creates a new promotion.

Returns a paginated list of registers.

Returns a single register with the requested ID.

This endpoint returns information about the retailer.

Returns a paginated list of sales.

Returns a single sale with a given ID.

Create a sale. Returns the ID of the created sale. See Sales 101 for usage information.

Update an existing sale by ID.

Returns a list of store credit customers.

Returns a list of store credits for the given customer id. Returns HTTP 404 (not 200 + empty array) when the customer ha…

Returns a paginated list of suppliers.

Returns a single supplier with a given ID.

Creates a new supplier.

Updates a supplier.

Returns a paginated list of taxes.

Returns a single tax with a given ID.

Returns a paginated list of users.

Returns a single user with the requested ID.

List all webhooks.

Create a webhook.

Delete a webhook

Fallback acknowledgement for unrecognised Lightspeed webhook deliveries. Returns HTTP 200 so the provider does not retry…

Processes Lightspeed product.update webhook events. Fires when product details change (name, description, SKU, price boo…

Processes Lightspeed inventory.update webhook events. Fires when product inventory quantities change through sales, adju…

Processes Lightspeed sale.update webhook events. Fires when sales are created or modified. May trigger multiple times fo…

Processes Lightspeed customer.update webhook events. Fires when customer records are created, modified, or deleted, incl…

Processes Lightspeed consignment.send webhook events. Fires when consigned products are dispatched to their destination…

Processes Lightspeed consignment.receive webhook events. Fires when consigned items are received into stock via supplier…

Processes Lightspeed register_closure.create webhook events. Fires each time a register session is closed and reconciled…