Flipdish · Schema

StoreAddress

Store address

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

Properties

Name Type Description
AddressId integer Address identifier
Coordinates object
Line1 string Address line 1
Postcode string Postcode
City string City
CountryCode string Country code (ISO-alpha2)
DisplayForCustomer string Display for customer
AddressFields object Dyanmic field/value pairs, defined by the form assigned to the given country code.
SingleLineDisplay string Single line display i18n, may be empty for not supported countries
TwoLinesDisplay array Two line display i18n, may be empty for not supported countries
View JSON Schema on GitHub

JSON Schema

stores-store-address-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-store-address-schema.json",
  "title": "StoreAddress",
  "description": "Store address",
  "type": "object",
  "properties": {
    "AddressId": {
      "format": "int32",
      "description": "Address identifier",
      "type": "integer",
      "example": 500123
    },
    "Coordinates": {
      "$ref": "#/components/schemas/Coordinates"
    },
    "Line1": {
      "description": "Address line 1",
      "type": "string",
      "example": "string"
    },
    "Postcode": {
      "description": "Postcode",
      "type": "string",
      "example": "string"
    },
    "City": {
      "description": "City",
      "type": "string",
      "example": "string"
    },
    "CountryCode": {
      "description": "Country code (ISO-alpha2)",
      "maxLength": 2,
      "minLength": 0,
      "type": "string",
      "example": "IE"
    },
    "DisplayForCustomer": {
      "description": "Display for customer",
      "type": "string",
      "example": "string"
    },
    "AddressFields": {
      "description": "Dyanmic field/value pairs, defined by the form assigned to the given country code.",
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    },
    "SingleLineDisplay": {
      "description": "Single line display i18n, may be empty for not supported countries",
      "type": "string",
      "example": "string"
    },
    "TwoLinesDisplay": {
      "description": "Two line display i18n, may be empty for not supported countries",
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "string"
      ]
    }
  }
}