Flipdish · Schema

LocationArea_Location

Representation of a Location i.e: (Table, Hotel Room, Car Park, etc )

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name	Type	Description
LocationId	integer	Id of the Location
LocationName	string	Name of the Location
DisplayOrder	integer	The order that the Location should be displayed on the screen
ExternalLocationId	string	Id of the Location on an external system
IsDeleted	boolean	Shows if the Location is deleted or not

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-schema/stores-location-area-location-schema.json",
  "title": "LocationArea_Location",
  "description": "Representation of a Location i.e: (Table, Hotel Room, Car Park, etc )",
  "type": "object",
  "properties": {
    "LocationId": {
      "format": "int32",
      "description": "Id of the Location",
      "type": "integer",
      "example": 500123
    },
    "LocationName": {
      "description": "Name of the Location",
      "type": "string",
      "example": "Example Name"
    },
    "DisplayOrder": {
      "format": "int32",
      "description": "The order that the Location should be displayed on the screen",
      "type": "integer",
      "example": 1
    },
    "ExternalLocationId": {
      "description": "Id of the Location on an external system",
      "type": "string",
      "example": "500123"
    },
    "IsDeleted": {
      "description": "Shows if the Location is deleted or not",
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "LocationId",
    "LocationName",
    "DisplayOrder"
  ]
}