Flipdish · Schema

CreateLocation

Input model for creating a Location

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
LocationId integer Location Id
LocationName string Descriptive LocationArea name
DisplayOrder integer The order that the Location should be displayed on the screen
ExternalLocationId string Id of the Location on an external system
View JSON Schema on GitHub

JSON Schema

stores-create-location-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/stores-create-location-schema.json",
  "title": "CreateLocation",
  "description": "Input model for creating a Location",
  "type": "object",
  "properties": {
    "LocationId": {
      "format": "int32",
      "description": "Location Id",
      "type": "integer",
      "example": 500123
    },
    "LocationName": {
      "description": "Descriptive LocationArea name",
      "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"
    }
  }
}