The Lightspeed Retail connector lets your AI agent act in each user's Lightspeed Retail account. Each user connects their own Lightspeed Retail access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 113 tools.
- Tools
- 113
- What they doRead · write · destructive
- 70 · 35 · 870 read35 write8 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Lightspeed Retail connection
In AgentKit > Connections, create a Lightspeed Retail connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'lightspeedretail'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Lightspeed Retail:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'lightspeedretail_get_current_user',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "lightspeedretail"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Lightspeed Retail:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="lightspeedretail_get_current_user",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Lightspeed Retail credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toollightspeedretail_get_brandReturn a single brand with a requested ID Returns a data object with deleted_at, description, id, name, version.Read-onlyGet Brand
Return a single brand with a requested ID Returns a data object with deleted_at, description, id, name, version. Use list_brands to browse or filter, create_brand to add a new one, update_brand to change an existing one, delete_brand to remove one instead when that fits better.
Inputs
brand_idstringrequired- The brand id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_consignmentReturn a single consignment with the requested ID.Read-onlyGet Consignment
Return a single consignment with the requested ID. Returns a data object with consignment_date, created_at, deleted_at, due_at, id, name, outlet_id, received_at. Use list_consignments to browse or filter, create_consignment to add a new one, update_consignment to change an existing one, delete_consignment to remove one instead when that fits better.
Inputs
consignment_idstringrequired- The consignment id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_consignment_totalsReturn the count and cost for the given consignment.Read-onlyGet Consignment Totals
Return the count and cost for the given consignment. Returns a data array of records with total_received_cost, total_received_count, total_sent_cost, total_sent_count. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
consignment_idstringrequired- The consignment id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_current_userReturn the current user.Read-onlyGet Current User
Return the current user. Returns a data object with account_type, created_at, deleted_at, display_name, email, email_verified_at, enabled, enabled_mfa. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
This tool takes no inputs.
lightspeedretail_get_custom_field_valuesReturn the custom field values for a given entity.Read-onlyGet Custom Field Values
Return the custom field values for a given entity. Returns a data array of records with boolean_value, definition_id, integer_value, name, string_value, title, type. Use set_custom_field_values to set values instead when that fits better.
Inputs
entitystringrequired- The entity type. Allowed values: sale, line_item, customer, product. Example: sale.one of
saleline_itemcustomerproduct entity_idstringrequired- The entity ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_customerReturn a single customer with a requested ID.Read-onlyGet Customer
Return a single customer with a requested ID. Returns a data object with balance, company_name, created_at, custom_field_1, custom_field_2, custom_field_3, custom_field_4, customer_code. Use list_customers to browse or filter, create_customer to add a new one, update_customer to change an existing one, delete_customer to remove one instead when that fits better.
Inputs
customer_idstringrequired- The customer id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_customer_addressReturn a single address by its ID for the specified customer.Read-onlyGet Customer Address
Return a single address by its ID for the specified customer. Returns a data object with address_line_1, address_line_2, city, country_code, country_name, created_at, customer_id, id. Use list_customer_addresses to browse or filter, create_customer_address to add a new one, update_customer_address to change an existing one, delete_customer_address to remove one instead when that fits better.
Inputs
address_idintegerrequired- The unique identifier of the address. Example: 1.
customer_idstringrequired- The unique identifier of the customer. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_customer_groupReturn given customer group Returns a data object with created_at, deleted_at, group_id, id, name, retailer_id, updated_at, version.Read-onlyGet Customer Group
Return given customer group Returns a data object with created_at, deleted_at, group_id, id, name, retailer_id, updated_at, version. Use list_customer_groups to browse or filter, create_customer_group to add a new one, update_customer_group to change an existing one instead when that fits better.
Inputs
customer_group_idstringrequired- The customer group id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_customer_store_credit_balanceReturn a balance for the given customer id.Read-onlyGet Customer Store Credit Balance
Return a balance for the given customer id. Returns an object with balance, customer_id, total_credit_issued, total_credit_redeemed. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
customer_idstringrequired- Customer id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_gift_cardFind and returns the gift card with the given id.Read-onlyGet Gift Card
Find and returns the gift card with the given id. Returns a data object with balance, created_at, expires_at, gift_card_transactions, id, number, sale_id, sale_source. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
idstringrequired- The id of the gift card to find. Example: Example id.
lightspeedretail_get_gift_card_by_numberFind and returns the gift card with the given card number.Read-onlyGet Gift Card By Number
Find and returns the gift card with the given card number. Returns a data object with balance, created_at, expires_at, gift_card_transactions, id, number, sale_id, sale_source. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
card_numberstringrequired- The number of the gift card to find. Example: Example card number.
lightspeedretail_get_outletReturn a single outlet with the requested ID.Read-onlyGet Outlet
Return a single outlet with the requested ID. Returns a data object with attributes, currency, currency_symbol, default_tax_id, deleted_at, display_prices, email, id. Use list_outlets to browse or filter instead when that fits better.
Inputs
outlet_idstringrequired- The outlet id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_price_bookReturn a single price book with a requested ID Returns a data object with created_at, customer_group_ids, customer_groups, deleted_at, id, name, outlets, restrict_to_platform_key.Read-onlyGet Price Book
Return a single price book with a requested ID Returns a data object with created_at, customer_group_ids, customer_groups, deleted_at, id, name, outlets, restrict_to_platform_key. Use list_price_books to browse or filter, create_price_book to add a new one, update_price_book to change an existing one instead when that fits better.
Inputs
idstringrequired- The price book id. Example: Example id.
lightspeedretail_get_productReturn a single product object with a given ID.Read-onlyGet Product
Return a single product object with a given ID. Returns a data object with account_code, account_code_purchase, active, attributes, brand, brand_id, button_order, categories. Use list_products to browse or filter, create_product to add a new one, update_product to change an existing one, delete_product to remove one instead when that fits better.
Inputs
product_idstringrequired- The product id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_promotionThis will retrieve a single promotion using the given ID.Read-onlyGet Promotion
This will retrieve a single promotion using the given ID. Returns a data object with action, add_promo_code, channels, combinable_with_coupon, condition, customer_group_ids, description, end_time. Use list_promotions to browse or filter instead when that fits better.
Inputs
promotion_idintegerrequired- The promotion id. Example: 1.
lightspeedretail_get_purchase_orderReturn a single purchase order with the requested ID.Read-onlyGet Purchase Order
Return a single purchase order with the requested ID. Returns a data object with allocation_outlet_ids, cost_price_total, costs, created_at, delivery_outlet_id, discounts, due_at, id. Use list_purchase_orders to browse or filter instead when that fits better.
Inputs
purchase_order_idstringrequired- The unique identifier of the purchase order. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_quoteReturn a single quote with a given ID.Read-onlyGet Quote
Return a single quote with a given ID. Returns an object with created_at, customer_id, deleted_at, expired_at, grand_total, id, loyalty, note. Use list_quotes to browse or filter instead when that fits better.
Inputs
This tool takes no inputs.
lightspeedretail_get_registerReturn a single register with the requested ID.Read-onlyGet Register
Return a single register with the requested ID. Returns a data object with ask_for_note_on_save, ask_for_user_on_sale, button_layout_id, cash_managed_payment_type_id, deleted_at, email_receipt, id, invoice_prefix. Use list_registers to browse or filter instead when that fits better.
Inputs
register_idstringrequired- The register id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_register_payments_summaryReturn a payload containing payment totals for all payments types defined in the account for a single register.Read-onlyGet Register Payments Summary
Return a payload containing payment totals for all payments types defined in the account for a single register. Returns a data object with payments. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
register_idstringrequired- The register id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_retailerThis endpoint returns information about the retailer.Read-onlyGet Retailer
This endpoint returns information about the retailer. Returns a data object with account_status, account_type, activated_at, country, created_at, culture, currency, discount_product_id. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
This tool takes no inputs.
lightspeedretail_get_saleReturn a single sale with a given ID.Read-onlyGet Sale
Return a single sale with a given ID. Returns a data object with _metadata, adjustments, attributes, created_at, customer_id, date, deleted_at, ecom_custom_charges. Use list_sales to browse or filter, create_sale to add a new one, update_sale to change an existing one instead when that fits better.
Inputs
sale_idstringrequired- A valid sale ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_serial_numberReturn a single serial number.Read-onlyGet Serial Number
Return a single serial number. Returns a data object with code, id, line_item_id, outlet_id, product_id, sale_id, version. Use list_serial_numbers to browse or filter, create_serial_number to add a new one instead when that fits better.
Inputs
serialnumber_idstringrequired- The serial number id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_supplierReturn a single supplier with a given ID.Read-onlyGet Supplier
Return a single supplier with a given ID. Returns a data object with deleted_at, id, source, version, contact, default_markup, description, name. Use list_suppliers to browse or filter, create_supplier to add a new one, update_supplier to change an existing one, delete_supplier to remove one instead when that fits better.
Inputs
supplier_idstringrequired- The supplier id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_tagReturn a single tag with a given ID.Read-onlyGet Tag
Return a single tag with a given ID. Returns a data object with deleted_at, id, name, version. Use list_tags to browse or filter, create_tag to add a new one, update_tag to change an existing one, delete_tag to remove one instead when that fits better.
Inputs
tag_idstringrequired- The tag id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_taxReturn a single tax with a given ID.Read-onlyGet Tax
Return a single tax with a given ID. Returns a data object with deleted_at, display_name, id, is_default, name, rates, version. Use list_taxes to browse or filter, create_tax to add a new one instead when that fits better.
Inputs
tax_idstringrequired- The tax id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_userReturn a single user with the requested ID.Read-onlyGet User
Return a single user with the requested ID. Returns a data object with account_type, created_at, deleted_at, display_name, email, email_verified_at, enabled, enabled_mfa. Use list_users to browse or filter instead when that fits better.
Inputs
user_idstringrequired- A valid user id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_user_sale_totalsReturn a single user's sales totals.Read-onlyGet User Sale Totals
Return a single user's sales totals. Returns a data array of records with cost, date_from, date_to, discounts, label, loyalty, revenue, sale_count. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
user_idstringrequired- A valid user id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_get_variant_attributeRetrieve a single Variant Attribute with the given id.Read-onlyGet Variant Attribute
Retrieve a single Variant Attribute with the given id. Returns an object with deleted_at, id, name. Use list_variant_attributes to browse or filter, create_variant_attribute to add a new one, update_variant_attribute to change an existing one instead when that fits better.
Inputs
attribute_idstringrequired- The object identifier of the Variant Attribute to retrieve. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
lightspeedretail_list_all_price_book_productsReturn a paginated list of price book products.Read-onlyList All Price Book Products
Return a paginated list of price book products. Returns a data array of records with adjustment, adjustment_type, created_at, default_display_price, deleted_at, discount, id, loyalty_value. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_brandsReturn a paginated list of brands.Read-onlyList Brands
Return a paginated list of brands. Returns a data array of records with deleted_at, description, id, name, version and a version range for cursor pagination. Use get_brand to fetch one by ID, create_brand to add a new one, update_brand to change an existing one, delete_brand to remove one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_consignment_productsReturn a collection of consignment products associated with the specified consignment.Read-onlyList Consignment Products
Return a collection of consignment products associated with the specified consignment. Returns a data array of records with cost, count, created_at, deleted_at, is_included, product_id, product_sku, received. Use add_consignment_product to add items, update_consignment_product to change an existing one, delete_consignment_product to remove one instead when that fits better.
Inputs
consignment_idstringrequired- The consignment id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_consignmentsReturn a paginated list of consignments.Read-onlyList Consignments
Return a paginated list of consignments. Returns a data array of records with consignment_date, created_at, deleted_at, due_at, id, name, outlet_id, received_at and a version range for cursor pagination. Use get_consignment to fetch one by ID, create_consignment to add a new one, update_consignment to change an existing one, delete_consignment to remove one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
outlet_idstring- Filter response by the ID of the outlet associated with the consignments. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
statusstring- The consignment status to search for. Allowed values: OPEN, SENT, DISPATCHED, RECEIVED, STOCKTAKE_IN_PROGRESS, STOCKTAKE_SCHEDULED, STOCKTAKE_IN_PROGRESS_PROCESSED, STOCKTAKE_COMPLETE, CLOSED, CANCELLED. Example: OPEN.one of
OPENSENTDISPATCHEDRECEIVEDSTOCKTAKE_IN_PROGRESSSTOCKTAKE_SCHEDULEDSTOCKTAKE_IN_PROGRESS_PROCESSEDSTOCKTAKE_COMPLETECLOSEDCANCELLED typestring- The consignment type to search for. Allowed values: SUPPLIER, OUTLET, STOCKTAKE, RETURN. Example: SUPPLIER.one of
SUPPLIEROUTLETSTOCKTAKERETURN
lightspeedretail_list_custom_fieldsReturn the custom field definitions for a given entity type.Read-onlyList Custom Fields
Return the custom field definitions for a given entity type. Returns a data array of records with created_at, editable_in_ui, entity, id, name, title, type, visible_in_ui. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
entitystringrequired- The entity type. Allowed values: sale, line_item, customer, product. Example: sale.one of
saleline_itemcustomerproduct
lightspeedretail_list_customer_addressesReturn a list of all addresses associated with the specified customer.Read-onlyList Customer Addresses
Return a list of all addresses associated with the specified customer. Returns a data array of records with address_line_1, address_line_2, city, country_code, country_name, created_at, customer_id, id. Use get_customer_address to fetch one by ID, create_customer_address to add a new one, update_customer_address to change an existing one, delete_customer_address to remove one instead when that fits better.
Inputs
customer_idstringrequired- The unique identifier of the customer. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_list_customer_contact_channelsReturn all contact channels of the specified customer, ordered by sort_order and then by id.Read-onlyList Customer Contact Channels
Return all contact channels of the specified customer, ordered by sort_order and then by id. Returns a data array of records with id, is_default, note, sort_order, type, value. Use create_customer_contact_channel to add a new one instead when that fits better.
Inputs
customer_idstringrequired- The unique identifier of the customer. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_list_customer_group_customersReturn a list of customers for the given Customer Group Returns a data array of records with balance, company_name, created_at, custom_field_1, custom_field_2, custom_field_3, custom_field_4, customer_code and a version range for cursor pagination.Read-onlyList Customer Group Customers
Return a list of customers for the given Customer Group Returns a data array of records with balance, company_name, created_at, custom_field_1, custom_field_2, custom_field_3, custom_field_4, customer_code and a version range for cursor pagination. Use add_customers_to_customer_group to add items instead when that fits better.
Inputs
customer_group_idstringrequired- The customer group id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_customer_groupsReturn a list of Customer Groups Returns a data array of records with created_at, deleted_at, group_id, id, name, retailer_id, updated_at, version and a version range for cursor pagination.Read-onlyList Customer Groups
Return a list of Customer Groups Returns a data array of records with created_at, deleted_at, group_id, id, name, retailer_id, updated_at, version and a version range for cursor pagination. Use get_customer_group to fetch one by ID, create_customer_group to add a new one, update_customer_group to change an existing one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_customer_store_creditsReturn a balance and a history of store credit operations for the given customer id.Read-onlyList Customer Store Credits
Return a balance and a history of store credit operations for the given customer id. Returns an object with balance, created_at, customer_id, id, store_credit_transactions, total_credit_issued, total_credit_redeemed. Use list_store_credits to browse or filter instead when that fits better.
Inputs
customer_idstringrequired- Customer id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_list_customersReturn a paginated list of customers.Read-onlyList Customers
Return a paginated list of customers. Returns a data array of records with balance, company_name, created_at, custom_field_1, custom_field_2, custom_field_3, custom_field_4, customer_code and a version range for cursor pagination. Use get_customer to fetch one by ID, create_customer to add a new one, update_customer to change an existing one, delete_customer to remove one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_gift_cardsReturn a paginated list of gift cards.Read-onlyList Gift Cards
Return a paginated list of gift cards. Returns a data array of records with balance, created_at, expires_at, gift_card_transactions, id, number, sale_id, sale_source. Use create_gift_card to add a new one instead when that fits better.
Inputs
beforestring- Pagination cursor for reverse-chronological traversal. Pass the ID of a gift card to retrieve the next page of gift cards created before it, ordered from newest to oldest. Example: Example before.
card_numberstring- Find by gift card number. Example: Example card number.
page_sizeinteger- The maximum number of items to be returned in the response. Defaults to 1000. Maximum value is 1000. Example: 100.
statusstring- Filter by gift card status. Allowed values: ACTIVE, INACTIVE, REDEEMED, VOIDED, EXPIRED. Example: ACTIVE.one of
ACTIVEINACTIVEREDEEMEDVOIDEDEXPIRED
lightspeedretail_list_outletsReturn a collection of outlets.Read-onlyList Outlets
Return a collection of outlets. Returns a data array of records with attributes, currency, currency_symbol, default_tax_id, deleted_at, display_prices, email, id and a version range for cursor pagination. Use get_outlet to fetch one by ID instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_payment_typesReturn a paginated collection of payment types.Read-onlyList Payment Types
Return a paginated collection of payment types. Returns a data array of records with config, created_at, deleted_at, disabled, gateway, id, internal, is_editable and a version range for cursor pagination. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
currencystring- Filters payment types by currency code (ISO 4217, e.g. "AUD", "USD"). Example: Example currency.
deletedboolean- If true, includes deleted payment types in the response. Example: true.
only_lspayboolean- If true, returns only LSPay payment types. Example: true.
outlet_idstring- Filters payment types by outlet. Only effective when the payment_type_controls feature is enabled. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_price_book_productsReturn a list of price book products for a given price book.Read-onlyList Price Book Products
Return a list of price book products for a given price book. Returns a data array of records with adjustment, adjustment_type, created_at, default_display_price, deleted_at, discount, id, loyalty_value. Use add_products_to_price_book to add items instead when that fits better.
Inputs
price_book_idstringrequired- The price book id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
product_idsstring- The product ids. Example: 06326976-9d65-11ed-fa40-1347e4b4ae6d,16326976-9d65-11ed-fa40-1347e4b4ae6d.
lightspeedretail_list_price_booksReturn a paginated list of price books.Read-onlyList Price Books
Return a paginated list of price books. Returns a data array of records with created_at, customer_group_ids, customer_groups, deleted_at, id, name, outlets, restrict_to_platform_key. Use get_price_book to fetch one by ID, create_price_book to add a new one, update_price_book to change an existing one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
customer_group_idstring- Filter the list and show only price books linked to the specified Customer Group. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
deletedboolean- Include (true) or exclude (false) deleted price books. Default value is false. Example: true.
directionstring- Sort results direction. ASC or DESC. Example: Example direction.
orderstring- Field used to sort the results. Example: Example order.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_product_categoriesList product categories.Read-onlyList Product Categories
List product categories. Returns a data object with categories. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
afterstring- The category id to get the next set of paginated results. Example: Example after.
includestring- Defaults to "family" * family - Include all categories in the hierarchy. * children - Include only direct children. Allowed values: family, children. Example: family.one of
familychildren page_sizeinteger- The total number of categories to return. Default is 1000. Example: 100.
parentstring- If parent is an id, it filters the list of categories that belongs to the given category. If parent is "none", it filters categories for root categories only. Example: Example parent.
lightspeedretail_list_product_inventory_levelsReturn a paginated list of inventory levels for a single product.Read-onlyList Product Inventory Levels
Return a paginated list of inventory levels for a single product. Returns an array of objects with average_cost, brand_id, current_inventory_level, location_id, name, product_id, product_type_id, quantity_to_procure. Use search_inventory_levels to search instead when that fits better.
Inputs
product_idstringrequired- The product to fetch inventory levels for. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
include_inactiveboolean- Whether to include inactive products in the response. Example: true.
lightspeedretail_list_product_inventory_recordsReturn inventory records for a single product at all outlets.Read-onlyList Product Inventory Records
Return inventory records for a single product at all outlets. Returns an array of objects with average_cost, current_inventory_level, deleted_at, id, outlet_id, product_id, quantity_to_procure, reorder_amount. Use search_inventory_records to search instead when that fits better.
Inputs
product_idstringrequired- The product to fetch inventory levels for. When combined with variants: true, it's treated as a root product ID and matches all variants of that product; otherwise it matches the exact product. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
include_deletedboolean- Whether to include inventory records for deleted products. Example: true.
order_directionstring- Whether to order the results ascending or descending by version. Allowed values: asc, desc. Example: asc.one of
ascdesc page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
variantsboolean- When true (and product_id is set), matches all variant products sharing the same root_product_id, rather than just the exact product. Example: true.
lightspeedretail_list_product_price_booksThis endpoint returns the list of price books the given product is in.Read-onlyList Product Price Books
This endpoint returns the list of price books the given product is in. Returns a data array of records with adjustment, adjustment_type, created_at, default_display_price, deleted_at, discount, id, loyalty_value. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
product_idstringrequired- The product id to find in the Price Books. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_list_productsReturn a paginated list of products.Read-onlyList Products
Return a paginated list of products. Returns a data array of records with account_code, account_code_purchase, active, attributes, brand, brand_id, button_order, categories and a version range for cursor pagination. Use get_product to fetch one by ID, create_product to add a new one, update_product to change an existing one, delete_product to remove one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
family_namestring- Alias for 'name'. Allows loading products that belong to the family with the name provided in this parameter. Note that all other query parameters are ignored if this is provided. Example: Example family name.
include_imagesboolean- Whether to include product image fields in the response. Defaults to true. Example: true.
namestring- Allows loading products with the name provided in this parameter. This query typically retrieves all products from the product family with the provided name. Note that all other query parameters are ignored if this is provided. Example: Example name.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
skustring- Allows loading a product by one of its SKUs. Note that all other query params are ignored if this is provided. Example: SKU-1001.
lightspeedretail_list_promotion_productsGet a list of products applicable for this promotion, and their discount price.Read-onlyList Promotion Products
Get a list of products applicable for this promotion, and their discount price. Returns a data object with action_products, condition_products. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
promotion_idintegerrequired- The promotion id. Example: 1.
namestring- Filter products by product name. Example: Example name.
offsetinteger- The offset. Example: 0.
page_sizeinteger- The page size. Example: 100.
lightspeedretail_list_promotion_promo_codesGet the promo codes associated with this promotion.Read-onlyList Promotion Promo Codes
Get the promo codes associated with this promotion. Returns a data array of records with code, created_at, created_user_id, group_name, id, limit, promotion_id, redeemed. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
promotion_idstringrequired- The promotion id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_list_promotionsThis endpoint lists all promotions for a retailer.Read-onlyList Promotions
This endpoint lists all promotions for a retailer. Returns a data array of records with action, add_promo_code, channels, combinable_with_coupon, condition, customer_group_ids, description, end_time. Use get_promotion to fetch one by ID instead when that fits better.
Inputs
end_time_fromstring- Lower limit for the promotion end date as UTC timestamp. Format: 2020-08-08T12:00:00Z. Example: Example end time from.
end_time_tostring- Upper limit for the promotion end date as UTC timestamp. Format: 2020-08-08T12:00:00Z. Example: Example end time to.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_purchase_order_deliveriesReturn a paginated list of deliveries belonging to a purchase order using version-based cursor pagination.Read-onlyList Purchase Order Deliveries
Return a paginated list of deliveries belonging to a purchase order using version-based cursor pagination. Returns a data array of records with cost_price_total, costs, created_at, discounts, due_at, id, invoice_date, notes and a version range for cursor pagination. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
purchase_order_idstringrequired- The unique identifier of the purchase order. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to return. Defaults to 100 and cannot exceed 1000. Example: 100.
lightspeedretail_list_purchase_order_line_itemsReturn a paginated list of line items belonging to a purchase order using version-based cursor pagination.Read-onlyList Purchase Order Line Items
Return a paginated list of line items belonging to a purchase order using version-based cursor pagination. Returns a data array of records with allocations, components, cost_price, created_at, id, product_id, purchase_order_id, quantity and a version range for cursor pagination. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
purchase_order_idstringrequired- The unique identifier of the purchase order. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to return. Defaults to 100 and cannot exceed 1000. Example: 100.
lightspeedretail_list_purchase_ordersReturn a paginated list of purchase orders using version-based cursor pagination.Read-onlyList Purchase Orders
Return a paginated list of purchase orders using version-based cursor pagination. Returns a data array of records with allocation_outlet_ids, cost_price_total, costs, created_at, delivery_outlet_id, discounts, due_at, id and a version range for cursor pagination. Use get_purchase_order to fetch one by ID instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to return. Defaults to 100 and cannot exceed 1000. Example: 100.
lightspeedretail_list_quotesReturn a paginated list of quotes.Read-onlyList Quotes
Return a paginated list of quotes. Returns an object with HasNext, Quotes, TotalCount. Use get_quote to fetch one by ID instead when that fits better.
Inputs
afterinteger- The lower limit for the quote id to be included in the response. For proper pagination, it needs to be the quote id of the last item in the response from your previous request. Example: 0.
limitinteger- The maximum number of items to be returned in the response. Example: 1.
lightspeedretail_list_registersReturn a paginated list of registers.Read-onlyList Registers
Return a paginated list of registers. Returns a data array of records with ask_for_note_on_save, ask_for_user_on_sale, button_layout_id, cash_managed_payment_type_id, deleted_at, email_receipt, id, invoice_prefix and a version range for cursor pagination. Use get_register to fetch one by ID instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_salesReturn a paginated list of sales.Read-onlyList Sales
Return a paginated list of sales. Returns a data array of records with _metadata, adjustments, attributes, created_at, customer_id, date, deleted_at, ecom_custom_charges and a version range for cursor pagination. Use get_sale to fetch one by ID, create_sale to add a new one, update_sale to change an existing one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_serial_numbersReturn a paginated list of serial numbers.Read-onlyList Serial Numbers
Return a paginated list of serial numbers. Returns a data array of records with code, id, line_item_id, outlet_id, product_id, sale_id, version and a version range for cursor pagination. Use get_serial_number to fetch one by ID, create_serial_number to add a new one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
line_item_idstring- A line item ID. This filters the serial numbers to only include ones sold in the specified line item. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
outlet_idstring- An outlet ID. This filters the serial numbers to only include ones on this outlet. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
product_idstring- A product ID. This filters the serial numbers to only include ones on this product. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
sale_idstring- A sale ID. This filters the serial numbers to only include ones that were sold in the specified sale. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_list_shiftsReturn a paginated list of shifts.Read-onlyList Shifts
Return a paginated list of shifts. Returns a data array of records with created_at, id, retailer_id, time_in, time_out, updated_at, updated_by, user_id and a version range for cursor pagination. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_stock_adjustmentsReturn a paginated list of stock adjustments for the authenticated retailer.Read-onlyList Stock Adjustments
Return a paginated list of stock adjustments for the authenticated retailer. Returns a data array of records with created_at, custom_inventory_adjustment_reason_id, id, outlet_id, product_id, quantity, reason, updated_at and a version range for cursor pagination. Use create_stock_adjustments to add a new one instead when that fits better.
Inputs
afterinteger- Return records with a version greater than this value. Example: 0.
beforeinteger- Return records with a version less than this value. Example: 0.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_store_creditsReturn all the store credit customers in a store with their store credit balance and a list of last store credit transactions for each customer Returns a data array of records with balance, created_at, customer_id, id, store_credit_transactions, total_credit_issued, total_credit_redeemed.Read-onlyList Store Credits
Return all the store credit customers in a store with their store credit balance and a list of last store credit transactions for each customer Returns a data array of records with balance, created_at, customer_id, id, store_credit_transactions, total_credit_issued, total_credit_redeemed. Use list_customer_store_credits to browse or filter instead when that fits better.
Inputs
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_suppliersReturn a paginated list of suppliers.Read-onlyList Suppliers
Return a paginated list of suppliers. Returns a data array of records with deleted_at, id, source, version, contact, default_markup, description, name and a version range for cursor pagination. Use get_supplier to fetch one by ID, create_supplier to add a new one, update_supplier to change an existing one, delete_supplier to remove one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_taxesReturn a paginated list of taxes.Read-onlyList Taxes
Return a paginated list of taxes. Returns a data array of records with deleted_at, display_name, id, is_default, name, rates, version. Use get_tax to fetch one by ID, create_tax to add a new one instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_usersReturn a paginated list of users.Read-onlyList Users
Return a paginated list of users. Returns a data array of records with account_type, created_at, deleted_at, display_name, email, email_verified_at, enabled, enabled_mfa and a version range for cursor pagination. Use get_user to fetch one by ID instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
page_sizeinteger- The maximum number of items to be returned in the response. Example: 100.
lightspeedretail_list_variant_attributesRetrieve all Variant Attributes.Read-onlyList Variant Attributes
Retrieve all Variant Attributes. Returns a data array of records with deleted_at, id, name. Use get_variant_attribute to fetch one by ID, create_variant_attribute to add a new one, update_variant_attribute to change an existing one instead when that fits better.
Inputs
deletedboolean- Indicates whether deleted items should be included in the response. Example: true.
lightspeedretail_search_inventory_levelsReturn a paginated list of inventory levels.Read-onlySearch Inventory Levels
Return a paginated list of inventory levels. Returns an array of objects with average_cost, brand_id, current_inventory_level, location_id, name, product_id, product_type_id, quantity_to_procure. Use list_product_inventory_levels to browse or filter instead when that fits better.
Inputs
group_variantsboolean- If filtering by root_product_ids and group_variants is true, one aggregated level will be returned for each variant family at each outlet. Example: true.
include_compositesboolean- Include composite products in the response. Example: true.
include_inactiveboolean- Include inactive products in the response. Example: true.
location_idsarray- Optional outlet IDs to filter response by. Example: ["0af7b240-ab83-11e7-eddc-4023c64c85e5"].
offsetinteger- How many inventory levels to skip. Example: 0.
product_idsarray- Optional product IDs to filter response by. Mutually exclusive with root_product_ids. When omitted, returns inventory levels for all products. Example: ["0af7b240-ab83-11e7-eddc-4023c64c85e5"].
root_product_idsarray- Optional root product IDs to filter response by. Mutually exclusive with product_ids. When omitted, returns inventory levels for all products. Example: ["0af7b240-ab83-11e7-eddc-4023c64c85e5"].
sizeinteger- How many inventory levels to return. Example: 100.
sort_directionstring- Whether to sort the response ascending or descending. Allowed values: asc, desc. Example: asc.one of
ascdesc sort_typestring- Which response field to sort by. Allowed values: total_count, total_cost, average_cost, reorder_point, reorder_amount, product_name, created_at. Example: total_count.one of
total_counttotal_costaverage_costreorder_pointreorder_amountproduct_namecreated_at supplier_idsarray- Optional supplier IDs to filter response by. Example: ["0af7b240-ab83-11e7-eddc-4023c64c85e5"].
to_be_procured_onlyboolean- Only include inventory with a positive quantity to procure. Example: true.
lightspeedretail_search_inventory_recordsReturn a paginated list of inventory records.Read-onlySearch Inventory Records
Return a paginated list of inventory records. Returns an array of objects with average_cost, current_inventory_level, deleted_at, id, outlet_id, product_id, quantity_to_procure, reorder_amount. Use list_product_inventory_records to browse or filter instead when that fits better.
Inputs
afterinteger- The lower limit for the version numbers to be included in the response. Example: 0.
beforeinteger- The upper limit for the version numbers to be included in the response. Example: 0.
include_deletedboolean- Whether to include inventory records for deleted products. Example: true.
product_idstring- Optional filter to restrict results to the specified product. When combined with variants: true, it's treated as a root product ID and matches all variants of that product; otherwise it matches the exact product. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
sizeinteger- The maximum number of inventory records to return. Example: 100.
sort_directionstring- Whether to sort the response by ascending or descending. Allowed values: asc, desc. Example: asc.one of
ascdesc variantsboolean- When true (and product_id is set), matches all variant products sharing the same root_product_id, rather than just the exact product. Example: true.
lightspeedretail_search_promotionsThis endpoint can be used to find promotions matching specific criteria.Read-onlySearch Promotions
This endpoint can be used to find promotions matching specific criteria. Returns a data array of records with action, add_promo_code, channels, combinable_with_coupon, condition, customer_group_ids, description, end_time. Use this when you need exactly this record set; there is no sibling list tool.
Inputs
directionstring- Sort direction. Allowed values: asc, desc. Example: asc.one of
ascdesc end_timestring- Only show promotions that have an end time before or equal to this. Example: 2023-08-29T9:57:52.
namestring- Part of promotion's name being searched. Example: choco.
offsetinteger- Offset. Example: 0.
order_bystring- Sort the result by this field. Allowed values: name, start_date, end_date. Example: name.one of
namestart_dateend_date page_sizeinteger- Number of results per page. Example: 100.
scopestring- Scope of the search. Allowed values: current_upcoming, past, all. Example: current_upcoming.one of
current_upcomingpastall start_timestring- Only show promotions that have a start time after or equal to this. Example: 2022-08-29T9:57:52.
lightspeedretail_add_consignment_productAdd a product to the given consignment.WriteAdd Consignment Product
Add a product to the given consignment. Returns a data object with cost, count, created_at, deleted_at, is_included, product_id, product_sku, received. Use list_consignment_products to browse or filter, update_consignment_product to change an existing one, delete_consignment_product to remove one instead when that fits better.
Inputs
consignment_idstringrequired- The consignment id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
dataobjectrequired- The data. Fields include cost, count, created_at, deleted_at, is_included, product_id, product_sku, received, status, updated_at. Example: {"cost": "Example cost", "count": "Example count", "created_at": "2026-10-01T00:00:00Z", "deleted_at": "2026-10-01T00:00:00Z", "is_included": true, "product_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}.
lightspeedretail_add_customers_to_customer_groupAssociate one or more customers with the given customer group Returns the upstream confirmation of the change.WriteAdd Customers To Customer Group
Associate one or more customers with the given customer group Returns the upstream confirmation of the change. Use list_customer_group_customers to browse or filter instead when that fits better.
Inputs
customer_group_idstringrequired- The customer group id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
customer_idsarrayrequired- The customer ids. Example: ["Example customer ids"].
lightspeedretail_add_products_to_price_bookCreate price book products.WriteAdd Products To Price Book
Create price book products. Returns a data object with message. Use list_price_book_products to browse or filter instead when that fits better.
Inputs
dataarrayrequired- An array of Price Book objects wrapped in a top level data object. Fields include adjustment, adjustment_type, created_at, default_display_price, deleted_at, discount, id, loyalty_value, max_units, min_units. Example: [{"adjustment": 9.99, "adjustment_type": "Example adjustment type", "created_at": "2026-10-01T00:00:00Z", "default_display_price": 9.99, "deleted_at": "2026-10-01T00:00:00Z", "discount": 9.99}].
price_book_idstringrequired- The price book id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_create_brandCreate a new brand.WriteCreate Brand
Create a new brand. Returns an object whose data field is the id of brand created. Use list_brands to browse or filter, get_brand to fetch one by ID, update_brand to change an existing one, delete_brand to remove one instead when that fits better.
Inputs
namestringrequired- The Brand name. Example: Example name.
descriptionstring- The brand description. Example: Example description.
lightspeedretail_create_consignmentCreate a new consignment.WriteCreate Consignment
Create a new consignment. Returns a data object with consignment_date, created_at, deleted_at, due_at, id, name, outlet_id, received_at. Use list_consignments to browse or filter, get_consignment to fetch one by ID, update_consignment to change an existing one, delete_consignment to remove one instead when that fits better.
Inputs
dataobjectrequired- The data. Fields include consignment_date, created_at, deleted_at, due_at, id, name, outlet_id, received_at, reference, source_outlet_id. Example: {"consignment_date": "2026-10-01T00:00:00Z", "created_at": "2026-10-01T00:00:00Z", "deleted_at": "2026-10-01T00:00:00Z", "due_at": "2026-10-01T00:00:00Z", "id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "name": "Example name"}.
lightspeedretail_create_customerCreate a new customer.WriteCreate Customer
Create a new customer. Returns a data object with balance, company_name, created_at, custom_field_1, custom_field_2, custom_field_3, custom_field_4, customer_code. Use list_customers to browse or filter, get_customer to fetch one by ID, update_customer to change an existing one, delete_customer to remove one instead when that fits better.
Inputs
first_namestringrequired- Customer's first name. Example: Example first name.
last_namestringrequired- Customer 's last name. Example: Example last name.
company_namestring- Company name. Example: Example company name.
custom_field_1string- Custom field 1. Can be used to store random data. Example: Example custom field 1.
custom_field_2string- Custom field 2. Example: Example custom field 2.
custom_field_3string- Custom field 3. Example: Example custom field 3.
custom_field_4string- Custom field 4. Example: Example custom field 4.
customer_codestring- Customer code used for claiming loyalty. Example: Example customer code.
customer_group_idstring- Customer group ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
date_of_birthstring- Birthday. Example: 2026-10-01T00:00:00Z.
do_not_emailboolean- Indicates whether the customer opted out of email communications. Example: true.
emailstring- Customer's email address. Example: tony@example.com.
enable_loyaltyboolean- The enable loyalty. Example: true.
enable_promotional_smsboolean- Indicates whether the customer opted in to SMS communications. Example: true.
faxstring- Fax no. Example: Example fax.
genderstring- Customer's gender. Can be M, F or null. Example: Example gender.
mobilestring- Mobile phone no. Example: Example mobile.
notestring- Customer note. Example: Example note.
on_account_limitnumber- Customer's OnAccount Limit. Example: 9.99.
phonestring- Phone no. Example: Example phone.
physical_address_1string- Physical address, line 1. Example: Example physical address 1.
physical_address_2string- Physical address, line 2. Example: Example physical address 2.
physical_citystring- Physical address, city. Example: Example physical city.
physical_country_idstring- Physical address, country code. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
physical_postcodestring- Physical address, post code. Example: Example physical postcode.
physical_statestring- Physical address, state. Example: Example physical state.
physical_suburbstring- Physical address, suburb. Example: Example physical suburb.
postal_address_1string- Postal address, line 1. Example: Example postal address 1.
postal_address_2string- Postal address, line 2. Example: Example postal address 2.
postal_citystring- Postal address, city. Example: Example postal city.
postal_country_idstring- Postal address, country code. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
postal_postcodestring- Postal address, post code. Example: Example postal postcode.
postal_statestring- Postal address, state. Example: Example postal state.
postal_suburbstring- Postal address, suburb. Example: Example postal suburb.
tax_idstring- Customer's tax ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
twitterstring- Twitter handle. Example: Example twitter.
websitestring- Website URL. Example: Example website.
lightspeedretail_create_customer_addressCreate a new address for the specified customer.WriteCreate Customer Address
Create a new address for the specified customer. Returns a data object with address_line_1, address_line_2, city, country_code, country_name, created_at, customer_id, id. Use list_customer_addresses to browse or filter, get_customer_address to fetch one by ID, update_customer_address to change an existing one, delete_customer_address to remove one instead when that fits better.
Inputs
address_line_1stringrequired- Primary address line (street address, P.O. box, etc.). Example: Example address line 1.
citystringrequired- City or town name. Example: Example city.
country_codestringrequired- ISO 3166-1 alpha-2 country code (e.g., US, NZ, AU). Example: Example country code.
customer_idstringrequired- The unique identifier of the customer. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
postcodestringrequired- Postal code or ZIP code. Example: Example postcode.
typestringrequired- The type of address. Allowed values: BILLING, SHIPPING. Example: BILLING.one of
BILLINGSHIPPING address_line_2string- Secondary address line (apartment, suite, unit, building, floor, etc.). Example: Example address line 2.
statestring- State, province, or region name. Example: Example state.
state_codestring- State or province code. Required for US and CA. Example: Example state code.
suburbstring- Suburb or district. Example: Example suburb.
lightspeedretail_create_customer_contact_channelCreate a contact channel for the specified customer.WriteCreate Customer Contact Channel
Create a contact channel for the specified customer. Returns a data object with id, is_default, note, sort_order, type, value. Use list_customer_contact_channels to browse or filter instead when that fits better.
Inputs
customer_idstringrequired- The unique identifier of the customer. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
typestringrequired- The kind of contact channel. Allowed values: email, phone, fax, mobile, fb_messenger, whatsapp, telegram, viber, facebook, instagram, tiktok, twitter, youtube, website, other. Example: email.one of
emailphonefaxmobilefb_messengerwhatsapptelegramviberfacebookinstagramtiktoktwitteryoutubewebsiteother valuestringrequired- The contact value. Maximum 2048 characters, or 255 characters for the email, phone, fax, mobile and website types. Must be a valid email address when type is email. Example: tony@stark.com.
notestring- Optional free-text note. Maximum 4000 characters. Example: Example note.
sort_orderinteger- Position of the channel in ordered listings. Example: 1.
lightspeedretail_create_customer_groupCreate a new customer group Returns a data object with created_at, deleted_at, group_id, id, name, retailer_id, updated_at, version.WriteCreate Customer Group
Create a new customer group Returns a data object with created_at, deleted_at, group_id, id, name, retailer_id, updated_at, version. Use list_customer_groups to browse or filter, get_customer_group to fetch one by ID, update_customer_group to change an existing one instead when that fits better.
Inputs
namestringrequired- The customer group name. Example: Example name.
lightspeedretail_create_gift_cardCreate and activates a new gift card.WriteCreate Gift Card
Create and activates a new gift card. Returns a data object with balance, created_at, expires_at, gift_card_transactions, id, number, sale_id, sale_source. Use list_gift_cards to browse or filter instead when that fits better.
Inputs
amountnumberrequired- The initial balance to be loaded onto the gift card (e.g. 10.00). Example: 10.
numberstringrequired- The unique number to assign to the gift card. Example: Example number.
expires_atstring- The expiry date of the gift card in YYYY-MM-DD format. If omitted, the expiry will be calculated based on the validity period configured in the Lightspeed Retail UI, or will be null if expiry is not enabled. Example: 2026-10-01T00:00:00Z.
time_zonestring- The timezone to use when interpreting the expires_at date (e.g. "Pacific/Auckland"). See the list of tz database time zones for valid values. Example: Example time zone.
user_idstring- The ID of the user creating the gift card. If omitted, the authenticated user will be used. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_create_gift_card_transactionCreate a new gift card transaction on the specified gift card.WriteCreate Gift Card Transaction
Create a new gift card transaction on the specified gift card. Returns a data object with amount, client_id, created_at, id, source, source_id, type, user_id. Use this for exactly this operation.
Inputs
amountnumberrequired- The transaction amount. Must be negative for REDEEMING transactions and positive for RELOADING transactions. Example: 9.99.
card_numberstringrequired- The number of the gift card to add the transaction to. Example: Example card number.
client_idstringrequired- A unique transaction identifier for idempotency. The client must provide this and is normally the transaction id from the client system. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
typestringrequired- The type of the transaction. Allowed values: REDEEMING, RELOADING. Example: REDEEMING.one of
REDEEMINGRELOADING expires_atstring- Optional new expiry date for the gift card in YYYY-MM-DD format. Can be used to extend the gift card's expiry when reloading. Example: 2026-10-01T00:00:00Z.
time_zonestring- The timezone to use when interpreting the expires_at date (e.g. "Pacific/Auckland"). See the list of tz database time zones for valid values. Example: Example time zone.
user_idstring- The ID of the user creating the transaction. If omitted, the authenticated user will be used. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_create_price_bookCreate a price book Returns a data object with customer_groups, id, name, outlets, restrict_to_platform, retailer_id, type, valid_from.WriteCreate Price Book
Create a price book Returns a data object with customer_groups, id, name, outlets, restrict_to_platform, retailer_id, type, valid_from. Use list_price_books to browse or filter, get_price_book to fetch one by ID, update_price_book to change an existing one instead when that fits better.
Inputs
customer_group_idsarrayrequired- The customer group ids. Example: ["Example customer group ids"].
namestringrequired- Price Book name. Example: Example name.
outlet_idsarrayrequired- The outlet ids. Example: ["Example outlet ids"].
restrict_to_platformstring- "0" - all platforms, "1" - in store, "2" - ecommerce. Example: Example restrict to platform.
valid_fromstring- The date when the Price Book becomes valid (active). Example: Example valid from.
valid_tostring- The date when the Price Book becomes invalid (inactive). Example: Example valid to.
lightspeedretail_create_productCreate a new product.WriteCreate Product
Create a new product. Returns a data array of records. Use list_products to browse or filter, get_product to fetch one by ID, update_product to change an existing one, delete_product to remove one instead when that fits better.
Inputs
namestringrequired- Product name. Note: Variants share the same name. Example: Example name.
account_code_purchasestring- The code used to attribute the purchase of the product to a specific account for the Xero integration. Example: Example account code purchase.
account_code_salestring- The code used to attribute the sales of the product to a specific account for the Xero integration. Example: Example account code sale.
all_outlets_taxobject- Only used for tax inclusive stores. Fields include is_default, tax_id. Example: {"is_default": true, "tax_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}.
attributesobject- The attributes. Fields include key, value. Example: {"key": "Example key", "value": "Example value"}.
brand_idstring- The brand ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
compositearray- A list of composite components. Fields include product_id, quantity. Example: [{"product_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "quantity": 9.99}].
descriptionstring- A detailed description of the Product. Note Can contain HTML. Example: Example description.
dimensions_unitstring- Unit of measurement for product dimensions. These are used to calculate variable shipping rates for stores using Lightspeed eCom. Allowed values: IN, CM, MM, YD. Example: IN.one of
INCMMMYD handlestring- Product handle. Example: Example handle.
heightnumber- Product height. These are used to calculate variable shipping rates for stores using Lightspeed eCom. Example: 9.99.
imagesarray- A list of image objects. Fields include index, location, type. Example: [{"index": 1, "location": "Example location", "type": "s3"}].
inventoryarray- The inventory. Fields include current_amount, outlet_id, reorder_amount, reorder_point. Example: [{"current_amount": 9.99, "outlet_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "reorder_amount": 9.99, "reorder_point": 9.99}].
is_activeboolean- Indicated whether the Product is active. Example: true.
lengthnumber- Product length. These are used to calculate variable shipping rates for stores using Lightspeed eCom. Example: 9.99.
loyalty_amountnumber- The amount of loyalty the customer receives buying this item. Example: 9.99.
outlet_taxesarray- Only used for tax exclusive stores. Fields include outlet_id, tax_id. Example: [{"outlet_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "tax_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}].
price_excluding_taxnumber- The price before tax is added. Example: 9.99.
price_including_taxnumber- The price including all the relevant taxes. Example: 9.99.
product_category_idstring- The product category. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
product_codesarray- The product codes. Fields include code, id, type. Example: [{"code": "Example code", "id": "Example id", "type": "CUSTOM"}].
product_suppliersarray- The product suppliers. Fields include code, id, price, product_id, supplier_id, supplier_name. Example: [{"code": "Example code", "id": "Example id", "price": 9.99, "product_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "supplier_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "supplier_name": "Example supplier name"}].
product_type_idstring- The product category. Note Product types are now product categories. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
skustring- Product sku. Note: Should be unique. Example: SKU-1001.
sourcestring- Indicates the origin of the product. Can be USER, SHOPIFY. Example: Example source.
source_idstring- External reference ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
source_variant_idstring- Secondary external reference ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
supplier_codestring- Supplier code. Example: Example supplier code.
supplier_idstring- The supplier ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
supply_pricenumber- Default supply price. Example: 9.99.
tag_idsarray- An array of tag IDs associated with this product. Example: ["Example tag ids"].
variantsarray- The variants. Fields include all_outlets_tax, dimensions_unit, height, images, inventory, length, outlet_taxes, price_excluding_tax, price_including_tax, product_codes. Example: [{"all_outlets_tax": {"is_default": true, "tax_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}, "dimensions_unit": "IN", "height": 9.99, "images": [{"index": 1, "location": "Example location", "type": "s3"}], "inventory": [{"current_amount"....
weightnumber- Product weight. These are used to calculate variable shipping rates for stores using Lightspeed eCom. Example: 9.99.
weight_unitstring- Unit of measurement for product weight. These are used to calculate variable shipping rates for stores using Lightspeed eCom. Allowed values: CT, G, OZ, LB, KG. Example: CT.one of
CTGOZLBKG widthnumber- Product width. These are used to calculate variable shipping rates for stores using Lightspeed eCom. Example: 9.99.
lightspeedretail_create_saleCreate a sale.WriteCreate Sale
Create a sale. Returns a data object with id. Use list_sales to browse or filter, get_sale to fetch one by ID, update_sale to change an existing one instead when that fits better.
Inputs
sourceobjectrequired- The source. Fields include author_id, id, register_id, type. Example: {"author_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "id": "Example id", "register_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "type": "Example type"}.
statestringrequired- State of the sale. Allowed values: parked, pending, voided, closed. Example: closed.one of
parkedpendingvoidedclosed accounts_transaction_idstring- Xero invoice reference ID. Only editable for ONACCOUNT sales. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
attributesarray- An array of attributes. Example: ["Example attributes"].
customer_idstring- The ID of the customer associated with this sale. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
datestring- The date of the sale in RFC3339 format. If not provided will be added as the time the sale reached the server. Example: 2009-11-10T23:00:00Z.
fulfillment_detailsarray- Fulfillment details for DISPATCH or PICKUP fulfillments. Fields include note, shipping_address_id, shipping_address_token, type. Example: [{"note": "Example note", "shipping_address_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "shipping_address_token": "Example shipping address token", "type": "DISPATCH"}].
fulfillment_outlet_idstring- The default outlet that should fulfill this sale when a line item does not specify its own fulfilment_outlet_id. Mutually exclusive with pick lists created via /sales/{sale_id}/pick_lists. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
idstring- User-provided sale ID. If not included, one will be generated. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
invoice_numberstring- The invoice number for the sale. If left null it will be populated by Lightspeed with the next available invoice number. Example: Example invoice number.
line_itemsarray- Line items. Fields include _metadata, attributes, fulfilment_outlet_id, id, pricing, product, quantity, source, status, tax. Example: [{"_metadata": {"fulfillment_method": "DISPATCH", "is_price_override": true, "sequence": 1}, "attributes": [{"name": "Example name", "value": "Example value"}], "fulfilment_outlet_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "id": "0af7b....
notestring- A note on the sale entered by the cashier. Example: Example note.
paymentsarray- Payments. Fields include amount, billing_address_id, billing_address_token, date, id, source, type. Example: [{"amount": 9.99, "billing_address_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "billing_address_token": "Example billing address token", "date": "2026-10-01T00:00:00Z", "id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "source": {"register_....
pricingobject- The pricing. Fields include adjustments. Example: {"adjustments": [{"amount": {"type": "FIXED", "value": "Example value"}, "name": "Example name", "source": {"id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}, "type": "NON_CASH_FEE"}]}.
service_fieldsobject- The service fields. Fields include service_action, service_agenda, service_items, service_line_items. Example: {"service_action": "Example service action", "service_agenda": {"date": "2026-10-01T00:00:00Z", "minutes_scheduled": 1}, "service_items": {"location": "Example location"}, "service_line_items": [{"_metadata": {"fulfillment_method": "DISP....
short_codestring- Short, unique code to be printed on the receipt for loyalty tracking purposes. Example: Example short code.
lightspeedretail_create_serial_numberCreate a serial number.WriteCreate Serial Number
Create a serial number. Returns a data object with code, id, line_item_id, outlet_id, product_id, sale_id, version. Use list_serial_numbers to browse or filter, get_serial_number to fetch one by ID instead when that fits better.
Inputs
codestringrequired- The actual serial number value. Example: Example code.
outlet_idstringrequired- The ID of the outlet where the serial number is located. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
product_idstringrequired- The ID of the product associated with the serial number. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_create_stock_adjustmentsCreate one or more stock adjustments in a single batch (1–1000 items per request).WriteCreate Stock Adjustments
Create one or more stock adjustments in a single batch (1–1000 items per request). Returns a data array of records with created_at, custom_inventory_adjustment_reason_id, id, outlet_id, product_id, quantity, reason, updated_at. Use list_stock_adjustments to browse or filter instead when that fits better.
Inputs
stock_adjustmentsarrayrequired- The stock adjustments to create. Fields include custom_inventory_adjustment_reason_id, outlet_id, product_id, quantity, reason. Example: [{"custom_inventory_adjustment_reason_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "outlet_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "product_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "quantity": "1", "reason": "DAMAGE"}].
lightspeedretail_create_store_credit_transactionCreate a new store credit transaction.WriteCreate Store Credit Transaction
Create a new store credit transaction. Returns an object with amount, client_id, created_at, id, notes, sale_id, type, user_id. Use this for exactly this operation.
Inputs
amountnumberrequired- The amount of the transaction. Example: 9.99.
client_idstringrequired- The client id is a unique transaction identifier. The client must provide this and is normally the transaction id from the client system. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
customer_idstringrequired- The customer id to apply the store transaction to. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
typestringrequired- The type of the transaction. Allowed values: ISSUE, REDEMPTION, REVERSE. Example: ISSUE.one of
ISSUEREDEMPTIONREVERSE hold_idstring- An ID of a previously created HOLD transaction. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
notesstring- The notes associated with the transaction. Example: Example notes.
user_idstring- The user id of the person who handled the transaction. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_create_supplierCreate a new supplier.WriteCreate Supplier
Create a new supplier. Returns an object whose data field is the id of the supplier created. Use list_suppliers to browse or filter, get_supplier to fetch one by ID, update_supplier to change an existing one, delete_supplier to remove one instead when that fits better.
Inputs
contactobjectrequired- Contact information for the supplier. Fields include company_name, email, fax, first_name, last_name, mobile, phone, physical_address1, physical_address2, physical_city. Example: {"company_name": "Example company name", "email": "tony@example.com", "fax": "Example fax", "first_name": "Example first name", "last_name": "Example last name", "mobile": "Example mobile"}.
namestringrequired- The Supplier name. Example: Example name.
default_markupnumber- This is used for record-keeping purposes and it does not have any effect on your products. Example: 9.99.
descriptionstring- The Supplier description. Example: Example description.
lightspeedretail_create_tagCreate a new tag.WriteCreate Tag
Create a new tag. Returns an object whose data field is the id of the created tag. Use list_tags to browse or filter, get_tag to fetch one by ID, update_tag to change an existing one, delete_tag to remove one instead when that fits better.
Inputs
namestringrequired- The Tag name. Example: Example name.
lightspeedretail_create_taxCreate a new tax.WriteCreate Tax
Create a new tax. Returns a data object with deleted_at, display_name, id, is_default, name, rates, version. Use list_taxes to browse or filter, get_tax to fetch one by ID instead when that fits better.
Inputs
namestringrequired- The Tax name. Example: Example name.
ratenumberrequired- The Tax rate percentage. Example: 0.1.
clothing_footwear_exemptionboolean- Whether the tax is exempt for clothing and footwear. This is applicable for tax exclusive retailers only. Example: true.
clothing_footwear_threshold_valuenumber- The threshold value for clothing and footwear exemption. This is applicable for tax exclusive retailers only. Example: 9.99.
tax_over_thresholdboolean- Whether the tax applies over the threshold. This is applicable for tax exclusive retailers only. Example: true.
lightspeedretail_create_variant_attributeVariant Attributes are required when creating variants.WriteCreate Variant Attribute
Variant Attributes are required when creating variants. Returns a data object with created_at, id, name, updated_at. Use list_variant_attributes to browse or filter, get_variant_attribute to fetch one by ID, update_variant_attribute to change an existing one instead when that fits better.
Inputs
namestringrequired- The name. Example: Size.
lightspeedretail_return_saleInitializes a return for an existing closed sale and returns the newly created SAVED return sale.WriteReturn Sale
Initializes a return for an existing closed sale and returns the newly created SAVED return sale. Returns a data object with _metadata, adjustments, attributes, created_at, customer_id, date, deleted_at, ecom_custom_charges. Use this for exactly this operation.
Inputs
sale_idstringrequired- A valid sale ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_set_custom_field_valuesSet new custom field values on a given entity.WriteSet Custom Field Values
Set new custom field values on a given entity. Returns a data array of records with boolean_value, definition_id, integer_value, name, string_value, title, type. Use get_custom_field_values to fetch one by ID instead when that fits better.
Inputs
entitystringrequired- The entity type. Allowed values: sale, line_item, customer, product. Example: sale.one of
saleline_itemcustomerproduct entity_idstringrequired- The ID of entity. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
valuesarrayrequired- The values. Fields include boolean_value, integer_value, name, string_value. Example: [{"boolean_value": true, "integer_value": 1, "name": "my_custom_field", "string_value": "spec-test-value"}].
lightspeedretail_update_brandUpdate a single brand.WriteUpdate Brand
Update a single brand. Returns a data object with id. Use list_brands to browse or filter, get_brand to fetch one by ID, create_brand to add a new one, delete_brand to remove one instead when that fits better.
- Idempotent
Inputs
brand_idstringrequired- The brand id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
namestringrequired- The Brand name. Example: Example name.
descriptionstring- The brand description. Example: Example description.
lightspeedretail_update_consignmentUpdate the given consignment.WriteUpdate Consignment
Update the given consignment. Returns a data object with consignment_date, created_at, deleted_at, due_at, id, name, outlet_id, received_at. Use list_consignments to browse or filter, get_consignment to fetch one by ID, create_consignment to add a new one, delete_consignment to remove one instead when that fits better.
- Idempotent
Inputs
consignment_idstringrequired- The consignment id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
dataobjectrequired- The data. Fields include consignment_date, created_at, deleted_at, due_at, id, name, outlet_id, received_at, reference, source_outlet_id. Example: {"consignment_date": "2026-10-01T00:00:00Z", "created_at": "2026-10-01T00:00:00Z", "deleted_at": "2026-10-01T00:00:00Z", "due_at": "2026-10-01T00:00:00Z", "id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "name": "Example name"}.
lightspeedretail_update_consignment_productUpdate the specific product within the consignment.WriteUpdate Consignment Product
Update the specific product within the consignment. Returns a data object with data. Use list_consignment_products to browse or filter, add_consignment_product to add items, delete_consignment_product to remove one instead when that fits better.
- Idempotent
Inputs
consignment_idstringrequired- The consignment id to be updated. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
dataobjectrequired- The data. Fields include cost, count, created_at, deleted_at, is_included, product_id, product_sku, received, status, updated_at. Example: {"cost": "Example cost", "count": "Example count", "created_at": "2026-10-01T00:00:00Z", "deleted_at": "2026-10-01T00:00:00Z", "is_included": true, "product_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}.
product_idstringrequired- The product id of the product to be added to the consignment. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_update_customerUpdate the customer with the requested ID.WriteUpdate Customer
Update the customer with the requested ID. Returns a data object with balance, company_name, created_at, custom_field_1, custom_field_2, custom_field_3, custom_field_4, customer_code. Use list_customers to browse or filter, get_customer to fetch one by ID, create_customer to add a new one, delete_customer to remove one instead when that fits better.
- Idempotent
Inputs
customer_idstringrequired- The customer id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
first_namestringrequired- Customer's first name. Example: Example first name.
last_namestringrequired- Customer 's last name. Example: Example last name.
company_namestring- Company name. Example: Example company name.
custom_field_1string- Custom field 1. Can be used to store random data. Example: Example custom field 1.
custom_field_2string- Custom field 2. Example: Example custom field 2.
custom_field_3string- Custom field 3. Example: Example custom field 3.
custom_field_4string- Custom field 4. Example: Example custom field 4.
customer_codestring- Customer code used for claiming loyalty. Example: Example customer code.
customer_group_idstring- Customer group ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
date_of_birthstring- Birthday. Example: 2026-10-01T00:00:00Z.
do_not_emailboolean- Indicates whether the customer opted out of email communications. Example: true.
emailstring- Customer's email address. Example: tony@example.com.
enable_loyaltyboolean- The enable loyalty. Example: true.
enable_promotional_smsboolean- Indicates whether the customer opted in to SMS communications. Example: true.
faxstring- Fax no. Example: Example fax.
genderstring- Customer's gender. Can be M, F or null. Example: Example gender.
mobilestring- Mobile phone no. Example: Example mobile.
notestring- Customer note. Example: Example note.
on_account_limitnumber- Customer's OnAccount Limit. Example: 9.99.
phonestring- Phone no. Example: Example phone.
physical_address_1string- Physical address, line 1. Example: Example physical address 1.
physical_address_2string- Physical address, line 2. Example: Example physical address 2.
physical_citystring- Physical address, city. Example: Example physical city.
physical_country_idstring- Physical address, country code. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
physical_postcodestring- Physical address, post code. Example: Example physical postcode.
physical_statestring- Physical address, state. Example: Example physical state.
physical_suburbstring- Physical address, suburb. Example: Example physical suburb.
postal_address_1string- Postal address, line 1. Example: Example postal address 1.
postal_address_2string- Postal address, line 2. Example: Example postal address 2.
postal_citystring- Postal address, city. Example: Example postal city.
postal_country_idstring- Postal address, country code. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
postal_postcodestring- Postal address, post code. Example: Example postal postcode.
postal_statestring- Postal address, state. Example: Example postal state.
postal_suburbstring- Postal address, suburb. Example: Example postal suburb.
tax_idstring- Customer's tax ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
twitterstring- Twitter handle. Example: Example twitter.
websitestring- Website URL. Example: Example website.
lightspeedretail_update_customer_addressUpdate an existing address for the specified customer.WriteUpdate Customer Address
Update an existing address for the specified customer. Returns a data object with address_line_1, address_line_2, city, country_code, country_name, created_at, customer_id, id. Use list_customer_addresses to browse or filter, get_customer_address to fetch one by ID, create_customer_address to add a new one, delete_customer_address to remove one instead when that fits better.
- Idempotent
Inputs
address_idintegerrequired- The unique identifier of the address. Example: 1.
address_line_1stringrequired- Primary address line (street address, P.O. box, etc.). Example: Example address line 1.
citystringrequired- City or town name. Example: Example city.
country_codestringrequired- ISO 3166-1 alpha-2 country code (e.g., US, NZ, AU). Example: Example country code.
customer_idstringrequired- The unique identifier of the customer. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
postcodestringrequired- Postal code or ZIP code. Example: Example postcode.
typestringrequired- The type of address. Allowed values: BILLING, SHIPPING. Example: BILLING.one of
BILLINGSHIPPING address_line_2string- Secondary address line (apartment, suite, unit, building, floor, etc.). Example: Example address line 2.
statestring- State, province, or region name. Example: Example state.
state_codestring- State or province code. Required for US and CA. Example: Example state code.
suburbstring- Suburb or district. Example: Example suburb.
lightspeedretail_update_customer_groupUpdate the given Customer Group Returns a data object with created_at, deleted_at, group_id, id, name, retailer_id, updated_at, version.WriteUpdate Customer Group
Update the given Customer Group Returns a data object with created_at, deleted_at, group_id, id, name, retailer_id, updated_at, version. Use list_customer_groups to browse or filter, get_customer_group to fetch one by ID, create_customer_group to add a new one instead when that fits better.
- Idempotent
Inputs
customer_group_idstringrequired- The customer group id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
namestringrequired- The customer group name. Example: Example name.
lightspeedretail_update_price_bookUpdate a price book by ID Returns a data object with customer_groups, id, name, outlets, restrict_to_platform, retailer_id, type, valid_from.WriteUpdate Price Book
Update a price book by ID Returns a data object with customer_groups, id, name, outlets, restrict_to_platform, retailer_id, type, valid_from. Use list_price_books to browse or filter, get_price_book to fetch one by ID, create_price_book to add a new one instead when that fits better.
- Idempotent
Inputs
customer_group_idsarrayrequired- The customer group ids. Example: ["Example customer group ids"].
idstringrequired- The price book id. Example: Example id.
namestringrequired- Price Book name. Example: Example name.
outlet_idsarrayrequired- The outlet ids. Example: ["Example outlet ids"].
restrict_to_platformstring- "0" - all platforms, "1" - in store, "2" - ecommerce. Example: Example restrict to platform.
valid_fromstring- The date when the Price Book becomes valid (active). Example: Example valid from.
valid_tostring- The date when the Price Book becomes invalid (inactive). Example: Example valid to.
lightspeedretail_update_productUpdate an existing product.WriteUpdate Product
Update an existing product. Returns the upstream confirmation of the change. Use list_products to browse or filter, get_product to fetch one by ID, create_product to add a new one, delete_product to remove one instead when that fits better.
- Idempotent
Inputs
product_idstringrequired- The object identifier of the Product to update. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
commonobject- Information to update to the product family. For variants, this will update the fields to all variants in the family. Fields include account_code_purchase, account_code_sale, brand_id, description, name, product_category_id, product_suppliers, tag_ids, track_inventory, variant_attributes. Example: {"account_code_purchase": "Example account code purchase", "account_code_sale": "Example account code sale", "brand_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "description": "Example description", "name": "Example name", "product_categ....
detailsobject- Information to update to the product. For variants, this will update the fields for the individual variant product of this request only. Fields include all_outlets_tax, composite_components, dimensions_unit, height, inventory, is_active, length, loyalty_amount, outlet_taxes, packaging. Example: {"all_outlets_tax": {"tax_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}, "composite_components": [{"product_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "quantity": 9.99}], "dimensions_unit": "IN", "height": 9.99, "inventory": [{"current_....
lightspeedretail_update_saleUpdate an existing sale by ID.WriteUpdate Sale
Update an existing sale by ID. Returns a data object with _metadata, adjustments, attributes, created_at, customer_id, date, deleted_at, ecom_custom_charges. Use list_sales to browse or filter, get_sale to fetch one by ID, create_sale to add a new one instead when that fits better.
- Idempotent
Inputs
sale_idstringrequired- A valid sale ID. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
sourceobjectrequired- The source. Fields include author_id, id, register_id, type. Example: {"author_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "id": "Example id", "register_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "type": "Example type"}.
statestringrequired- State of the sale. Allowed values: parked, pending, voided, closed. Example: closed.one of
parkedpendingvoidedclosed accounts_transaction_idstring- Xero invoice reference ID. Only editable for ONACCOUNT sales. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
attributesarray- An array of attributes. Example: ["Example attributes"].
customer_idstring- The ID of the customer associated with this sale. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
datestring- The date of the sale in RFC3339 format. If not provided will be added as the time the sale reached the server. Example: 2009-11-10T23:00:00Z.
fulfillment_detailsarray- Fulfillment details for DISPATCH or PICKUP fulfillments. Fields include note, shipping_address_id, shipping_address_token, type. Example: [{"note": "Example note", "shipping_address_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "shipping_address_token": "Example shipping address token", "type": "DISPATCH"}].
fulfillment_outlet_idstring- The default outlet that should fulfill this sale when a line item does not specify its own fulfilment_outlet_id. Mutually exclusive with pick lists created via /sales/{sale_id}/pick_lists. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
invoice_numberstring- The invoice number for the sale. If left null it will be populated by Lightspeed with the next available invoice number. Example: Example invoice number.
line_itemsarray- Line items. Fields include _metadata, attributes, fulfilment_outlet_id, id, pricing, product, quantity, source, status, tax. Example: [{"_metadata": {"fulfillment_method": "DISPATCH", "is_price_override": true, "sequence": 1}, "attributes": [{"name": "Example name", "value": "Example value"}], "fulfilment_outlet_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "id": "0af7b....
notestring- A note on the sale entered by the cashier. Example: Example note.
paymentsarray- Payments. Fields include amount, billing_address_id, billing_address_token, date, id, source, type. Example: [{"amount": 9.99, "billing_address_id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "billing_address_token": "Example billing address token", "date": "2026-10-01T00:00:00Z", "id": "0af7b240-ab83-11e7-eddc-4023c64c85e5", "source": {"register_....
pricingobject- The pricing. Fields include adjustments. Example: {"adjustments": [{"amount": {"type": "FIXED", "value": "Example value"}, "name": "Example name", "source": {"id": "0af7b240-ab83-11e7-eddc-4023c64c85e5"}, "type": "NON_CASH_FEE"}]}.
service_fieldsobject- The service fields. Fields include service_action, service_agenda, service_items, service_line_items. Example: {"service_action": "Example service action", "service_agenda": {"date": "2026-10-01T00:00:00Z", "minutes_scheduled": 1}, "service_items": {"location": "Example location"}, "service_line_items": [{"_metadata": {"fulfillment_method": "DISP....
short_codestring- Short, unique code to be printed on the receipt for loyalty tracking purposes. Example: Example short code.
lightspeedretail_update_supplierUpdate a supplier.WriteUpdate Supplier
Update a supplier. Returns an object with id. Use list_suppliers to browse or filter, get_supplier to fetch one by ID, create_supplier to add a new one, delete_supplier to remove one instead when that fits better.
- Idempotent
Inputs
contactobjectrequired- Contact information for the supplier. Fields include company_name, email, fax, first_name, last_name, mobile, phone, physical_address1, physical_address2, physical_city. Example: {"company_name": "Example company name", "email": "tony@example.com", "fax": "Example fax", "first_name": "Example first name", "last_name": "Example last name", "mobile": "Example mobile"}.
namestringrequired- The Supplier name. Example: Example name.
supplier_idstringrequired- The supplier id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
default_markupnumber- This is used for record-keeping purposes and it does not have any effect on your products. Example: 9.99.
descriptionstring- The Supplier description. Example: Example description.
lightspeedretail_update_tagUpdate a tag.WriteUpdate Tag
Update a tag. Returns a data object with id, job_id. Use list_tags to browse or filter, get_tag to fetch one by ID, create_tag to add a new one, delete_tag to remove one instead when that fits better.
- Idempotent
Inputs
namestringrequired- The Tag name. Example: Example name.
tag_idstringrequired- The tag id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_update_variant_attributeUpdate a Variant Attribute's name.WriteUpdate Variant Attribute
Update a Variant Attribute's name. Returns a data object with id, name. Use list_variant_attributes to browse or filter, get_variant_attribute to fetch one by ID, create_variant_attribute to add a new one instead when that fits better.
- Idempotent
Inputs
attribute_idstringrequired- The object identifier of the Variant Attribute to update. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
namestringrequired- The name. Example: Size.
lightspeedretail_delete_brandDelete a brand.DestructiveDelete Brand
Delete a brand. Returns an object with payload. Use list_brands to browse or filter, get_brand to fetch one by ID, create_brand to add a new one, update_brand to change an existing one instead when that fits better. Deletion cannot be undone.
- Idempotent
Inputs
brand_idstringrequired- The brand id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_delete_consignmentDelete the consignment with the given ID.DestructiveDelete Consignment
Delete the consignment with the given ID. Returns an empty response on success. Use list_consignments to browse or filter, get_consignment to fetch one by ID, create_consignment to add a new one, update_consignment to change an existing one instead when that fits better. Deletion cannot be undone.
- Idempotent
Inputs
consignment_idstringrequired- The consignment id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_delete_consignment_productRemove the specific product from the consignment.DestructiveDelete Consignment Product
Remove the specific product from the consignment. Returns an empty response on success. Use list_consignment_products to browse or filter, add_consignment_product to add items, update_consignment_product to change an existing one instead when that fits better. Deletion cannot be undone.
- Idempotent
Inputs
consignment_idstringrequired- The consignment id to be updated. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
product_idstringrequired- The product id of the product to be added to the consignment. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_delete_customerDelete the customer with the requested ID.DestructiveDelete Customer
Delete the customer with the requested ID. Returns an empty response on success. Use list_customers to browse or filter, get_customer to fetch one by ID, create_customer to add a new one, update_customer to change an existing one instead when that fits better. Deletion cannot be undone.
- Idempotent
Inputs
customer_idstringrequired- The customer id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_delete_customer_addressDelete an address for the specified customer.DestructiveDelete Customer Address
Delete an address for the specified customer. Returns an empty response on success. Use list_customer_addresses to browse or filter, get_customer_address to fetch one by ID, create_customer_address to add a new one, update_customer_address to change an existing one instead when that fits better. Deletion cannot be undone.
- Idempotent
Inputs
address_idintegerrequired- The unique identifier of the address. Example: 1.
customer_idstringrequired- The unique identifier of the customer. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_delete_productDelete a single product.DestructiveDelete Product
Delete a single product. Returns an empty response on success. Use list_products to browse or filter, get_product to fetch one by ID, create_product to add a new one, update_product to change an existing one instead when that fits better. Deletion cannot be undone.
- Idempotent
Inputs
product_idstringrequired- The product id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_delete_supplierDelete a supplier.DestructiveDelete Supplier
Delete a supplier. Returns a data object with id, job_id. Use list_suppliers to browse or filter, get_supplier to fetch one by ID, create_supplier to add a new one, update_supplier to change an existing one instead when that fits better. Deletion cannot be undone.
- Idempotent
Inputs
supplier_idstringrequired- The supplier id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
lightspeedretail_delete_tagDelete a tag.DestructiveDelete Tag
Delete a tag. Returns a data object with id, job_id. Use list_tags to browse or filter, get_tag to fetch one by ID, create_tag to add a new one, update_tag to change an existing one instead when that fits better. Deletion cannot be undone.
- Idempotent
Inputs
tag_idstringrequired- The tag id. Example: 0af7b240-ab83-11e7-eddc-4023c64c85e5.
No tools match.
