Flipdish · JSON Structure

Platform Lightspeed Settings Structure

Ligthspeed store settings

Type: object Properties: 23
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

LightspeedSettings is a JSON Structure definition published by Flipdish, describing 23 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

CompanyId UseOAuth Enabled EstimatedMinutesForDelivery EstimatedMinutesForCollection GeographicLocation Establishment VoucherId DeliveryFeeId ProcessingFeeId PriceType MenuId CollectionTableId DeliveryTableId CollectionTableIds DeliveryTableIds UseTaxInclusivePrices SkipStatusCheckAndAcceptOrderAfterSending SendTableNumberToTableId AddChefNoteToProduct ChefNoteItemId ChefNoteModifierId ServiceChargeId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/platform-lightspeed-settings-structure.json",
  "name": "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": {
      "description": "Estimated minutes for delivery",
      "type": "int32",
      "example": 1
    },
    "EstimatedMinutesForCollection": {
      "description": "Estimated minutes for collection",
      "type": "int32",
      "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": {
      "description": "The menu id of the store",
      "type": "int32",
      "example": 500123
    },
    "CollectionTableId": {
      "description": "Collection Table ID to send orders",
      "type": "int32",
      "nullable": true,
      "example": 500123
    },
    "DeliveryTableId": {
      "description": "Delivery Table ID to send orders",
      "type": "int32",
      "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"
    }
  }
}