Flipdish · JSON Structure

Stores Store Address Structure

Store address

Type: object Properties: 10
RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

AddressId Coordinates Line1 Postcode City CountryCode DisplayForCustomer AddressFields SingleLineDisplay TwoLinesDisplay

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-store-address-structure.json",
  "name": "StoreAddress",
  "description": "Store address",
  "type": "object",
  "properties": {
    "AddressId": {
      "description": "Address identifier",
      "type": "int32",
      "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"
      ]
    }
  }
}