Lightspeed · Schema

staff-apiShift

Shift details.

POSRetailRestaurantEcommerce

Properties

Name Type Description
uuid string The unique identifier for the shift.
businessId integer The unique identifier for the business.
businessLocationId integer The unique identifier for the business location.
deviceId integer The unique identifier for the device.
staffId integer The unique identifier for the user.
declaredCashTips string The declared tips for the shift.
dateInUTC string The timestamp of the last update to the shift.
events array List of events during the shift.
View JSON Schema on GitHub

JSON Schema

restaurant-k-series-staff-api-shift-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "staff-apiShift",
  "description": "Shift details.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed-pos/refs/heads/main/json-schema/restaurant-k-series-staff-api-shift-schema.json",
  "type": "object",
  "properties": {
    "uuid": {
      "description": "The unique identifier for the shift.",
      "type": "string",
      "example": "REcdfpCwQJKUR53gdzIk5Q=="
    },
    "businessId": {
      "description": "The unique identifier for the business.",
      "type": "integer",
      "format": "int64",
      "example": 12345
    },
    "businessLocationId": {
      "description": "The unique identifier for the business location.",
      "type": "integer",
      "format": "int64",
      "example": 1234567890
    },
    "deviceId": {
      "description": "The unique identifier for the device.",
      "type": "integer",
      "format": "int64",
      "example": 54321
    },
    "staffId": {
      "description": "The unique identifier for the user.",
      "type": "integer",
      "format": "int64",
      "example": 1234
    },
    "declaredCashTips": {
      "description": "The declared tips for the shift.",
      "type": "string",
      "example": "10.00",
      "multipleOf": 0.01
    },
    "dateInUTC": {
      "description": "The timestamp of the last update to the shift.",
      "type": "string",
      "format": "date-time",
      "example": "2020-01-01T00:00:00Z"
    },
    "events": {
      "description": "List of events during the shift.",
      "type": "array",
      "items": {
        "description": "Shift event such as clock in/out, please use the newest one when multiple events existing with same event type.",
        "type": "object",
        "properties": {
          "uuid": {
            "description": "The unique identifier for the event.",
            "type": "string",
            "example": "REcdfpCwQJKUR53gdzIk5Q=="
          },
          "timestamp": {
            "description": "The time of the event.",
            "type": "string",
            "format": "date-time",
            "example": "2020-01-01T00:00:00Z"
          },
          "createdOn": {
            "description": "The creation time of the event.",
            "type": "string",
            "format": "date-time",
            "example": "2020-01-01T00:00:00Z"
          },
          "eventType": {
            "description": "The type of event.",
            "type": "string",
            "enum": [
              "CLOCK_IN",
              "CLOCK_OUT"
            ]
          }
        }
      }
    }
  }
}