Flipdish · JSON Structure

Stores Location Area With Locations Structure

Represents a LocationArea and its Location list

Type: object Properties: 5 Required: 3
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

LocationAreaWithLocations is a JSON Structure definition published by Flipdish, describing 5 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

LocationAreaId StoreId LocationAreaName Locations IsDeleted

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/stores-location-area-with-locations-structure.json",
  "name": "LocationAreaWithLocations",
  "description": "Represents a LocationArea and its Location list",
  "type": "object",
  "properties": {
    "LocationAreaId": {
      "description": "Id of the LocationArea",
      "type": "int32",
      "example": 500123
    },
    "StoreId": {
      "description": "Id of the Store that this LocationArea belongs to",
      "type": "int32",
      "example": 500123
    },
    "LocationAreaName": {
      "description": "Descriptive LocationArea name",
      "type": "string",
      "example": "Example Name"
    },
    "Locations": {
      "description": "List of Locations that belongs to this Location Area",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LocationArea_Location"
      },
      "example": []
    },
    "IsDeleted": {
      "description": "Returns if the LocationArea is deleted or not",
      "type": "boolean",
      "example": true
    }
  },
  "required": [
    "LocationAreaId",
    "StoreId",
    "LocationAreaName"
  ]
}