# Lightspeed Retail

> 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.

App · 22 actions. Web page: https://docs.lodol.com/docs/integrations/lightspeed-retail

## Actions

### Add product to stock order

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

**Inputs**

- Stock order ID (`consignment_id`, text, required): The stock order's id, from 'Create stock order'.
- Product ID (`product_id`, text, required): The product's id, from 'List products', 'Create product' or a trigger.
- Quantity (`count`, number, required): How many to order. At least 0.
- Cost (`cost`, number): What one costs. Lightspeed uses the product's supply price when left empty. At least 0.

**Outputs**

- `consignment_id` (text): The stock order
- `line` (object): The product's line

**Example output**

```json
{
  "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 ID (`product_id`, text, required): The product's id, from 'List products', 'Create product' or a trigger.
- Outlet (`outlet_id`, text, required): The outlet (store location). Pick one, or give its id from an earlier step.
- Quantity (`quantity`, number, required): 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.
- Reason (`reason`, text, required): 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**

- `adjustment` (object): The adjustment made

**Example output**

```json
{
  "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 name (`first_name`, text, required): The customer's first name.
- Last name (`last_name`, text, required): The customer's last name.
- Email (`email`, text): The customer's email address.
- Phone (`phone`, text): The customer's phone number.
- Mobile (`mobile`, text): The customer's mobile number.
- Company (`company_name`, text): The company the customer buys for.
- Customer code (`customer_code`, text): The code the customer gives to claim loyalty. Lightspeed makes one if left empty.
- Customer group (`customer_group_id`, text): The group the customer is in, which can set their prices.
- Birthday (`date_of_birth`, date): The customer's date of birth.
- Gender (`gender`, text): The customer's gender, as Lightspeed records it. One of: `M` (Male), `F` (Female).
- Note (`note`, text): A note about the customer.
- Opted out of email (`do_not_email`, true/false): Whether the customer asked not to get marketing email.
- Street address (`physical_address_1`, text): The first line of the address.
- City (`physical_city`, text): The city.
- State or region (`physical_state`, text): The state, province or region.
- Postcode (`physical_postcode`, text): The postcode or ZIP code.
- Country (`physical_country_id`, text): The two-letter country code, such as US, CA or GB.

**Outputs**

- `customer` (object): The customer

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The product's name.
- SKU (`sku`, text): The product's SKU. Leave empty to use the store's next SKU.
- Price before tax (`price_excluding_tax`, number): The retail price before tax, such as 19.99. At least 0.
- Price including tax (`price_including_tax`, number): The retail price with tax, for stores that show tax-inclusive prices. At least 0.
- Description (`description`, text): The product's description.
- Brand (`brand_id`, text): The product's brand.
- Tag (`tag_id`, text): A tag to put on the product.
- Supplier (`supplier_id`, text): The supplier you buy it from.
- Supplier code (`supplier_code`, text): The supplier's own code for the product.
- Supply price (`supply_price`, number): What the supplier charges you for one. At least 0.
- Track stock (`track_inventory`, true/false): Whether Lightspeed counts the stock of this product. Lightspeed's default applies when left empty.

**Outputs**

- `name` (text): Its name
- `product_family_id` (text): The id of its product family
- `product_id` (text): The new product's id
- `sku` (text): Its SKU

**Example output**

```json
{
  "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**

- Outlet (`outlet_id`, text, required): The outlet (store location). Pick one, or give its id from an earlier step.
- Note (`name`, text, required): A note naming the order, shown in Lightspeed's stock orders.
- Supplier (`supplier_id`, text): The supplier the order is for.
- Order number (`reference`, text): Your order number.
- Due (`due_at`, date and time): When the stock is expected to arrive.

**Outputs**

- `stock_order` (object): The new stock order

**Example output**

```json
{
  "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**

- Name (`name`, text, required): The supplier's name.
- Description (`description`, text): A description of the supplier.
- Default markup (`default_markup`, number): The markup you usually apply to this supplier's products, as a percentage. Lightspeed only records it.
- Company (`company_name`, text): The supplier's company name.
- Contact first name (`first_name`, text): Your contact's first name.
- Contact last name (`last_name`, text): Your contact's last name.
- Email (`email`, text): The supplier's email address.
- Phone (`phone`, text): The supplier's phone number.
- Mobile (`mobile`, text): The supplier's mobile number.
- Website (`website`, text): The supplier's website.

**Outputs**

- `supplier` (object): The supplier
- `supplier_id` (text): The supplier's id

**Example output**

```json
{
  "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 ID (`customer_id`, text, required): The customer's id, from 'Search customers', 'Create customer' or a trigger.

**Outputs**

- `customer_id` (text): The customer deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "customer_id": "0242ac12-0002-11e9-e8c4-659494e2a1b2",
  "deleted": true
}
```

### Delete product

Delete a product from the catalog.

**Inputs**

- Product ID (`product_id`, text, required): The product's id, from 'List products', 'Create product' or a trigger.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `product_id` (text): The product deleted

**Example output**

```json
{
  "deleted": true,
  "product_id": "0242ac12-0002-11e9-e8c4-659494e33119"
}
```

### Delete stock order

Delete a stock order.

**Inputs**

- Stock order ID (`consignment_id`, text, required): The stock order's id, from 'Create stock order'.

**Outputs**

- `consignment_id` (text): The stock order deleted
- `deleted` (true/false): Always true once deleted

**Example output**

```json
{
  "consignment_id": "0242ac17-002c-11eb-e6f7-1319c1cddfc9",
  "deleted": true
}
```

### Delete supplier

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

**Inputs**

- Supplier (`supplier_id`, text, required): The supplier. Pick one, or give its id from an earlier step.

**Outputs**

- `deleted` (true/false): Always true once deleted
- `supplier_id` (text): The supplier deleted

**Example output**

```json
{
  "deleted": true,
  "supplier_id": "0242ac12-0002-11e9-e8c4-659494e5a1a1"
}
```

### Get customer

Get one customer with their contact details and balances.

**Inputs**

- Customer ID (`customer_id`, text, required): The customer's id, from 'Search customers', 'Create customer' or a trigger.

**Outputs**

- `customer` (object): The customer

**Example output**

```json
{
  "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 ID (`product_id`, text, required): The product's id, from 'List products', 'Create product' or a trigger.

**Outputs**

- `family` (object): Its product family: name, description, brand
- `name` (text): The product's name
- `product` (object): The product

**Example output**

```json
{
  "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 ID (`sale_id`, text, required): The sale's id, from 'Search sales' or a trigger.

**Outputs**

- `sale` (object): The sale

**Example output**

```json
{
  "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 ID (`product_id`, text, required): The product's id, from 'List products', 'Create product' or a trigger.
- Outlet (`outlet_id`, text): Only this outlet. Leave empty for every outlet.

**Outputs**

- `count` (number): How many came back
- `levels` (list): One per outlet
- `total_on_hand` (number): The stock across the outlets listed

**Example output**

```json
{
  "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**

- `count` (number): How many came back
- `outlets` (list): The outlets

**Example output**

```json
{
  "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**

- SKU (`sku`, text): Find the product with this SKU. Leave empty to list them all.
- How many (`page_size`, number): How many to return per page, 1 to 1000. Defaults to 100. From 1 to 1000.
- Next page (`after`, number): The 'next_after' from the page before, to get the page after it. At least 0.

**Outputs**

- `count` (number): How many came back
- `has_more` (true/false): Whether more may follow
- `next_after` (number): Where the next page starts; 0 when this is the last
- `products` (list): The products

**Example output**

```json
{
  "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**

- `count` (number): How many came back
- `users` (list): The users

**Example output**

```json
{
  "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**

- Email (`email`, text): The customer's email address.
- First name (`first_name`, text): The customer's first name.
- Last name (`last_name`, text): The customer's last name.
- Company (`company_name`, text): The customer's company.
- Phone (`phone`, text): The customer's phone number.
- Mobile (`mobile`, text): The customer's mobile number.
- Customer code (`customer_code`, text): The customer's code.
- How many (`page_size`, number): How many to return per page, 1 to 1000. Defaults to 100. From 1 to 1000.
- Skip (`offset`, number): How many matches to skip, to get the next page ('next_offset' from the page before). At least 0.

**Outputs**

- `count` (number): How many came back
- `customers` (list): The matching customers
- `next_offset` (number): The 'Skip' for the next page; 0 when none follows
- `total_count` (number): How many match in all

**Example output**

```json
{
  "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**

- From (`date_from`, date and time): Only sales made at or after this time.
- Until (`date_to`, date and time): Only sales made at or before this time.
- Status (`state`, text): Only sales in this status. One of: `closed` (Completed), `parked`, `pending` (Pending (layby, on account or awaiting fulfillment)), `voided`.
- Outlet (`outlet_id`, text): Only sales at this outlet.
- Register (`register_id`, text): Only sales on this register.
- Cashier (`cashier_id`, text): Only sales made by this user.
- Customer ID (`customer_id`, text): Only sales to this customer (an id from 'Search customers').
- Invoice number (`invoice_number`, text): The sale's invoice number.
- How many (`page_size`, number): How many to return per page, 1 to 1000. Defaults to 100. From 1 to 1000.
- Skip (`offset`, number): How many matches to skip, to get the next page ('next_offset' from the page before). At least 0.

**Outputs**

- `count` (number): How many came back
- `next_offset` (number): The 'Skip' for the next page; 0 when none follows
- `sales` (list): The matching sales
- `total_count` (number): How many match in all

**Example output**

```json
{
  "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 ID (`customer_id`, text, required): The customer's id, from 'Search customers', 'Create customer' or a trigger.
- First name (`first_name`, text): A new first name. Leave empty to keep it.
- Last name (`last_name`, text): A new last name. Leave empty to keep it.
- Email (`email`, text): The customer's email address.
- Phone (`phone`, text): The customer's phone number.
- Mobile (`mobile`, text): The customer's mobile number.
- Company (`company_name`, text): The company the customer buys for.
- Customer code (`customer_code`, text): The code the customer gives to claim loyalty. Lightspeed makes one if left empty.
- Customer group (`customer_group_id`, text): The group the customer is in, which can set their prices.
- Birthday (`date_of_birth`, date): The customer's date of birth.
- Gender (`gender`, text): The customer's gender, as Lightspeed records it. One of: `M` (Male), `F` (Female).
- Note (`note`, text): A note about the customer.
- Opted out of email (`do_not_email`, true/false): Whether the customer asked not to get marketing email.
- Street address (`physical_address_1`, text): The first line of the address.
- City (`physical_city`, text): The city.
- State or region (`physical_state`, text): The state, province or region.
- Postcode (`physical_postcode`, text): The postcode or ZIP code.
- Country (`physical_country_id`, text): The two-letter country code, such as US, CA or GB.

**Outputs**

- `customer` (object): The customer

**Example output**

```json
{
  "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 ID (`product_id`, text, required): The product's id, from 'List products', 'Create product' or a trigger.
- Price before tax (`price_excluding_tax`, number): The retail price before tax, such as 19.99. At least 0.
- Price including tax (`price_including_tax`, number): The retail price with tax, for stores that show tax-inclusive prices. At least 0.
- Loyalty amount (`loyalty_amount`, number): The loyalty a customer earns buying one. At least 0.
- Sold in store (`active_in_store`, text): Whether the product can be sold in store. One of: `true` (Yes), `false` (No).

**Outputs**

- `family` (object): Its product family: name, description, brand
- `name` (text): The product's name
- `product` (object): The product

**Example output**

```json
{
  "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**

- Supplier (`supplier_id`, text, required): The supplier. Pick one, or give its id from an earlier step.
- Name (`name`, text): A new name. Leave empty to keep it.
- Description (`description`, text): A description of the supplier.
- Default markup (`default_markup`, number): The markup you usually apply to this supplier's products, as a percentage. Lightspeed only records it.
- Company (`company_name`, text): The supplier's company name.
- Contact first name (`first_name`, text): Your contact's first name.
- Contact last name (`last_name`, text): Your contact's last name.
- Email (`email`, text): The supplier's email address.
- Phone (`phone`, text): The supplier's phone number.
- Mobile (`mobile`, text): The supplier's mobile number.
- Website (`website`, text): The supplier's website.

**Outputs**

- `supplier` (object): The supplier
- `supplier_id` (text): The supplier's id

**Example output**

```json
{
  "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"
}
```
