Flipdish · Schema

LightspeedSettings

Ligthspeed store settings

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
CompanyId string Company Id
UseOAuth boolean Use OAuth for authentication
Enabled boolean Enabled
EstimatedMinutesForDelivery integer Estimated minutes for delivery
EstimatedMinutesForCollection integer Estimated minutes for collection
GeographicLocation string Geographic location (euc1, nae1, euw2, ....))
Establishment boolean Is the CompanyId an establishment (kind of the store of a group of store)
VoucherId string The Lightspeed voucher identifier to map with our
DeliveryFeeId string The Lightspeed delivery fee identifier to map with our
ProcessingFeeId string The Lightspeed processing fee identifier to map with our
PriceType string Which price to choose from Lightspeed menu
MenuId integer The menu id of the store
CollectionTableId integer Collection Table ID to send orders
DeliveryTableId integer Delivery Table ID to send orders
CollectionTableIds object Collection Table IDs to send orders to
DeliveryTableIds object Delivery Table IDs to send orders to
UseTaxInclusivePrices boolean Exclude tax
SkipStatusCheckAndAcceptOrderAfterSending boolean WARNING: only use this option if the Liteserver is not synchronizing within max 5 minutes with Lightspeed cloud!
SendTableNumberToTableId boolean Send Table Number to Table Id
AddChefNoteToProduct boolean Add ChefNote To Product
ChefNoteItemId string The Lightspeed Chef Note Item Id to map
ChefNoteModifierId string The Lightspeed Chef Note Modifier Id to map
ServiceChargeId string The Lightspeed Service Charge Id to map
View JSON Schema on GitHub

JSON Schema

platform-lightspeed-settings-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/platform-lightspeed-settings-schema.json",
  "title": "LightspeedSettings",
  "description": "Ligthspeed store settings",
  "type": "object",
  "properties": {
    "CompanyId": {
      "description": "Company Id",
      "type": "string",
      "example": "500123"
    },
    "UseOAuth": {
      "description": "Use OAuth for authentication",
      "type": "boolean",
      "example": true
    },
    "Enabled": {
      "description": "Enabled",
      "type": "boolean",
      "example": true
    },
    "EstimatedMinutesForDelivery": {
      "format": "int32",
      "description": "Estimated minutes for delivery",
      "type": "integer",
      "example": 1
    },
    "EstimatedMinutesForCollection": {
      "format": "int32",
      "description": "Estimated minutes for collection",
      "type": "integer",
      "example": 1
    },
    "GeographicLocation": {
      "description": "Geographic location (euc1, nae1, euw2, ....))",
      "type": "string",
      "example": "string"
    },
    "Establishment": {
      "description": "Is the CompanyId an establishment (kind of the store of a group of store)",
      "type": "boolean",
      "example": true
    },
    "VoucherId": {
      "description": "The Lightspeed voucher identifier to map with our",
      "type": "string",
      "example": "500123"
    },
    "DeliveryFeeId": {
      "description": "The Lightspeed delivery fee identifier to map with our",
      "type": "string",
      "example": "500123"
    },
    "ProcessingFeeId": {
      "description": "The Lightspeed processing fee identifier to map with our",
      "type": "string",
      "example": "500123"
    },
    "PriceType": {
      "description": "Which price to choose from Lightspeed menu",
      "enum": [
        "Default",
        "Takeaway",
        "Delivery"
      ],
      "type": "string",
      "nullable": true,
      "example": "Default"
    },
    "MenuId": {
      "format": "int32",
      "description": "The menu id of the store",
      "type": "integer",
      "example": 500123
    },
    "CollectionTableId": {
      "format": "int32",
      "description": "Collection Table ID to send orders",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "DeliveryTableId": {
      "format": "int32",
      "description": "Delivery Table ID to send orders",
      "type": "integer",
      "nullable": true,
      "example": 500123
    },
    "CollectionTableIds": {
      "description": "Collection Table IDs to send orders to",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "DeliveryTableIds": {
      "description": "Delivery Table IDs to send orders to",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "UseTaxInclusivePrices": {
      "description": "Exclude tax",
      "type": "boolean",
      "example": true
    },
    "SkipStatusCheckAndAcceptOrderAfterSending": {
      "description": "WARNING: only use this option if the Liteserver is not synchronizing within max 5 minutes with Lightspeed cloud!",
      "type": "boolean",
      "example": true
    },
    "SendTableNumberToTableId": {
      "description": "Send Table Number to Table Id",
      "type": "boolean",
      "example": true
    },
    "AddChefNoteToProduct": {
      "description": "Add ChefNote To Product",
      "type": "boolean",
      "example": true
    },
    "ChefNoteItemId": {
      "description": "The Lightspeed Chef Note Item Id to map",
      "type": "string",
      "example": "500123"
    },
    "ChefNoteModifierId": {
      "description": "The Lightspeed Chef Note Modifier Id to map",
      "type": "string",
      "example": "500123"
    },
    "ServiceChargeId": {
      "description": "The Lightspeed Service Charge Id to map",
      "type": "string",
      "example": "500123"
    }
  }
}