Integration

Lightspeed Retail X-Series integration

Lightspeed Retail (X-Series, formerly Vend) is a point-of-sale and retail management platform. Manage products, variants, product families, categories, brands, tags and suppliers; read and adjust inventory, consignments (stock orders and transfers) and purchase orders; create and read sales, returns, quotes and fulfillments; manage customers, customer groups, addresses, gift cards, store credit, promotions and price books; read outlets, open and close registers, read shifts, taxes, payment types and users; and register webhooks. Partner billing, security and audit logs, sales channels and their request logs, business rules, service orders, customer contact channels, customer and outlet tax assignments, store credit holds, loyalty bulk adjustments, promo code bulk operations, product and family image uploads and image records, packing slips, button layouts, product code generation, custom inventory adjustment reasons, user deletion and session revocation, and the deprecated product type listing and gift card deletion are not exposed. Authentication is a personal token sent as a Bearer token; personal tokens are only available to retailers on the Plus plan and are created by an admin user in the Lightspeed web app. The base URL carries the store's domain prefix. The rate limit is 300 requests per register plus 50, per 5-minute window.

Connect Lightspeed Retail X-Series How integrations work

Ask it in chat

Say what should happen.
The workflow builds itself.

When this happens, do that in Lightspeed Retail X-Series.Built from the 157 Lightspeed Retail X-Series tools below, on the connection you add once.

What you can do with Lightspeed Retail X-Series

Each of these is one operation on one endpoint, available both as a workflow step and as a tool an AI agent can call on its own. Nothing bundles several operations into one action, so what a run did stays readable afterwards.

Most endpoints run on the free plan. A few, mainly the ones that publish on your behalf, need a paid plan.

Consignment, 5 operations

create_consignmentCreate consignmentPOSTCreate a consignment of type SUPPLIER (stock order), OUTLET (transfer), STOCKTAKE or RETURN. A SUPPLIER order cannot be created as DISPATCHED or RECEIVED; in its response reference is the order number and name the note.
delete_consignmentDelete consignmentDELETEDeletes the consignment with the given ID.
get_consignmentGet consignmentGETReturns a single consignment with the requested ID.
get_consignment_totalsGet consignment totalsGETReturns the count and cost for the given consignment. The consignment type can be `SUPPLIER`, `OUTLET` or `RETURN` (not `STOCKTAKE`).
list_consignmentsList consignmentsGETReturn a paginated list of consignments.

Customer, 5 operations

create_customerCreate customerPOSTCreates a new customer.
delete_customerDelete customerDELETEDeletes the customer with the requested ID.
get_customerGet customerGETReturns a single customer with a requested ID.
list_customer_group_customersList customer group customersGETList the customers in a customer group (group ID from list_customer_groups).
list_customersList customersGETReturns a paginated list of customers. To find customers by name, email, phone or customer code, use search.

Gift card, 5 operations

create_gift_cardCreate gift cardPOSTCreates and activates a new gift card. The gift card will be created with one transaction with status "ACTIVATION" which contains the initial balance of the gift card.
get_gift_cardGet gift cardGETFinds and returns the gift card with the given id. Returns a 404 if the card does not exist.
get_gift_card_by_numberGet gift card by numberGETFinds and returns the gift card with the given card number. Returns a 404 if the card does not exist.
get_gift_card_by_transactionGet gift card by transactionGETFinds and returns the gift card associated with the given transaction id. Returns a 404 if the gift card with the given transaction id was not found.
list_gift_cardsList gift cardsGETReturns a paginated list of gift cards.

Product family, 5 operations

add_products_to_product_familyAdd products to product familyPOSTAdds new variant products to an existing variant product family.
create_product_familyCreate product familyPOSTCreates a new product family.
delete_product_familyDelete product familyDELETEDeletes a product family and all its products.
get_product_familyGet product familyGETReturns a single product family with the requested ID. Optionally includes related entities like brands, categories, tags, and suppliers.
get_product_family_by_productGet product family by productGETReturns the product family of the specified product ID. Optionally includes related entities like brands, categories, tags, and suppliers.

Store credit, 5 operations

get_customer_store_creditGet customer store creditGETReturns a balance and a history of store credit operations for the given customer id.
get_customer_store_credit_balanceGet customer store credit balanceGETReturns a balance for the given customer id.
get_store_credit_reportGet store credit reportGETReturns a report of store credits.
list_store_creditList store creditGETList the store's store credit customers with their balance and their latest store credit transactions.
list_store_credit_balancesList store credit balancesPOSTGet the store credit balance of the given customers (a JSON array of customer IDs).

Brand, 4 operations

create_brandCreate brandPOSTCreates a new brand.
delete_brandDelete brandDELETEDeletes a brand. If there are products associated with the brand, the products will be disassociated from the brand.
get_brandGet brandGETReturns a single brand with a requested ID
list_brandsList brandsGETReturns a paginated list of brands.

Consignment product, 4 operations

bulk_upsert_consignment_productsBulk upsert consignment productsPOSTAdd or update many products of a consignment (keep it under 500): each item has product_id and count or received. On an OPEN or SENT SUPPLIER order, a received value marks the order DISPATCHED; counts accumulate.
create_consignment_productCreate consignment productPOSTAdd a product to a consignment, wrapped in data. Not on a RECEIVED or CANCELLED SUPPLIER order, nor a composite product; a received value on a SENT SUPPLIER order marks it DISPATCHED.
delete_consignment_productDelete consignment productDELETERemove a product from a consignment. Refused on a SUPPLIER order that is DISPATCHED, RECEIVED or CANCELLED, an OUTLET transfer that is SENT or RECEIVED, and a RETURN that is SENT.
list_products_by_consignment_idList products by consignment idGETReturns a collection of consignment products associated with the specified consignment.

Customer address, 4 operations

create_customer_addressCreate customer addressPOSTAdd a BILLING or SHIPPING address to a customer. Required: type, address_line_1 (max 50 chars), city (max 28), postcode and country_code (ISO 3166-1 alpha-2); state_code is required for US and CA.
delete_customer_addressDelete customer addressDELETEDeletes an address for the specified customer.
get_customer_addressGet customer addressGETReturns a single address by its ID for the specified customer.
list_customer_addressesList customer addressesGETReturns a list of all addresses associated with the specified customer.

Customer group, 4 operations

add_customers_to_customer_groupAdd customers to customer groupPOSTAssociates one or more customers with the given customer group
create_customer_groupCreate customer groupPOSTCreate a new customer group
get_customer_groupGet customer groupGETReturn given customer group
list_customer_groupsList customer groupsGETReturn a list of Customer Groups

Fulfillment, 4 operations

fulfill_line_itemsFulfill line itemsPOSTFulfills line items for a given sale. Each line item may optionally include a `source_breakdown`, which specifies how a fulfillment quantity should be sourced.
fulfill_saleFulfill salePOSTCompletes all fulfillments for a given sale. This is an idempotent action.
get_fulfillment_historyGet fulfillment historyGETRetrieves the history ledger for a single fulfillment, showing all state-change events (e.g. created, picked, packed, fulfilled, voided, returned) for each line item.
list_fulfillmentsList fulfillmentsGETRetrieves a paginated list of fulfillment summary items with optional filtering

Price book product, 4 operations

add_price_book_productsAdd price book productsPOSTCreate price book products.
list_price_book_productsList price book productsGETReturns a paginated list of price book products.
list_product_price_booksList product price booksGETThis endpoint returns the list of price books the given product is in.
list_products_in_price_bookList products in price bookGETReturns a list of price book products for a given price book. > **Note**: The returned retail price is the tax exclusive price of the product.

Register, 4 operations

close_registerClose registerPUTCloses a single register with the requested ID.
get_registerGet registerGETReturns a single register with the requested ID.
get_register_payments_summaryGet register payments summaryGETReturns a payload containing payment totals for all payments types defined in the account for a single register.
list_registersList registersGETReturns a paginated list of registers.

Serialnumber, 4 operations

create_serialnumberCreate serialnumberPOSTCreates a serial number.
delete_serialnumberDelete serialnumberDELETEDeletes a serial number.
get_serialnumberGet serialnumberGETReturns a single serial number.
list_serialnumbersList serialnumbersGETReturns a paginated list of serial numbers.

User, 4 operations

get_current_userGet current userGETReturns the current user.
get_userGet userGETReturns a single user with the requested ID.
get_user_sale_totalsGet user sale totalsGETReturns a single user's sales totals.
get_users_by_idsGet users by idsPOSTGet multiple users by their IDs in one call.

Custom field, 3 operations

create_custom_fieldCreate custom fieldPOSTCreate a new custom field definition for a given entity type.
delete_custom_fieldDelete custom fieldDELETEDelete a custom field and all the values stored on that field.
list_custom_fieldsList custom fieldsGETReturns the custom field definitions for a given entity type.

Price book, 3 operations

create_price_bookCreate price bookPOSTCreate a price book
get_price_bookGet price bookGETReturns a single price book with a requested ID
list_price_booksList price booksGETReturns a paginated list of price books.

Product, 3 operations

delete_productDelete productDELETEDeletes a product by ID.
get_productGet productGETReturns a single product with the requested ID. Optionally includes related entities.
list_productsList productsGETReturns a paginated list of products using version-based cursor pagination.

Product category, 3 operations

create_update_product_categoriesCreate update product categoriesPOSTCreate or update product categories and their hierarchy in one call.
delete_product_categoriesDelete product categoriesDELETEDelete a list of categories. If the category is a parent or root, the descendent categories also get deleted.
list_product_categoriesList product categoriesGETList the product categories of the store (the category hierarchy).

Promotion, 3 operations

create_promotionCreate promotionPOSTThis endpoint creates a new promotion. It responds with the newly-created promotion, including the promotion's ID.
get_promotionGet promotionGETThis will retrieve a single promotion using the given ID.
list_promotionsList promotionsGETThis endpoint lists all promotions for a retailer. There are optional query parameters that allow filtering promotions.

Sale, 3 operations

create_saleCreate salePOSTCreate a sale: state (parked, pending, voided or closed) and source are required; add customer_id, line_items and payments. Returns the ID of the created sale.
get_saleGet saleGETReturns a single sale with a given ID.
list_salesList salesGETReturns a paginated list of sales. To find sales by date, status, customer, outlet or invoice number, use search.

Supplier, 3 operations

create_supplierCreate supplierPOSTCreates a new supplier.
delete_supplierDelete supplierDELETEDeletes a supplier. If there are products associated with the supplier, the products will be disassociated from the supplier.
get_supplierGet supplierGETReturns a single supplier with a given ID.

Tag, 3 operations

create_tagCreate tagPOSTCreates a new tag.
delete_tagDelete tagDELETEDeletes a tag. If there are products associated with the tag, the products will be disassociated from the tag.
get_tagGet tagGETReturns a single tag with a given ID.

Variant attribute, 3 operations

create_variant_attributeCreate variant attributePOSTVariant Attributes are required when creating variants. They are used to specify what properties make a particular SKU different to another.
delete_variant_attributeDelete variant attributeDELETENote you can't delete a variant attribute that is currently being used by a family.
get_variant_attributeGet variant attributeGETRetrieves a single Variant Attribute with the given id.

Webhook, 3 operations

create_webhookCreate webhookPOSTCreate a webhook.
delete_webhookDelete webhookDELETEDelete a webhook
get_webhookGet webhookGETFetch a single webhook by its ID.

Inventory level, 2 operations

list_inventory_levelsList inventory levelsPOSTReturns a paginated list of inventory levels, filtered by the request body.
list_product_inventory_levelsList product inventory levelsGETReturns a paginated list of inventory levels for a single product.

Inventory record, 2 operations

list_inventory_recordsList inventory recordsPOSTReturns a paginated list of inventory records (current level per product and outlet), filtered by the request body.
list_product_inventory_recordsList product inventory recordsGETReturns inventory records for a single product at all outlets.

Outlet, 2 operations

get_outletGet outletGETReturns a single outlet with the requested ID.
list_outletsList outletsGETReturns a collection of outlets.

Purchase order, 2 operations

get_purchase_orderGet purchase orderGETReturns a single purchase order with the requested ID. Cost fields require the `products:read:costs` scope.
list_purchase_ordersList purchase ordersGETReturns a paginated list of purchase orders using version-based cursor pagination. The response includes only purchase orders accessible to the authenticated user.

Purchase order line item, 2 operations

list_purchase_order_delivery_line_itemsList purchase order delivery line itemsGETReturns a paginated list of line items belonging to a purchase order delivery using version-based cursor pagination. Cost fields require the `products:read:costs` scope.
list_purchase_order_line_itemsList purchase order line itemsGETReturns a paginated list of line items belonging to a purchase order using version-based cursor pagination. Cost fields require the `products:read:costs` scope.

Quote, 2 operations

get_quoteGet quoteGETReturns a single quote with a given ID.
list_quotesList quotesGETReturns a paginated list of quotes.

Stock adjustment, 2 operations

create_stock_adjustmentsCreate stock adjustmentsPOSTCreates one or more stock adjustments in a single batch (1-1000 items per request).
list_stock_adjustmentsList stock adjustmentsGETReturns a paginated list of stock adjustments for the authenticated retailer.

Tax, 2 operations

create_taxCreate taxPOSTCreates a new tax.
get_taxGet taxGETReturns a single tax with a given ID.

Custom field value, 1 operation

list_custom_field_valuesList custom field valuesGETReturns the custom field values for a given entity.

Discount, 1 operation

apply_discountApply discountPOSTThis will find the best possible promotion to a sale, apply it and return the sale and the discount.

Gift card transaction, 1 operation

create_gift_card_transactionCreate gift card transactionPOSTRedeem from or reload a gift card: type REDEEMING (negative amount) or RELOADING (positive), plus amount and a unique client_id that makes a retry safe. Answers 422 when the card lacks the credit to redeem.

Payment type, 1 operation

list_payment_typesList payment typesGETReturns a paginated collection of payment types.

Product family image, 1 operation

delete_product_family_imageDelete product family imageDELETEDeletes an image from a product family.

Product image, 1 operation

delete_product_imageDelete product imageDELETEDeletes an image from a product.

Product type, 1 operation

get_product_typeGet product typeGETReturns a single product type with a given ID.

Promo code, 1 operation

list_promotion_promo_codesList promotion promo codesGETGet the promo codes associated with this promotion.

Promotion product, 1 operation

list_promotion_productsList promotion productsGETGet a list of products applicable for this promotion, and their discount price.

Purchase order delivery, 1 operation

list_purchase_order_deliveriesList purchase order deliveriesGETReturns a paginated list of deliveries belonging to a purchase order using version-based cursor pagination. Cost fields require the `products:read:costs` scope.

Retailer, 1 operation

get_retailerGet retailerGETThis endpoint returns information about the retailer.

Shift, 1 operation

list_shiftsList shiftsGETReturns a paginated list of shifts.

Store credit transaction, 1 operation

create_store_credit_transactionCreate store credit transactionPOSTIssue, redeem or reverse a customer's store credit: type ISSUE, REDEMPTION (negative amount) or REVERSE, with a unique client_id (a REVERSE reuses the client_id of the transaction it voids). Answers 422 when credit is short.

Showing the first 120 of 157 endpoints. The rest are in the product, searchable from the workflow builder and from chat.

Use Lightspeed Retail X-Series from Claude Code, Cursor or Codex

Connect Lightspeed Retail X-Series in LiveContext, create an API key in Settings, then add the LiveContext MCP server to your client. Its Lightspeed Retail X-Series operations become tools the client can call, next to every other integration you connected.

Claude Code

claude mcp add --transport http livecontext https://livecontext.ai/mcp --header "X-API-Key: YOUR_API_KEY"

Codex (~/.codex/config.toml)

[mcp_servers.livecontext]
url = "https://livecontext.ai/mcp"

[mcp_servers.livecontext.http_headers]
"X-API-Key" = "YOUR_API_KEY"

Cursor, Claude Desktop and other JSON configs

{
  "mcpServers": {
    "livecontext": {
      "type": "http",
      "url": "https://livecontext.ai/mcp",
      "headers": {
        "X-API-Key": "YOUR_API_KEY"
      }
    }
  }
}

Set up the MCP server step by step

How to connect Lightspeed Retail X-Series

Create your workspace
Sign up free. Nothing to install.
Connect Lightspeed Retail X-Series once
Add your Lightspeed Retail X-Series connection in Settings. Every tool from this integration reuses it, and secrets are encrypted at rest and visible only to you.
Describe the job in chat
The workflow builds itself in front of you and picks the endpoints it needs. Drag the steps yourself on the canvas whenever you would rather be explicit.