Lightspeed Restaurant

App · 13 actions

Read your Lightspeed Restaurant (K-Series) sales, receipts, sales totals and card payments, and list, create and update menu items.

Actions

ActionWhat it does
Create itemAdd an item to a location's catalogue with its price and accounting group.
Find receipt by outside referenceFind the receipt that matches a reference from another system, such as an online order's number.
Get itemGet one item with its prices, accounting group, the locations it is shared with and the menus and screens it is on.
Get sales totalsTotal a location's sales, tax, discounts and service charges, grouped by staff member, device, tag or accounting group, for a business day or a period.
List a business day's salesList every sale of one business day at a location, and whether Lightspeed has all of that day's data yet.
List accounting groupsList a location's accounting groups, the categories its items' sales are reported under, such as Food or Drinks.
List businesses and locationsList the businesses your Lightspeed sign-in reaches and each restaurant location, with its id, country and time zone.
List card paymentsList a location's Lightspeed Payments card payments in a period, with their status and the fees and surcharges on each.
List itemsList a location's menu items, or find them by name, SKU or accounting group.
List payment methodsList the ways a location takes payment, such as cash or card.
List salesList the sales a location closed in a period, with what was sold and how it was paid.
List tax ratesList a location's tax rates, with their codes and rates.
Update itemChange an item's name, price, SKU or other details, or archive it by turning Active off.

Create item

Add an item to a location's catalogue with its price and accounting group. It shows on a menu once it is placed on one in Lightspeed.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
Item nameitem_nametextRequired
The item's name, as the menu shows it.
Accounting groupaccounting_group_idtextRequired
The accounting group the item's sales count towards.
Default pricedefault_pricenumberRequired
The item's price, in the business's currency.At least 0.
Docket namedocket_nametext
The name printed on kitchen dockets.
SKUskutext
The item's stock code, up to 32 characters.
Activeactivetrue/false
On to show the item on the menu, off to archive it.
Barcodebarcodetext
The item's barcode.
Cost pricecost_pricenumber
What the item costs you.At least 0.
Price modeprice_modetext
How the price is set.One of: AMOUNT (Fixed amount), PERCENT (Percentage), POSITIVE_OPEN_PRICE (Open price), NEGATIVE_OPEN_PRICE (Open price, negative).

Outputs

itemobject
The item
Example output
{
  "item": {
    "accountingGroup": {
      "id": 40570261078058,
      "name": "Food"
    },
    "active": true,
    "barcode": "00000001",
    "costPrice": 3.5,
    "docketName": "Cheeseburger",
    "id": 3012455645,
    "itemType": "ITEM",
    "name": "Cheeseburger",
    "priceMode": "AMOUNT",
    "prices": [
      {
        "amount": 10.0,
        "name": "Default"
      }
    ],
    "sharingType": "LOCAL",
    "sku": "BURGER-01"
  }
}

Find receipt by outside reference

Find the receipt that matches a reference from another system, such as an online order's number.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
External referenceexternal_reference_idtextRequired
The other system's reference for the receipt, as the sale's external references show it.

Outputs

receiptobject
The receipt
Example output
{
  "receipt": {
    "accountFiscId": "A65315.17",
    "accountReference": "57X0j3hzTZ2oo9sdVWiUog==",
    "cancelled": false,
    "externalFiscalNumber": "ORDER-1042",
    "payments": [
      {
        "code": "CASH",
        "currency": "GBP",
        "description": "Cash",
        "fiscDate": "2026-11-05T20:04:08.665Z",
        "netAmountWithTax": "11.00",
        "tip": "0.00"
      }
    ],
    "receiptId": "R65315.13",
    "salesLines": [
      {
        "currency": "GBP",
        "discountAmount": "0.00",
        "id": "S65315.33",
        "name": "Burger",
        "quantity": "1.000",
        "sku": "52",
        "staffName": "Manager",
        "taxAmount": "1.83",
        "timeOfSale": "2026-11-05T19:58:22.474Z",
        "totalNetAmountWithTax": "11.00",
        "totalNetAmountWithoutTax": "9.17"
      }
    ],
    "type": "SALE"
  }
}

Get item

Get one item with its prices, accounting group, the locations it is shared with and the menus and screens it is on.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
Itemitem_idtextRequired
The item. Pick one, or give its id from 'List items' or an earlier step.

Outputs

itemobject
The item
Example output
{
  "item": {
    "accountingGroup": {
      "id": 40570261078058,
      "name": "Food"
    },
    "active": true,
    "barcode": "00000001",
    "costPrice": 3.5,
    "docketName": "Cheeseburger",
    "id": 3012455645,
    "itemType": "ITEM",
    "menuPlacements": [
      {
        "buttonName": "Cheeseburger",
        "menuId": 101,
        "menuName": "Main Menu",
        "screenId": 42,
        "screenName": "Mains"
      }
    ],
    "name": "Cheeseburger",
    "priceMode": "AMOUNT",
    "prices": [
      {
        "amount": 10.0,
        "name": "Default"
      }
    ],
    "sharedLocations": [
      45454565682155
    ],
    "sharingType": "LOCAL",
    "sku": "BURGER-01"
  }
}

Get sales totals

Total a location's sales, tax, discounts and service charges, grouped by staff member, device, tag or accounting group, for a business day or a period. Leave both empty for today.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
Group bygroup_bylistRequired
What to total by. Several nest in the order picked.One or more of: staff (Staff member), device (Device name), deviceId (Device ID), tag, accountingGroup (Accounting group), statisticGroup (Statistic group).
Business daybusiness_datedate
One business day. Leave empty to give From and To instead.
Fromfrom_timedate and time
The start of the period, given with To.
Toto_timedate and time
The end of the period, given with From.
Flattenflattenedtrue/false
On to get the groups as one flat list rather than nested.

Outputs

reportobject
The totals, nested in the order of the groups chosen
Example output
{
  "report": {
    "businessName": "Harbour Kitchen",
    "children": [],
    "dataComplete": true,
    "groupByKey": "staff",
    "groupByValue": "Manager",
    "nextStartOfDayAsIso8601": "2026-11-06T05:30:00Z",
    "numberOfSales": 3,
    "serviceCharge": "0.00",
    "totalAmount": "28.00",
    "totalDiscountedAmount": "0.00",
    "totalTaxAmount": "4.19"
  }
}

List a business day's sales

List every sale of one business day at a location, and whether Lightspeed has all of that day's data yet.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
Business daybusiness_datedateRequired
The business day, in the location's own time zone.
Includeincludelist
Extra details to add to each sale, such as its payments or the staff member. Leave empty for the sale and its lines only.One or more of: payments, staff, table, consumer (Customer), revenue_center (Revenue center), account_profile (Order profile), payment_authorization (Payment authorization).

Outputs

countnumber
How many came back
data_completetrue/false
Whether the day's data is complete
next_start_of_daytext
When the next business day starts
saleslist
The day's sales
Example output
{
  "count": 1,
  "data_complete": true,
  "next_start_of_day": "2026-11-06T05:30:00Z",
  "sales": [
    {
      "accountFiscId": "A65315.17",
      "accountReference": "57X0j3hzTZ2oo9sdVWiUog==",
      "cancelled": false,
      "dineIn": true,
      "nbCovers": 2,
      "ownerName": "Manager",
      "payments": [
        {
          "code": "CASH",
          "currency": "GBP",
          "description": "Cash",
          "fiscDate": "2026-11-05T20:04:08.665Z",
          "netAmountWithTax": "11.00",
          "tip": "0.00"
        }
      ],
      "receiptId": "R65315.13",
      "salesLines": [
        {
          "currency": "GBP",
          "discountAmount": "0.00",
          "id": "S65315.33",
          "name": "Burger",
          "quantity": "1.000",
          "sku": "52",
          "staffName": "Manager",
          "taxAmount": "1.83",
          "timeOfSale": "2026-11-05T19:58:22.474Z",
          "totalNetAmountWithTax": "11.00",
          "totalNetAmountWithoutTax": "9.17"
        }
      ],
      "tableName": "Dining Room, Table 1",
      "tableNumber": "1",
      "timeClosed": "2026-11-05T20:04:08.734Z",
      "timeOfOpening": "2026-11-05T19:58:48.224Z",
      "type": "SALE"
    }
  ]
}

List accounting groups

List a location's accounting groups, the categories its items' sales are reported under, such as Food or Drinks.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.

Outputs

accounting_groupslist
The accounting groups
countnumber
How many came back
Example output
{
  "accounting_groups": [
    {
      "accountingGroupId": 1234567890,
      "code": "fd",
      "name": "Food",
      "statisticGroup": "Food"
    }
  ],
  "count": 1
}

List businesses and locations

List the businesses your Lightspeed sign-in reaches and each restaurant location, with its id, country and time zone.

Inputs

None.

Outputs

businesseslist
The businesses
countnumber
How many locations
locationslist
Every location, one row each
Example output
{
  "businesses": [
    {
      "businessId": 1234,
      "businessLocations": [
        {
          "blID": 45454565682155,
          "blName": "Harbour Kitchen Soho",
          "country": "GB",
          "timezone": "Europe/London"
        }
      ],
      "businessName": "Harbour Kitchen",
      "currencyCode": "GBP"
    }
  ],
  "count": 1,
  "locations": [
    {
      "business_id": 1234,
      "business_name": "Harbour Kitchen",
      "country": "GB",
      "currency_code": "GBP",
      "location_id": "45454565682155",
      "location_name": "Harbour Kitchen Soho",
      "timezone": "Europe/London"
    }
  ]
}

List card payments

List a location's Lightspeed Payments card payments in a period, with their status and the fees and surcharges on each. Gets one page; to see more, run it again with the next offset it gives.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
Fromfrom_timedate and timeRequired
The start of the period, at most 365 days before To.
Toto_timedate and time
The end of the period. Leave empty for now.
Date to filter ondate_typetext
Whether the period is when payments were made or last changed.One of: MODIFIED (Last changed (default)), CREATED.
Statusesstatuseslist
Only payments in these states. Leave empty for all.One or more of: CAPTURED, DISPUTED, PARTIALLY_REFUNDED (Partially refunded), REFUNDED.
Ordersort_directiontext
Oldest or newest first.One of: ASC (Oldest first (default)), DESC (Newest first).
Page sizepage_sizenumber
How many to return, 1 to 100. Lightspeed's default is 50.From 1 to 100.
Offsetoffsetnumber
The next offset from an earlier run, to get the page after it.At least 0.

Outputs

countnumber
How many came back
next_offsetnumber
Give this to the next run for the next page; empty on the last page
paymentslist
The payments
Example output
{
  "count": 1,
  "next_offset": 50,
  "payments": [
    {
      "accountFiscId": "A72691.8",
      "captureDate": "2026-11-05T10:11:56Z",
      "createdDate": "2026-11-05T10:11:56Z",
      "fees": {
        "currency": "GBP",
        "value": "0.25"
      },
      "lightspeedPaymentId": "ad-GJ33PFSCGVG4NFH4",
      "modificationDate": "2026-11-05T10:11:56Z",
      "reference": "RFOOVMIMPSDY",
      "status": "CAPTURED",
      "surcharge": {
        "currency": "GBP",
        "value": "0.00"
      },
      "uuid": "bc7i2X_CTkeg8qlec66wmg=="
    }
  ]
}

List items

List a location's menu items, or find them by name, SKU or accounting group. Gets one page; to see more, run it again with the next offset it gives.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
Item nameitem_nametext
Only items with this name.
SKUskutext
Only the item with this SKU.
Accounting groupaccounting_group_idtext
Only items in this accounting group.
Offsetoffsetnumber
How many items to skip: the next offset from an earlier run.At least 0.
How manyamountnumber
How many items to return, 1 to 1000. Defaults to 100.From 1 to 1000.

Outputs

countnumber
How many came back
itemslist
The items
next_offsetnumber
Give this to the next run for the next page; empty on the last page
Example output
{
  "count": 1,
  "items": [
    {
      "accountingGroup": {
        "id": 40570261078058,
        "name": "Food"
      },
      "active": true,
      "barcode": "00000001",
      "costPrice": 3.5,
      "docketName": "Cheeseburger",
      "id": 3012455645,
      "itemType": "ITEM",
      "name": "Cheeseburger",
      "priceMode": "AMOUNT",
      "prices": [
        {
          "amount": 10.0,
          "name": "Default"
        }
      ],
      "sharingType": "LOCAL",
      "sku": "BURGER-01"
    }
  ],
  "next_offset": null
}

List payment methods

List the ways a location takes payment, such as cash or card.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many came back
payment_methodslist
The payment methods
Example output
{
  "count": 1,
  "payment_methods": [
    {
      "accountingReference": "cash-payment",
      "code": "CASH",
      "name": "Cash",
      "pmId": 1234567890
    }
  ]
}

List sales

List the sales a location closed in a period, with what was sold and how it was paid. Gets one page of up to 100; to see more, run it again with the next page token it gives.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
Fromfrom_timedate and timeRequired
The start of the period. It can be at most 365 days before To.
Toto_timedate and time
The end of the period. Leave empty for now.
Includeincludelist
Extra details to add to each sale, such as its payments or the staff member. Leave empty for the sale and its lines only.One or more of: payments, staff, table, consumer (Customer), revenue_center (Revenue center), account_profile (Order profile), payment_authorization (Payment authorization).
Page sizepage_sizenumber
How many to return, 1 to 100. Lightspeed's default is 50.From 1 to 100.
Next page tokennext_page_tokentext
The next page token from an earlier run, to get the page after it.

Outputs

countnumber
How many came back
next_page_tokentext
Give this to the next run to get the next page; empty on the last page
saleslist
The sales
Example output
{
  "count": 1,
  "next_page_token": "",
  "sales": [
    {
      "accountFiscId": "A65315.17",
      "accountReference": "57X0j3hzTZ2oo9sdVWiUog==",
      "cancelled": false,
      "dineIn": true,
      "nbCovers": 2,
      "ownerName": "Manager",
      "payments": [
        {
          "code": "CASH",
          "currency": "GBP",
          "description": "Cash",
          "fiscDate": "2026-11-05T20:04:08.665Z",
          "netAmountWithTax": "11.00",
          "tip": "0.00"
        }
      ],
      "receiptId": "R65315.13",
      "salesLines": [
        {
          "currency": "GBP",
          "discountAmount": "0.00",
          "id": "S65315.33",
          "name": "Burger",
          "quantity": "1.000",
          "sku": "52",
          "staffName": "Manager",
          "taxAmount": "1.83",
          "timeOfSale": "2026-11-05T19:58:22.474Z",
          "totalNetAmountWithTax": "11.00",
          "totalNetAmountWithoutTax": "9.17"
        }
      ],
      "tableName": "Dining Room, Table 1",
      "tableNumber": "1",
      "timeClosed": "2026-11-05T20:04:08.734Z",
      "timeOfOpening": "2026-11-05T19:58:48.224Z",
      "type": "SALE"
    }
  ]
}

List tax rates

List a location's tax rates, with their codes and rates.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.

Outputs

countnumber
How many came back
tax_rateslist
The tax rates
Example output
{
  "count": 1,
  "tax_rates": [
    {
      "accountingReference": "4000",
      "code": "VAT20",
      "description": "VAT 20%",
      "rate": 1.2,
      "taxIncluded": true
    }
  ]
}

Update item

Change an item's name, price, SKU or other details, or archive it by turning Active off. Fields left empty keep their values.

Inputs

Business locationbusiness_location_idtextRequired
The restaurant location. Pick one, or give its id from an earlier step.
Itemitem_idtextRequired
The item. Pick one, or give its id from 'List items' or an earlier step.
Item nameitem_nametext
The item's name, as the menu shows it. Leave empty to keep it.
Accounting groupaccounting_group_idtext
The accounting group the item's sales count towards. Leave empty to keep it.
Default pricedefault_pricenumber
The item's price, in the business's currency. Leave empty to keep it (needed when the item has more than one price).At least 0.
Docket namedocket_nametext
The name printed on kitchen dockets. Leave empty to keep it.
SKUskutext
The item's stock code, up to 32 characters. Leave empty to keep it.
Activeactivetrue/false
On to show the item on the menu, off to archive it. Leave empty to keep it.
Barcodebarcodetext
The item's barcode. Leave empty to keep it.
Cost pricecost_pricenumber
What the item costs you. Leave empty to keep it.At least 0.
Price modeprice_modetext
How the price is set. Leave empty to keep it.One of: AMOUNT (Fixed amount), PERCENT (Percentage), POSITIVE_OPEN_PRICE (Open price), NEGATIVE_OPEN_PRICE (Open price, negative).

Outputs

itemobject
The item
Example output
{
  "item": {
    "accountingGroup": {
      "id": 40570261078058,
      "name": "Food"
    },
    "active": true,
    "barcode": "00000001",
    "costPrice": 3.5,
    "docketName": "Cheeseburger",
    "id": 3012455645,
    "itemType": "ITEM",
    "name": "Cheeseburger",
    "priceMode": "AMOUNT",
    "prices": [
      {
        "amount": 10.0,
        "name": "Default"
      }
    ],
    "sharingType": "LOCAL",
    "sku": "BURGER-01"
  }
}

On this page