FlowRunner
PricingContact
Theme
Start Free

Lightspeed Retail X-Series

E-commerce

Lightspeed Retail X-Series, formerly Vend, is a cloud point of sale for retailers. Agents sync an ecommerce catalog into the store, push outside orders in as sales, manage inventory, consignments and purchase orders across outlets, work customers, loyalty and gift cards, and react to webhooks.

1 trigger 156 actions OAuth available
On Lightspeed Event fires when a register is closed
Get Register Payments Summary returns the counted total for each payment type
List Sales for that register and period returns what the system says was taken
The two are compared payment type by payment type, including sales the flow itself wrote in from other channels
The variance posts to the store channel with only the payment types that disagree
Create Stock Adjustments records the breakages and samples logged during the shift
The store manager explains or writes off the variance before the day is signed off

What This Integration Enables

Lightspeed Retail X-Series, which most people still call Vend, is different from the rest of the connectors in this category in one way that matters: the numbers in it describe a physical shop. A stock level is a shelf a person can walk to. A register total is a drawer somebody counts at close. A consignment moving to Received is a pallet that arrived. Automation against a point of sale is therefore never only a data operation, because staff will meet the result of it during their shift.

FlowRunner agents sync an ecommerce catalog into the store and write outside orders in as sales, so they appear in the customer's history and the stock ledger. They run the receiving workflow from supplier order through to Received, raise reorder consignments from live inventory levels, issue store credit and adjust loyalty for a segment, work gift cards, and react to a register closing. Two operations are worth knowing about before you design a flow. Update Consignment is how stock actually moves, because setting a supplier order to Received is the call that writes inventory. And Apply Discount saves nothing at all despite being a POST, which makes it a genuine pricing preview a checkout can call safely.

Without FlowRunner

Cash up is a paper exercise The drawer is counted, the total is compared against a printout, and the difference is written on a sheet nobody opens again
Online orders never reach the register A sale taken on the website is invisible in the store's own history, so loyalty, returns and stock all disagree with it
Reordering starts with a walk round the shelves Somebody notices a gap, checks the back room, and raises a supplier order from memory

With FlowRunner

Cash up is a variance with a name on it Counted totals and recorded sales are compared for you, and only the payment types that disagree reach a person
Every channel lands in one history Outside orders are written in as sales against a named register, so the customer's history and the stock ledger agree
Reordering starts from the numbers Inventory levels filtered to what needs procuring raise a supplier consignment, and a person approves the quantities

Use Case Scenarios

  • End of day reconciliation that only shows a manager what disagrees

    A register closes and the On Lightspeed Event trigger fires. The agent calls Get Register Payments Summary for the counted totals by payment type, lists the sales for that closure period, and compares them. Cash, card and gift card are checked separately, because a card total that matches while cash is short is a different conversation from both being off. The result posts to Slack as a short message naming only the payment types that disagree and by how much. Breakages and samples the team logged during the shift are written as a batch with Create Stock Adjustments so the shelf and the ledger start the next day in agreement.

  • Receiving a delivery without trusting the paperwork

    A supplier order sits in Lightspeed as a consignment. When the delivery arrives, the agent reads List Consignment Products for what was ordered and takes the counted quantities from the receiving app. Bulk Update Consignment Products writes the received quantities back in one call, and Get Consignment Totals shows the ordered and received figures side by side. If they match, Update Consignment moves the order to Received and the stock is written. If they do not, the agent stops and posts the short lines with the supplier, the order and the gap, because a consignment set to Received can no longer be updated and the shelf will disagree with the ledger from that moment on.

  • A loyalty campaign that runs once even when the flow runs twice

    Marketing picks a segment. The agent resolves it with List Customer Group Members, or builds it from sales history, and calls Bulk Adjust Loyalty with a session id so a retried request is applied once rather than twice. Customers owed store credit instead get Create Store Credit Transaction, with the client id serving the same purpose. The agent then writes the roster and the amounts to Google Sheets so the store team can answer a question at the counter without opening the back office. Points and credit are money to a customer standing in front of a cashier, so the record of who got what is part of the job, not an afterthought.

Human-in-Loop Highlight

Create Sale is how an order taken somewhere else reaches the register, and it carries two decisions the API will not make for you. State decides whether stock moves: a Closed sale is a completed transaction and decrements inventory, while Parked and Pending do not. And every sale needs a source naming the register it belongs to. Get either wrong and nothing fails. The sale lands, it appears in a register's takings, and a cashier counts a drawer at close that cannot possibly match, because part of the total was rung up by software on a shelf they never touched. Repairing it is worse than causing it, since Update Sale is a full replacement of the fields you send. So the first time a channel is wired in, the agent stops and asks: "Web orders will be written as Closed sales on register Front Counter 1, payment type Ecommerce, outlet Camden. That total will appear in tonight's cash up. Confirm the register and payment type?" A manager answers once, the agent writes every sale that way afterwards, and the person counting the drawer knows what is in it.

Agent processes routinely
Detects exception requiring judgment
Clear match Continues automatically
Ambiguous Routes to human via preferred channel
Human decides
Agent resumes with decision

Agent Capabilities

156 actions

Products

26
  • List Products Returns a page of products using the version cursor, optionally filtered by SKU or by product family name. Page size varies per endpoint and is not declared, so keep paging until the data array comes back empty rather than stopping on a short page.
  • Get Product Returns a single product, including its variant attributes, price, supplier links and image list.
  • Create Product Creates a product, optionally with its variants, per outlet inventory and supplier links in the same call. Variants require Variant Attributes to exist first, so create those before sending a variants array.
  • Update Product Updates a product. This route splits its body in two. Fields under Common apply to the whole variant family (name, description, brand, category, tags), while fields under Details apply only to the single variant addressed by the id (price, inventory, weight, active).
  • Delete Product Deletes a single product or, when the id names a variant, that one variant. Use Delete Product Family to remove a whole variant family in one call.
  • Delete Product Family Deletes an entire variant family given the id of any one of its members. This removes every sibling variant, not only the product named, so it is the destructive counterpart of Delete Product.
  • Upload Product Image Fetches an image from a URL and attaches it to a product. This route takes multipart form data rather than JSON or base64, so pass a link to the file (a FlowRunner file URL works) instead of encoded bytes.
  • Get Product Image Returns the metadata for one product image, which is how you check whether an upload finished processing.
  • Set Product Image Position Moves a product image within the product's image list, which decides which one is shown first on the register and in ecommerce.
  • Delete Product Image Removes one image from a product. The product itself is untouched.
  • List Product Categories Returns the product category hierarchy, either the whole tree or the direct children of one category. Categories replaced product types, which are deprecated.
  • Upsert Product Categories Creates and updates a product category hierarchy in one call. An entry with an id updates that category, and an entry without one creates it.
  • Delete Product Categories Deletes categories by id. Deleting a parent deletes its descendants too. Products under a deleted category are reassigned to its parent, or unassigned entirely when the deleted category was a root.
  • List Variant Attributes Returns the variant attributes defined for the store, such as Size or Color. These must exist before any variant can be created, so this is the first call in a variant build.
  • Create Variant Attribute Creates a variant attribute, the property that distinguishes one variant from another. Create every attribute a family needs before creating the products themselves.
  • Update Variant Attribute Renames a variant attribute. The rename applies everywhere the attribute is already used.
  • Delete Variant Attribute Deletes a variant attribute. An attribute that a variant family is currently using cannot be deleted, so remove or rebuild the family first.
  • List Brands Returns a page of brands using the version cursor. Brands are one of the three ways to group products, alongside tags and categories.
  • Create Brand Creates a brand that products can then be assigned to.
  • Update Brand Updates a brand's name or description. The vendor requires the name on every update, so it is sent even when only the description is changing.
  • Delete Brand Deletes a brand. Products carrying it are not deleted, they are simply left without a brand.
  • List Tags Returns a page of product tags using the version cursor. Tags are the free form grouping used by promotions and price books.
  • Create Tag Creates a product tag. Tags are what promotions and price books match on, so this is usually the first step of a campaign flow.
  • Update Tag Renames a tag. Every product carrying it keeps the association under the new name.
  • Delete Tag Deletes a tag. Products carrying it are not deleted, they simply lose the tag.
  • List Price Books For Product Returns every price book that carries a given product, with the price each one sets. This is the quickest way to answer why a product rings up at an unexpected price.

Suppliers

5
  • List Suppliers Returns a page of suppliers using the version cursor. Suppliers are what stock orders and product supply prices hang off.
  • Get Supplier Returns a single supplier with its full contact block.
  • Create Supplier Creates a supplier. The vendor requires a contact block, so this operation always sends one even when only the company name is known.
  • Update Supplier Updates a supplier. The vendor requires both the name and a contact block on every update, so send the current values for anything you are not changing.
  • Delete Supplier Deletes a supplier. Products linked to it are kept and simply lose the supplier link.

Inventory

10
  • List Inventory Records Returns inventory records, one per product per outlet, with the on hand count and reorder settings. Despite reading data this route is a POST, because its filters travel in the body rather than the query string.
  • Get Product Inventory Returns the inventory records for a single product across every outlet, which is the fastest stock check for one SKU.
  • List Inventory Levels Returns aggregated inventory levels with cost and reorder data, filtered by outlet, product or supplier and sorted by any of those measures.
  • Get Product Inventory Levels Returns the aggregated inventory levels for a single product, including cost and reorder figures the plain inventory record does not carry.
  • Set Reorder Points Sets the reorder point, reorder amount and reorder target for one or more products at specific outlets. The method must be consistent across every outlet for a product and across a whole variant family, so send the family together.
  • List Stock Adjustments Returns a page of stock adjustments, the audit trail of every manual stock in and stock out, using the version cursor.
  • Create Stock Adjustments Adjusts stock for one or more products at an outlet in a single batch of between 1 and 1000 entries. This is how a stocktake correction, a breakage or a received sample enters the ledger without a consignment.
  • List Adjustment Reasons Returns the store's custom inventory adjustment reasons, which are the labels a stock adjustment can be filed under.
  • Create Adjustment Reason Creates a custom inventory adjustment reason. Registering your own reason from a flow is what makes automated stock corrections legible in the store's reporting later.
  • Update Adjustment Reason Renames a custom inventory adjustment reason or turns it on and off. The direction (stock in or stock out) is fixed at creation and cannot be changed here.

Consignments

11
  • List Consignments Returns a page of consignments filtered by type, status or outlet. One noun covers four workflows: supplier orders, outlet transfers, returns to supplier and stocktakes.
  • Get Consignment Returns a single consignment header, including its type, status, outlets and supplier.
  • Create Consignment Creates a supplier order, outlet transfer, return or stocktake. The body is wrapped in a data object, which this operation does for you.
  • Update Consignment Moves a consignment through its workflow or edits its header. This is how stock actually moves: setting a supplier order to Received is what writes the inventory.
  • Delete Consignment Deletes a consignment. Which scope this needs depends on the consignment type, so a connection granted only stock_order rights can delete supplier orders and will be refused on transfers and stocktakes.
  • Get Consignment Totals Returns the counts and costs for a consignment. Not available for stocktakes, and the numbers only make sense at certain statuses: an Open or Sent consignment always reports a received count and cost of zero.
  • List Consignment Products Returns the line items on a consignment, with the expected count, the received count and the cost of each.
  • Add Consignment Product Adds one product to a consignment. The body is wrapped in a data object, handled here. On a supplier order, supplying Received against a Sent order automatically moves the whole order to Dispatched, and composite products cannot be added at all.
  • Update Consignment Product Updates one line item on a consignment. Which field the vendor actually writes depends on the consignment status: an Open or Sent supplier order takes the count, a Dispatched one takes the received quantity, and a Received or Cancelled one refuses the call entirely.
  • Delete Consignment Product Removes one product from a consignment. A supplier order refuses this once it is Dispatched, Received or Cancelled, an outlet transfer once it is Sent or Received, and a return once it is Sent.
  • Bulk Update Consignment Products Adds or updates many consignment line items in one call, which is how a received delivery or a counted stocktake is written back.

Purchase Orders

4
  • List Purchase Orders Returns a page of purchase orders using the version cursor. This is a read only surface and it only returns orders the connected user can see.
  • Get Purchase Order Returns a single purchase order header with its supplier, status and totals.
  • List Purchase Order Line Items Returns a page of line items on a purchase order, with ordered and received quantities per product.
  • List Purchase Order Deliveries Returns the deliveries recorded against a purchase order, which is how a partly filled order is reconciled delivery by delivery.

Sales

7
  • List Sales Returns a page of sales using the version cursor, newest changes last. For anything narrower than "everything since version N", use Search, which is the only route that filters sales by date, outlet, customer, register or payment type.
  • Get Sale Returns a single sale with its line items, payments, adjustments and totals.
  • Create Sale Records a sale, which is how an order taken outside Lightspeed reaches the register, the customer's history and the stock ledger. State decides whether stock moves: a Closed sale is a completed transaction and decrements inventory, while Parked and Pending do not.
  • Update Sale Updates an existing sale, which is how a parked sale is completed, a note is added or a sale is voided. This is a full replacement of the fields you send, so read the sale first and send back its line items and payments unless you intend to replace them.
  • Return Sale Starts a return against a closed sale and returns the new saved return sale. This only opens the return: the returned lines and the refund payment are then set with Update Sale on the id this call gives back, and nothing is refunded until that sale is closed.
  • List Quotes Returns a page of quotes. Quotes page differently from every other collection here: the cursor is the id of the last quote on the previous page and the size parameter is called limit.
  • Get Quote Returns a single quote with its products, totals and the ids of any sales it turned into.

Fulfillment

7
  • List Fulfillments Returns a page of fulfillment summaries filtered by outlet, sale, type or state, which is the work queue for click and collect and ship from store.
  • Fulfill Sale Completes every outstanding fulfillment on a sale in one call. The action is idempotent, so repeating it on an already fulfilled sale is safe.
  • Fulfill Line Items Fulfils specific line items on a sale, for a partial shipment. The current fulfillment version must be sent and is checked, so read the fulfillment first; this is what stops two staff members fulfilling the same line twice.
  • Pick Line Items Sets the picked quantity for specific line items on a sale, the first step of the pick, pack and fulfil sequence. The action is idempotent.
  • Pack Line Items Sets the packed quantity for specific line items on a sale. A negative quantity unpacks, and a source breakdown is not allowed on a negative quantity.
  • Get Fulfillment History Returns the ledger of state changes for one fulfillment, oldest first, covering created, picked, packed, fulfilled, voided and returned events per line item.
  • Render Packing Slip Returns a packing slip as an HTML document ready to print or convert to PDF, listing the items to pack, the delivery address and any serial numbers.

Customers

17
  • List Customers Returns a page of customers using the version cursor. To find a customer by email, name, phone or customer code, use Search instead, which is the only route that filters customers.
  • Get Customer Returns a single customer with contact details, group membership, loyalty settings and balances.
  • Create Customer Creates a customer. First name and last name are both required by the vendor even when only a company is being recorded, and nothing here deduplicates: sending the same email twice creates two customers.
  • Update Customer Updates a customer. First name and last name are required on every update, so send the current values when changing anything else.
  • Delete Customer Deletes a customer. Their past sales stay in the store's history; only the customer record goes.
  • List Customer Addresses Returns every billing and shipping address stored against a customer. These are the addresses a sale's fulfillment details point at.
  • Get Customer Address Returns a single stored address for a customer.
  • Create Customer Address Adds a billing or shipping address to a customer. Validation is strict and country aware. The country code must be ISO 3166-1 alpha-2, a state code is required for US and Canadian addresses, and the postcode must match the country's format. Address line 1 is capped at 50 characters, the city at 28 and the state at 35.
  • Update Customer Address Updates a stored address. The same strict validation applies as on create, and type, address line 1, city, postcode and country code are all required on every update.
  • Delete Customer Address Removes one stored address from a customer.
  • List Customer Groups Returns a page of customer groups. Groups are the hinge between customers and pricing: a price book or a promotion targets a group rather than individual customers.
  • Get Customer Group Returns a single customer group.
  • Create Customer Group Creates a customer group, the unit that price books and promotions are aimed at.
  • Update Customer Group Renames a customer group. Its members and the price books pointing at it are unaffected.
  • List Customer Group Members Returns a page of the customers in one group, using the version cursor.
  • Add Customers To Group Adds one or more customers to a customer group, which is how a flow moves a shopper onto trade pricing or into a loyalty tier.
  • Remove Customers From Group Removes customers from a group. Only the membership goes; the customers themselves are not deleted.

Store Credit and Loyalty

8
  • List Store Credits Returns every customer holding store credit, with their balance and their most recent transactions.
  • Get Customer Store Credit Returns one customer's store credit balance together with the full history of issues and redemptions.
  • Get Store Credit Balance Returns just the current store credit balance for a customer, without the transaction history. Use this before redeeming so the flow knows what is available.
  • Get Store Credit Report Returns the store wide store credit report, which is the outstanding liability a finance flow needs at period end.
  • Create Store Credit Transaction Issues, redeems or reverses store credit for a customer. A redemption amount must be negative; a positive amount on a redemption is rejected.
  • Hold Store Credit Places a temporary hold on part of a customer's store credit, reserving it while a checkout completes elsewhere. A hold is not a redemption: it must later be reversed with Reverse Store Credit Hold or followed by a redemption, or the credit stays locked.
  • Reverse Store Credit Hold Releases a hold placed on a customer's store credit, returning the reserved amount to their available balance.
  • Bulk Adjust Loyalty Credits or debits loyalty for many customers in one call, which is how a campaign awards points to a whole segment. This is a beta route at the vendor.

Gift Cards

9
  • List Gift Cards Returns a page of gift cards, optionally filtered by number or status. This route pages backwards through a before cursor holding a gift card id, not through the version cursor used elsewhere.
  • Create Gift Card Creates and activates a gift card with an opening balance, recorded as an activation transaction. The card number must be one you supply, so generate it or take it from a physical card.
  • Get Gift Card By Number Returns a gift card by its printed number, with its balance and every transaction against it. A card that does not exist answers 404 rather than an empty result.
  • Get Gift Card By ID Returns a gift card by its internal id, with its balance and transaction list.
  • Get Gift Card By Transaction Returns the gift card a given transaction belongs to, which is how a refund flow gets from a payment line back to the card.
  • Create Gift Card Transaction Redeems from or reloads a gift card. A redeem amount must be negative and a reload positive, and an attempt to redeem more than the balance answers 422 rather than 400.
  • Void Gift Card By Number Voids a gift card, setting its balance to zero and its status to voided. This is not reversible through the API, so confirm the number before calling it.
  • Void Gift Card By ID Voids a gift card by its internal id, zeroing the balance. Not reversible through the API.
  • Reverse Gift Card Transaction Reverses a redemption, adding a reversing transaction that puts the amount back on the card. Only transactions of type Redeem can be reversed; an activation or a reload cannot.

Pricing and Promotions

16
  • List Price Books Returns a page of price books, optionally narrowed to one customer group. A price book is a set of prices that applies to chosen outlets and customer groups between two dates.
  • Get Price Book Returns a single price book with the outlets and customer groups it applies to and the dates it is valid between.
  • Create Price Book Creates a price book. The vendor requires both the outlet list and the customer group list, so decide the audience up front; the prices themselves are added afterwards with Add Price Book Products.
  • Update Price Book Updates a price book's name, audience or validity dates. The outlet and customer group lists are required on every update and replace what is stored, so send the full lists.
  • List Price Book Products Returns the product entries in one price book, each with its price and any quantity break. The price that comes back is always tax exclusive, whatever the store's own tax setting is.
  • Add Price Book Products Adds priced product entries to a price book. The body is wrapped in a data array, handled here, and no more than 100 entries may be sent at once.
  • Update Price Book Products Updates existing priced entries in a price book. At most 100 entries per call, and the same tax inclusive or exclusive rule applies as on adding them.
  • Delete Price Book Products Removes priced entries from a price book so those products fall back to their normal price. The ids are price book product ids from List Price Book Products, not product ids, and at most 100 may be sent at once.
  • List Promotions Returns promotions, optionally limited by when they end. The two end time filters cannot be combined; use Search Promotions for anything richer.
  • Search Promotions Finds promotions by name, outlet, date window or lifecycle scope, sorted and paged. This is the route to use when a flow needs the promotions running right now.
  • Get Promotion Returns a single promotion with its condition, its action and any promo codes attached to it.
  • Create Promotion Creates a promotion from a condition (what has to be in the basket) and an action (what discount applies). Conditions and actions match on product tags, which is why tags are worth maintaining from a flow.
  • Update Promotion Updates a promotion. There is no partial update here. The vendor states that every field must be specified, so read the promotion first and send it back whole; anything you leave out is wiped rather than kept.
  • List Promotion Products Returns the products a promotion applies to and the discounted price of each, split into the condition set and the action set.
  • List Promotion Promo Codes Returns the promo codes attached to a promotion, with their redemption counts and limits.
  • Apply Discount Works out the best promotion for a basket and returns the sale with the discount applied. Nothing is saved: despite being a POST this changes no server side state, so it is safe to call as a pricing preview from an ecommerce checkout.

Taxes

4
  • List Taxes Returns the tax rates defined for the store. These ids are what a product's tax fields and a sale's tax lines refer to.
  • Get Tax Returns a single tax rate by id.
  • Create Tax Creates a tax rate. The clothing and footwear exemption fields only mean anything on a tax exclusive store and are ignored on a tax inclusive one.
  • List Outlet Taxes Returns the per outlet product tax records, which is how one product carries a different tax rate at different outlets.

Outlets and Registers

10
  • List Outlets Returns the store's outlets, which are the physical locations inventory, registers and price books hang off. This is the connection test: it is the smallest call that proves the domain prefix, the token and the scopes are all right.
  • Get Outlet Returns a single outlet with its address, currency and time zone. The time zone matters, because sale searches interpret their time filters in it.
  • List Registers Returns the registers in the store with their current open or closed state. The register count also sets the rate limit, which is 300 requests per register plus 50, per 5 minutes.
  • Get Register Returns a single register with its outlet, open state and current sequence numbers.
  • Open Register Opens a register so sales can be rung up on it, starting a new register closure period.
  • Close Register Closes a register and records the counted total for each payment type. Closing is what fires the Register Closed webhook, which is the natural trigger for an end of day flow.
  • Get Register Payments Summary Returns the totals taken on a register broken down by payment type, which is what a cash up reconciliation compares the drawer against.
  • List Shifts Returns a page of staff shifts using the version cursor, which is the raw material for a payroll or rostering export.
  • List Payment Types Returns the payment types configured for the store, optionally filtered by outlet or currency. Their ids are required on every payment line of a sale and on a register close.
  • Get Retailer Returns the store's own settings, including its name, currency, time zone and whether prices are tax inclusive. Read this once at the start of a flow: whether the store is tax inclusive decides which price field every product write should use.

Staff

4
  • Get Current User Returns the user the connection is authenticated as, which is how a flow discovers whose token it is holding.
  • List Users Returns a page of staff users using the version cursor. Their ids are what sales, consignments and gift card transactions are attributed to.
  • Get User Returns a single staff user with their role and outlet.
  • Get User Sales Totals Returns one staff member's sales totals, which is the figure a commission or leaderboard flow runs on.

Search

1
  • Search Searches sales, products or customers with the filters the plain list routes do not offer, such as a date window on sales, a SKU or supplier on products, or an email on customers.

Custom Fields

6
  • List Custom Fields Returns the custom field definitions for one entity type. Custom fields are how a flow stores its own reference on a Lightspeed sale, customer, product or line item without inventing a note format.
  • Create Custom Field Defines a new custom field on sales, line items, customers or products, and decides whether staff can see and edit it and whether it prints on the receipt.
  • Update Custom Field Changes a custom field's label or its visibility, editability and receipt printing. The name, entity and type are fixed at creation and cannot be changed here.
  • Delete Custom Field Deletes a custom field definition. Every value stored in it goes with it, across every record, and there is no undo.
  • Get Custom Field Values Returns the custom field values stored on one record, which is how a flow reads back its own reference from a sale or a customer.
  • Set Custom Field Values Stores custom field values on one record. This is the clean way to write your own order id or reference onto a Lightspeed sale so a later flow can find it again.

Business Rules

6
  • List Remote Rules Returns the remote business rules registered on the store, each of which is a URL Lightspeed calls out to while a sale is being rung up.
  • Create Remote Rule Registers a URL that Lightspeed calls while a sale is in progress, so your own logic can answer back. This is the second, inbound integration path: everything else in this service is FlowRunner calling Lightspeed, and a remote rule is Lightspeed calling you.
  • Delete Remote Rule Removes a remote rule registration so Lightspeed stops calling that URL. Delete the business rules that point at it first, or they are left referring to a rule that no longer exists.
  • List Business Rules Returns the business rules on the store, each binding a sale event to a remote rule.
  • Create Business Rule Binds a sale event to a remote rule, so Lightspeed calls that URL at the chosen moment of a transaction. Sale Ready For Payment is the useful one for a check that must happen before the customer pays.
  • Delete Business Rule Removes a business rule so Lightspeed stops calling its remote rule on that event. The remote rule registration itself stays.

Webhooks

5
  • List Webhooks Returns the webhooks registered on this connection, with their type, target URL and whether they are active. Use it to check what a trigger left behind, or to find a webhook that has gone quiet.
  • Get Webhook Returns a single webhook by id.
  • Create Webhook Registers a webhook that posts to your URL when the chosen event happens. You do not need this for the On Lightspeed Event trigger, which registers and removes its own webhooks; use it only to point Lightspeed at something outside FlowRunner.
  • Update Webhook Changes a webhook's event, target URL or active state. All three fields are required by the vendor on every update, so send the current values for anything you are not changing.
  • Delete Webhook Removes a webhook so Lightspeed stops posting that event.

Triggers

1 triggers

Event Triggers

1
  • On Lightspeed Event Fires when a sale, product, customer or inventory record changes, when a register is closed, or when a consignment is sent or received. The delivered record carries the legacy API shape rather than the dated version the actions use, so read it as a pointer and fetch the current record with Get Sale, Get Product or Get Customer when the flow needs live fields. Register Closed is the natural start for an end of day reconciliation.

Frequently Asked Questions

What can FlowRunner do with Lightspeed Retail X-Series?

FlowRunner agents can run List Products, Get Product, and Create Product in Lightspeed Retail X-Series, plus 153 more actions.

Does connecting Lightspeed Retail X-Series to FlowRunner require OAuth?

Yes. Lightspeed Retail X-Series connects to FlowRunner with OAuth 2.0, so agents authenticate without handling raw credentials.

Can Lightspeed Retail X-Series trigger a FlowRunner workflow automatically?

Yes. Lightspeed Retail X-Series supports 1 trigger that can start a FlowRunner workflow automatically.

Start building with Lightspeed Retail X-Series

Free plan, no card required. Connect in minutes.