Lightspeed Retail

App · 22 actions

Run your Lightspeed Retail store from workflows: products, prices and stock, customers, sales, suppliers and stock orders, and start a workflow when a sale, customer, product or stock level changes.

Actions

ActionWhat it does
Add product to stock orderAdd a product, with how many to order, to an open stock order.
Adjust stockAdd or remove stock of a product at an outlet, with the reason (damaged, stolen, stock found and so on).
Create customerAdd a customer with their contact details.
Create productAdd a product (one without variants) to the catalog, with its price, SKU, brand, tag and supplier.
Create stock orderStart an open stock order for an outlet, to fill with 'Add product to stock order' and send to the supplier from Lightspeed.
Create supplierAdd a supplier you buy stock from, with their contact.
Delete customerDelete a customer.
Delete productDelete a product from the catalog.
Delete stock orderDelete a stock order.
Delete supplierDelete a supplier.
Get customerGet one customer with their contact details and balances.
Get productGet one product with its name, SKU, prices and family.
Get saleGet one sale with its items, payments, totals, outlet and register.
Get stock levelsSee how many of a product are in stock at each outlet, with its reorder point.
List outletsList the store's outlets (locations) with their addresses.
List productsList the store's products, a page at a time in the order they were last changed, or find the one with a SKU.
List usersList the store's staff accounts and their roles.
Search customersFind customers by email, name, company, phone or customer code.
Search salesFind sales by date, status, outlet, register, cashier, customer or invoice number.
Update customerChange a customer's details.
Update productChange a product's prices, loyalty amount, or whether it is sold in store.
Update supplierChange a supplier's details.

Add product to stock order

Add a product, with how many to order, to an open stock order.

Inputs

Stock order IDconsignment_idtextRequired
The stock order's id, from 'Create stock order'.
Product IDproduct_idtextRequired
The product's id, from 'List products', 'Create product' or a trigger.
QuantitycountnumberRequired
How many to order.At least 0.
Costcostnumber
What one costs. Lightspeed uses the product's supply price when left empty.At least 0.

Outputs

consignment_idtext
The stock order
lineobject
The product's line
Example output
{
  "consignment_id": "0242ac17-002c-11eb-e6f7-1319c1cddfc9",
  "line": {
    "cost": "9.50000",
    "count": "10.00000",
    "product_id": "0242ac12-0002-11e9-e8c4-659494e33119",
    "product_sku": "10042",
    "received": null,
    "status": "PENDING",
    "version": 153464
  }
}

Adjust stock

Add or remove stock of a product at an outlet, with the reason (damaged, stolen, stock found and so on).

Inputs

Product IDproduct_idtextRequired
The product's id, from 'List products', 'Create product' or a trigger.
Outletoutlet_idtextRequired
The outlet (store location). Pick one, or give its id from an earlier step.
QuantityquantitynumberRequired
How many to add or remove. The reason decides which: damaged, expired, used, stolen and donated remove stock; stock found and samples add it.At least 0.
ReasonreasontextRequired
Why the stock changed.One of: DAMAGE (Damaged), EXPIRY (Expired), INTERNAL_USE (Used in store), THEFT (Stolen), DONATION (Donated), STOCK_FOUND (Stock found), SAMPLE_FOR_SALE (Sample put up for sale).

Outputs

adjustmentobject
The adjustment made
Example output
{
  "adjustment": {
    "created_at": "2026-10-21T09:00:00Z",
    "id": "0242ac12-0002-11e9-e8c4-659494e6b2b2",
    "outlet_id": "0242ac12-0002-11e9-e8c4-659494e196e3",
    "product_id": "0242ac12-0002-11e9-e8c4-659494e33119",
    "quantity": "-2",
    "reason": "DAMAGE",
    "user_id": "0242ac12-0002-11e9-e8c4-659494e1aaaa",
    "version": 153480
  }
}

Create customer

Add a customer with their contact details.

Inputs

First namefirst_nametextRequired
The customer's first name.
Last namelast_nametextRequired
The customer's last name.
Emailemailtext
The customer's email address.
Phonephonetext
The customer's phone number.
Mobilemobiletext
The customer's mobile number.
Companycompany_nametext
The company the customer buys for.
Customer codecustomer_codetext
The code the customer gives to claim loyalty. Lightspeed makes one if left empty.
Customer groupcustomer_group_idtext
The group the customer is in, which can set their prices.
Birthdaydate_of_birthdate
The customer's date of birth.
Gendergendertext
The customer's gender, as Lightspeed records it.One of: M (Male), F (Female).
Notenotetext
A note about the customer.
Opted out of emaildo_not_emailtrue/false
Whether the customer asked not to get marketing email.
Street addressphysical_address_1text
The first line of the address.
Cityphysical_citytext
The city.
State or regionphysical_statetext
The state, province or region.
Postcodephysical_postcodetext
The postcode or ZIP code.
Countryphysical_country_idtext
The two-letter country code, such as US, CA or GB.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "balance": 0,
    "company_name": null,
    "created_at": "2026-10-20T21:18:11Z",
    "customer_code": "Jo-K1L2",
    "customer_group_id": "0242ac12-0002-11e9-e8c4-659494e196e4",
    "date_of_birth": null,
    "deleted_at": null,
    "do_not_email": false,
    "email": "jo@example.com",
    "enable_loyalty": true,
    "first_name": "Jo",
    "gender": null,
    "id": "0242ac12-0002-11e9-e8c4-659494e2a1b2",
    "last_name": "Bloggs",
    "loyalty_balance": 0,
    "mobile": "+15555550100",
    "note": null,
    "phone": null,
    "physical_city": "Portland",
    "physical_country_id": "US",
    "updated_at": "2026-10-20T21:18:11Z",
    "version": 153470,
    "year_to_date": 128.5
  }
}

Create product

Add a product (one without variants) to the catalog, with its price, SKU, brand, tag and supplier.

Inputs

NamenametextRequired
The product's name.
SKUskutext
The product's SKU. Leave empty to use the store's next SKU.
Price before taxprice_excluding_taxnumber
The retail price before tax, such as 19.99.At least 0.
Price including taxprice_including_taxnumber
The retail price with tax, for stores that show tax-inclusive prices.At least 0.
Descriptiondescriptiontext
The product's description.
Brandbrand_idtext
The product's brand.
Tagtag_idtext
A tag to put on the product.
Suppliersupplier_idtext
The supplier you buy it from.
Supplier codesupplier_codetext
The supplier's own code for the product.
Supply pricesupply_pricenumber
What the supplier charges you for one.At least 0.
Track stocktrack_inventorytrue/false
Whether Lightspeed counts the stock of this product. Lightspeed's default applies when left empty.

Outputs

nametext
Its name
product_family_idtext
The id of its product family
product_idtext
The new product's id
skutext
Its SKU
Example output
{
  "name": "Canvas Tote",
  "product_family_id": "0242ac12-0002-11e9-e8c4-659494e33000",
  "product_id": "0242ac12-0002-11e9-e8c4-659494e33119",
  "sku": "10042"
}

Create stock order

Start an open stock order for an outlet, to fill with 'Add product to stock order' and send to the supplier from Lightspeed.

Inputs

Outletoutlet_idtextRequired
The outlet (store location). Pick one, or give its id from an earlier step.
NotenametextRequired
A note naming the order, shown in Lightspeed's stock orders.
Suppliersupplier_idtext
The supplier the order is for.
Order numberreferencetext
Your order number.
Duedue_atdate and time
When the stock is expected to arrive.

Outputs

stock_orderobject
The new stock order
Example output
{
  "stock_order": {
    "created_at": "2026-10-20T21:18:11+00:00",
    "due_at": null,
    "id": "0242ac17-002c-11eb-e6f7-1319c1cddfc9",
    "name": "Restock totes",
    "outlet_id": "0242ac12-0002-11e9-e8c4-659494e196e3",
    "reference": "PO-1001",
    "status": "OPEN",
    "supplier_id": "0242ac12-0002-11e9-e8c4-659494e5a1a1",
    "type": "SUPPLIER",
    "version": 153463
  }
}

Create supplier

Add a supplier you buy stock from, with their contact.

Inputs

NamenametextRequired
The supplier's name.
Descriptiondescriptiontext
A description of the supplier.
Default markupdefault_markupnumber
The markup you usually apply to this supplier's products, as a percentage. Lightspeed only records it.
Companycompany_nametext
The supplier's company name.
Contact first namefirst_nametext
Your contact's first name.
Contact last namelast_nametext
Your contact's last name.
Emailemailtext
The supplier's email address.
Phonephonetext
The supplier's phone number.
Mobilemobiletext
The supplier's mobile number.
Websitewebsitetext
The supplier's website.

Outputs

supplierobject
The supplier
supplier_idtext
The supplier's id
Example output
{
  "supplier": {
    "contact": {
      "company_name": "Acme Wholesale",
      "email": "orders@example.com",
      "first_name": "Pat",
      "last_name": "Lee",
      "mobile": null,
      "phone": null,
      "website": null
    },
    "default_markup": 40,
    "description": null,
    "id": "0242ac12-0002-11e9-e8c4-659494e5a1a1",
    "name": "Acme Wholesale",
    "source": "USER",
    "version": 2001
  },
  "supplier_id": "0242ac12-0002-11e9-e8c4-659494e5a1a1"
}

Delete customer

Delete a customer.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Search customers', 'Create customer' or a trigger.

Outputs

customer_idtext
The customer deleted
deletedtrue/false
Always true once deleted
Example output
{
  "customer_id": "0242ac12-0002-11e9-e8c4-659494e2a1b2",
  "deleted": true
}

Delete product

Delete a product from the catalog.

Inputs

Product IDproduct_idtextRequired
The product's id, from 'List products', 'Create product' or a trigger.

Outputs

deletedtrue/false
Always true once deleted
product_idtext
The product deleted
Example output
{
  "deleted": true,
  "product_id": "0242ac12-0002-11e9-e8c4-659494e33119"
}

Delete stock order

Delete a stock order.

Inputs

Stock order IDconsignment_idtextRequired
The stock order's id, from 'Create stock order'.

Outputs

consignment_idtext
The stock order deleted
deletedtrue/false
Always true once deleted
Example output
{
  "consignment_id": "0242ac17-002c-11eb-e6f7-1319c1cddfc9",
  "deleted": true
}

Delete supplier

Delete a supplier. Its products stay, no longer linked to it.

Inputs

Suppliersupplier_idtextRequired
The supplier. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
supplier_idtext
The supplier deleted
Example output
{
  "deleted": true,
  "supplier_id": "0242ac12-0002-11e9-e8c4-659494e5a1a1"
}

Get customer

Get one customer with their contact details and balances.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Search customers', 'Create customer' or a trigger.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "balance": 0,
    "company_name": null,
    "created_at": "2026-10-20T21:18:11Z",
    "customer_code": "Jo-K1L2",
    "customer_group_id": "0242ac12-0002-11e9-e8c4-659494e196e4",
    "date_of_birth": null,
    "deleted_at": null,
    "do_not_email": false,
    "email": "jo@example.com",
    "enable_loyalty": true,
    "first_name": "Jo",
    "gender": null,
    "id": "0242ac12-0002-11e9-e8c4-659494e2a1b2",
    "last_name": "Bloggs",
    "loyalty_balance": 0,
    "mobile": "+15555550100",
    "note": null,
    "phone": null,
    "physical_city": "Portland",
    "physical_country_id": "US",
    "updated_at": "2026-10-20T21:18:11Z",
    "version": 153470,
    "year_to_date": 128.5
  }
}

Get product

Get one product with its name, SKU, prices and family.

Inputs

Product IDproduct_idtextRequired
The product's id, from 'List products', 'Create product' or a trigger.

Outputs

familyobject
Its product family: name, description, brand
nametext
The product's name
productobject
The product
Example output
{
  "family": {
    "brand_id": null,
    "category_id": null,
    "classification": "STANDARD",
    "description": "A sturdy canvas bag.",
    "family_count": 1,
    "id": "0242ac12-0002-11e9-e8c4-659494e33000",
    "name": "Canvas Tote",
    "tag_ids": [],
    "track_inventory": true
  },
  "name": "Canvas Tote",
  "product": {
    "active": {
      "ecwid": false,
      "in_store": true
    },
    "codes": [
      {
        "code": "10042",
        "type": "CUSTOM"
      }
    ],
    "created_at": "2026-10-20T21:18:11Z",
    "deleted_at": null,
    "family_id": "0242ac12-0002-11e9-e8c4-659494e33000",
    "id": "0242ac12-0002-11e9-e8c4-659494e33119",
    "prices": {
      "loyalty_amount": null,
      "price_excluding_tax": "24.95",
      "price_including_tax": "28.69",
      "tax": "3.74"
    },
    "sku": "10042",
    "suppliers": [],
    "updated_at": "2026-10-21T08:02:40Z",
    "variant_name": "Canvas Tote",
    "version": 153463
  }
}

Get sale

Get one sale with its items, payments, totals, outlet and register.

Inputs

Sale IDsale_idtextRequired
The sale's id, from 'Search sales' or a trigger.

Outputs

saleobject
The sale
Example output
{
  "sale": {
    "created_at": "2026-10-21T17:04:12Z",
    "customer_id": "0242ac12-0002-11e9-e8c4-659494e2a1b2",
    "date": "2026-10-21T17:04:12Z",
    "id": "0242ac12-0002-11e9-e8c4-659494e4f5a6",
    "invoice_number": "MAIN-1042",
    "line_items": [
      {
        "id": "0242ac12-0002-11e9-e8c4-659494e4f5b7",
        "note": null,
        "product": {
          "id": "0242ac12-0002-11e9-e8c4-659494e33119",
          "name": "Canvas Tote",
          "sku": "10042"
        },
        "quantity": 1
      }
    ],
    "note": null,
    "payments": [
      {
        "amount": 28.69,
        "date": "2026-10-21T17:04:12Z",
        "id": "0242ac12-0002-11e9-e8c4-659494e4f5c8"
      }
    ],
    "receipt_number": "1042",
    "source": {
      "author": {
        "id": "0242ac12-0002-11e9-e8c4-659494e1aaaa",
        "name": "sam"
      },
      "outlet_id": "0242ac12-0002-11e9-e8c4-659494e196e3",
      "register_id": "0242ac12-0002-11e9-e8c4-659494e1c4d5"
    },
    "state": "closed",
    "totals": {
      "loyalty": 0,
      "price": 24.95,
      "price_incl_tax": 28.69,
      "surcharge": 0,
      "tax": 3.74
    },
    "updated_at": "2026-10-21T17:04:12Z"
  }
}

Get stock levels

See how many of a product are in stock at each outlet, with its reorder point.

Inputs

Product IDproduct_idtextRequired
The product's id, from 'List products', 'Create product' or a trigger.
Outletoutlet_idtext
Only this outlet. Leave empty for every outlet.

Outputs

countnumber
How many came back
levelslist
One per outlet
total_on_handnumber
The stock across the outlets listed
Example output
{
  "count": 1,
  "levels": [
    {
      "current_inventory_level": 12,
      "location_id": "0242ac12-0002-11e9-e8c4-659494e196e3",
      "name": "Canvas Tote",
      "product_id": "0242ac12-0002-11e9-e8c4-659494e33119",
      "quantity_to_procure": 0,
      "reorder_amount": 20,
      "reorder_method": "FIXED",
      "reorder_threshold": 5
    }
  ],
  "total_on_hand": 12
}

List outlets

List the store's outlets (locations) with their addresses.

Inputs

None.

Outputs

countnumber
How many came back
outletslist
The outlets
Example output
{
  "count": 1,
  "outlets": [
    {
      "currency": "USD",
      "display_prices": "exclusive",
      "email": null,
      "id": "0242ac12-0002-11e9-e8c4-659494e196e3",
      "name": "Main Street",
      "phone": null,
      "physical_address_1": "1 Main St",
      "physical_city": "Portland",
      "physical_country_id": "US",
      "physical_postcode": "97205",
      "time_zone": "America/Los_Angeles",
      "version": 1001
    }
  ]
}

List products

List the store's products, a page at a time in the order they were last changed, or find the one with a SKU.

Inputs

SKUskutext
Find the product with this SKU. Leave empty to list them all.
How manypage_sizenumber
How many to return per page, 1 to 1000. Defaults to 100.From 1 to 1000.
Next pageafternumber
The 'next_after' from the page before, to get the page after it.At least 0.

Outputs

countnumber
How many came back
has_moretrue/false
Whether more may follow
next_afternumber
Where the next page starts; 0 when this is the last
productslist
The products
Example output
{
  "count": 1,
  "has_more": false,
  "next_after": 153463,
  "products": [
    {
      "active": {
        "ecwid": false,
        "in_store": true
      },
      "codes": [
        {
          "code": "10042",
          "type": "CUSTOM"
        }
      ],
      "created_at": "2026-10-20T21:18:11Z",
      "deleted_at": null,
      "family_id": "0242ac12-0002-11e9-e8c4-659494e33000",
      "id": "0242ac12-0002-11e9-e8c4-659494e33119",
      "prices": {
        "loyalty_amount": null,
        "price_excluding_tax": "24.95",
        "price_including_tax": "28.69",
        "tax": "3.74"
      },
      "sku": "10042",
      "suppliers": [],
      "updated_at": "2026-10-21T08:02:40Z",
      "variant_name": "Canvas Tote",
      "version": 153463
    }
  ]
}

List users

List the store's staff accounts and their roles.

Inputs

None.

Outputs

countnumber
How many came back
userslist
The users
Example output
{
  "count": 1,
  "users": [
    {
      "account_type": "manager",
      "display_name": "Sam Rivera",
      "email": "sam@example.com",
      "enabled": true,
      "id": "0242ac12-0002-11e9-e8c4-659494e1aaaa",
      "restricted_outlet_ids": [],
      "username": "sam",
      "version": 501
    }
  ]
}

Search customers

Find customers by email, name, company, phone or customer code. Every field given must match.

Inputs

Emailemailtext
The customer's email address.
First namefirst_nametext
The customer's first name.
Last namelast_nametext
The customer's last name.
Companycompany_nametext
The customer's company.
Phonephonetext
The customer's phone number.
Mobilemobiletext
The customer's mobile number.
Customer codecustomer_codetext
The customer's code.
How manypage_sizenumber
How many to return per page, 1 to 1000. Defaults to 100.From 1 to 1000.
Skipoffsetnumber
How many matches to skip, to get the next page ('next_offset' from the page before).At least 0.

Outputs

countnumber
How many came back
customerslist
The matching customers
next_offsetnumber
The 'Skip' for the next page; 0 when none follows
total_countnumber
How many match in all
Example output
{
  "count": 1,
  "customers": [
    {
      "balance": 0,
      "company_name": null,
      "created_at": "2026-10-20T21:18:11Z",
      "customer_code": "Jo-K1L2",
      "customer_group_id": "0242ac12-0002-11e9-e8c4-659494e196e4",
      "date_of_birth": null,
      "deleted_at": null,
      "do_not_email": false,
      "email": "jo@example.com",
      "enable_loyalty": true,
      "first_name": "Jo",
      "gender": null,
      "id": "0242ac12-0002-11e9-e8c4-659494e2a1b2",
      "last_name": "Bloggs",
      "loyalty_balance": 0,
      "mobile": "+15555550100",
      "note": null,
      "phone": null,
      "physical_city": "Portland",
      "physical_country_id": "US",
      "updated_at": "2026-10-20T21:18:11Z",
      "version": 153470,
      "year_to_date": 128.5
    }
  ],
  "next_offset": 0,
  "total_count": 1
}

Search sales

Find sales by date, status, outlet, register, cashier, customer or invoice number.

Inputs

Fromdate_fromdate and time
Only sales made at or after this time.
Untildate_todate and time
Only sales made at or before this time.
Statusstatetext
Only sales in this status.One of: closed (Completed), parked, pending (Pending (layby, on account or awaiting fulfillment)), voided.
Outletoutlet_idtext
Only sales at this outlet.
Registerregister_idtext
Only sales on this register.
Cashiercashier_idtext
Only sales made by this user.
Customer IDcustomer_idtext
Only sales to this customer (an id from 'Search customers').
Invoice numberinvoice_numbertext
The sale's invoice number.
How manypage_sizenumber
How many to return per page, 1 to 1000. Defaults to 100.From 1 to 1000.
Skipoffsetnumber
How many matches to skip, to get the next page ('next_offset' from the page before).At least 0.

Outputs

countnumber
How many came back
next_offsetnumber
The 'Skip' for the next page; 0 when none follows
saleslist
The matching sales
total_countnumber
How many match in all
Example output
{
  "count": 1,
  "next_offset": 0,
  "sales": [
    {
      "created_at": "2026-10-21T17:04:12Z",
      "customer_id": "0242ac12-0002-11e9-e8c4-659494e2a1b2",
      "date": "2026-10-21T17:04:12Z",
      "id": "0242ac12-0002-11e9-e8c4-659494e4f5a6",
      "invoice_number": "MAIN-1042",
      "line_items": [
        {
          "id": "0242ac12-0002-11e9-e8c4-659494e4f5b7",
          "note": null,
          "product": {
            "id": "0242ac12-0002-11e9-e8c4-659494e33119",
            "name": "Canvas Tote",
            "sku": "10042"
          },
          "quantity": 1
        }
      ],
      "note": null,
      "payments": [
        {
          "amount": 28.69,
          "date": "2026-10-21T17:04:12Z",
          "id": "0242ac12-0002-11e9-e8c4-659494e4f5c8"
        }
      ],
      "receipt_number": "1042",
      "source": {
        "author": {
          "id": "0242ac12-0002-11e9-e8c4-659494e1aaaa",
          "name": "sam"
        },
        "outlet_id": "0242ac12-0002-11e9-e8c4-659494e196e3",
        "register_id": "0242ac12-0002-11e9-e8c4-659494e1c4d5"
      },
      "state": "closed",
      "totals": {
        "loyalty": 0,
        "price": 24.95,
        "price_incl_tax": 28.69,
        "surcharge": 0,
        "tax": 3.74
      },
      "updated_at": "2026-10-21T17:04:12Z"
    }
  ],
  "total_count": 1
}

Update customer

Change a customer's details. Fields left empty stay as they are.

Inputs

Customer IDcustomer_idtextRequired
The customer's id, from 'Search customers', 'Create customer' or a trigger.
First namefirst_nametext
A new first name. Leave empty to keep it.
Last namelast_nametext
A new last name. Leave empty to keep it.
Emailemailtext
The customer's email address.
Phonephonetext
The customer's phone number.
Mobilemobiletext
The customer's mobile number.
Companycompany_nametext
The company the customer buys for.
Customer codecustomer_codetext
The code the customer gives to claim loyalty. Lightspeed makes one if left empty.
Customer groupcustomer_group_idtext
The group the customer is in, which can set their prices.
Birthdaydate_of_birthdate
The customer's date of birth.
Gendergendertext
The customer's gender, as Lightspeed records it.One of: M (Male), F (Female).
Notenotetext
A note about the customer.
Opted out of emaildo_not_emailtrue/false
Whether the customer asked not to get marketing email.
Street addressphysical_address_1text
The first line of the address.
Cityphysical_citytext
The city.
State or regionphysical_statetext
The state, province or region.
Postcodephysical_postcodetext
The postcode or ZIP code.
Countryphysical_country_idtext
The two-letter country code, such as US, CA or GB.

Outputs

customerobject
The customer
Example output
{
  "customer": {
    "balance": 0,
    "company_name": null,
    "created_at": "2026-10-20T21:18:11Z",
    "customer_code": "Jo-K1L2",
    "customer_group_id": "0242ac12-0002-11e9-e8c4-659494e196e4",
    "date_of_birth": null,
    "deleted_at": null,
    "do_not_email": false,
    "email": "jo@example.com",
    "enable_loyalty": true,
    "first_name": "Jo",
    "gender": null,
    "id": "0242ac12-0002-11e9-e8c4-659494e2a1b2",
    "last_name": "Bloggs",
    "loyalty_balance": 0,
    "mobile": "+15555550100",
    "note": null,
    "phone": null,
    "physical_city": "Portland",
    "physical_country_id": "US",
    "updated_at": "2026-10-20T21:18:11Z",
    "version": 153470,
    "year_to_date": 128.5
  }
}

Update product

Change a product's prices, loyalty amount, or whether it is sold in store. Fields left empty stay as they are.

Inputs

Product IDproduct_idtextRequired
The product's id, from 'List products', 'Create product' or a trigger.
Price before taxprice_excluding_taxnumber
The retail price before tax, such as 19.99.At least 0.
Price including taxprice_including_taxnumber
The retail price with tax, for stores that show tax-inclusive prices.At least 0.
Loyalty amountloyalty_amountnumber
The loyalty a customer earns buying one.At least 0.
Sold in storeactive_in_storetext
Whether the product can be sold in store.One of: true (Yes), false (No).

Outputs

familyobject
Its product family: name, description, brand
nametext
The product's name
productobject
The product
Example output
{
  "family": {
    "brand_id": null,
    "category_id": null,
    "classification": "STANDARD",
    "description": "A sturdy canvas bag.",
    "family_count": 1,
    "id": "0242ac12-0002-11e9-e8c4-659494e33000",
    "name": "Canvas Tote",
    "tag_ids": [],
    "track_inventory": true
  },
  "name": "Canvas Tote",
  "product": {
    "active": {
      "ecwid": false,
      "in_store": true
    },
    "codes": [
      {
        "code": "10042",
        "type": "CUSTOM"
      }
    ],
    "created_at": "2026-10-20T21:18:11Z",
    "deleted_at": null,
    "family_id": "0242ac12-0002-11e9-e8c4-659494e33000",
    "id": "0242ac12-0002-11e9-e8c4-659494e33119",
    "prices": {
      "loyalty_amount": null,
      "price_excluding_tax": "24.95",
      "price_including_tax": "28.69",
      "tax": "3.74"
    },
    "sku": "10042",
    "suppliers": [],
    "updated_at": "2026-10-21T08:02:40Z",
    "variant_name": "Canvas Tote",
    "version": 153463
  }
}

Update supplier

Change a supplier's details. Fields left empty stay as they are.

Inputs

Suppliersupplier_idtextRequired
The supplier. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Descriptiondescriptiontext
A description of the supplier.
Default markupdefault_markupnumber
The markup you usually apply to this supplier's products, as a percentage. Lightspeed only records it.
Companycompany_nametext
The supplier's company name.
Contact first namefirst_nametext
Your contact's first name.
Contact last namelast_nametext
Your contact's last name.
Emailemailtext
The supplier's email address.
Phonephonetext
The supplier's phone number.
Mobilemobiletext
The supplier's mobile number.
Websitewebsitetext
The supplier's website.

Outputs

supplierobject
The supplier
supplier_idtext
The supplier's id
Example output
{
  "supplier": {
    "contact": {
      "company_name": "Acme Wholesale",
      "email": "orders@example.com",
      "first_name": "Pat",
      "last_name": "Lee",
      "mobile": null,
      "phone": null,
      "website": null
    },
    "default_markup": 40,
    "description": null,
    "id": "0242ac12-0002-11e9-e8c4-659494e5a1a1",
    "name": "Acme Wholesale",
    "source": "USER",
    "version": 2001
  },
  "supplier_id": "0242ac12-0002-11e9-e8c4-659494e5a1a1"
}

On this page