Lightspeed Restaurant K Series API
1.0.0

Lightspeed Restaurant offers a REST API in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

These services are in continuous development and subject to change. Find our versioning policy here.

This is the documentation for version 1.0.0 of the API. Last update on May 1, 2024.

Base URL 
https://api.trial.lsk.lightspeed.app

Get Aggregated Sales

GET /f/finance/{businessLocationId}/aggregatedSales
OAuth2

Get sales for the current business day or the specified date range, aggregated by one or more values. The values are specified in the groupBy parameter and are nested in the order provided in the request.

Path parameters

Query parameters

  • date string(date)

    The date in YYYY-MM-DD format

  • from string(date-time)

    Start of requested results, in ISO 8601 format

    Example:2022-09-21T10:11:56Z or 2022-09-21T06:11:56-04:00

  • to string(date-time)

    End of requested results, in ISO 8601 format

    Example:2022-09-21T10:11:56Z or 2022-09-21T06:11:56-04:00

  • flattened boolean

    Default value is false.

  • groupBy string Required

    Comma-separated list of parameters to group the results by. The allowed values are: staff, device, deviceId, tag, accountingGroup, and statisticGroup. For example, groupBy can be set to staff,device.

    Minimum length is 3, maximum length is 2147483647.

Responses

  • • 200 application/json

    Aggregated sales returned

    Hide response attributes Show response attributes object
    • groupByKey string

      The groupBy parameter provided

    • groupByValue string

      The value that corresponds to the groupBy parameter

    • totalAmount string

      The aggregated total of sales for this data set (ex. staff: manager)

    • serviceCharge string

      The aggregated total of service charges for this data set (ex. staff: manager)

    • totalDiscountedAmount string

      The aggregated total of discounts for this data set (ex. staff: manager)

    • totalTaxAmount string

      The aggregated tax total for this data set (ex. staff: manager)

    • numberOfSales number

      The total number of sale lines for this data set (ex. staff: manager)

    • children array[object]
      Hide children attributes Show children attributes object
      • groupByKey string

        The second groupBy parameter provided, if applicable. The parameters will be nested based on the order provided. For example, staff,device will show totals for each staff value, and then those totals broken down by device.

      • children array[object]
        Hide children attributes Show children attributes object
        • groupByValue string

          The value that corresponds to the second groupBy parameter provided

        • totalAmount string

          The aggregated total of sales for this nested data set (ex. staff:manager -> device: iPad7)

        • serviceCharge string

          The aggregated total of service charges for this nested data set (ex. staff:manager -> device: iPad7)

        • totalDiscountedAmount string

          The aggregated total of discounts for this nested data set (ex. staff:manager -> device: iPad7)

        • totalTaxAmount string

          The aggregated tax total for this nested data set (ex. staff:manager -> device: iPad7)

        • numberOfSales number

          The total number of sales for this nested data set (ex. staff:manager -> device: iPad7)

        • children array[object]
          Hide children attributes Show children attributes object
          • groupByKey string
          • children array[object]

            This would continue with as many nested data sets as specified by the groupBy parameters

    • nextStartOfDayAsIso8601 string
    • dataComplete boolean
    • businessName string
  • • 400 */*

    Bad Request

    Hide response attributes Show response attributes object
GET /f/finance/{businessLocationId}/aggregatedSales 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/f/finance/45454565682155/aggregatedSales?groupBy=string \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "groupByKey": "staff",
  "groupByValue": "manager",
  "totalAmount": "47.00",
  "serviceCharge": "0.00",
  "totalDiscountedAmount": "0.00",
  "totalTaxAmount": "7.04",
  "numberOfSales": 7.0,
  "children": [
    {
      "groupByKey": "device",
      "children": [
        {
          "groupByValue": "iPad7",
          "totalAmount": "28.00",
          "serviceCharge": "0.00",
          "totalDiscountedAmount": "0.00",
          "totalTaxAmount": "4.19",
          "numberOfSales": 3.0,
          "children": [
            {
              "groupByKey": "string",
              "children": [
                {}
              ]
            }
          ]
        }
      ]
    }
  ],
  "nextStartOfDayAsIso8601": "string",
  "dataComplete": true,
  "businessName": "string"
}
Response examples (400) 
{
  "key": {}
}