• distance(required): integer
  The distance in meters between the location and the point defined in the request.
• location(required): array location
  Array of Location objects.

{
    "description":"A search results of locations.",
    "readOnly":true,
    "properties":{
        "distance":{
            "type":"integer",
            "description":"The distance in meters between the location and the point defined in the request."
        },
        "location":{
            "type":"array",
            "description":"Array of Location objects.",
            "items":{
                "$ref":"#/definitions/Location"
            }
        }
    },
    "required":[
        "distance",
        "location"
    ]
}

• Array of: object Location
  Title: Location

  A location represents the places of business within a customer's organization. A location can have one or more revenue centers.

{
    "type":"array",
    "description":"Array of Location objects.",
    "items":{
        "$ref":"#/definitions/Location"
    }
}

• address: object PostalAddress
  Represents a postal address
• consumerName: string
  consumer facing name
• currency: string
  The currency of the location. Pricing displayed on menus from the location are in this currency, and all check operations are in this currency. Currency is presented in

  Example: EUR
• extensions: object ExtensionData
  Additional Properties Allowed: additionalProperties

  Container for extension data
• geoLocation: object GeoLocation
  Coordinate of a location
• languages: array languages
  Array of language culture reference strings configured for the location. First language listed is the default used if a request is made for an undefined language
• locRef(required): string
  The location identifier.

  Example: fdmnh144
• name: string
  The location name.

  Example: Fred Dome Stadium
• notes: string
  additional details
• orgShortName(required): string
  The organization identifier.
• phoneNumber: string
  Associated phone number

  Example: 027410-22583
• posPlatform: object PosPlatform
  Identifies the POS Platform running at the location.
• timezone: object Timezone
  Represents the associated timezone

{
    "title":"Location",
    "description":"A location represents the places of business within a customer's organization. A location can have one or more revenue centers.\n",
    "required":[
        "orgShortName",
        "locRef",
        "platform"
    ],
    "type":"object",
    "properties":{
        "orgShortName":{
            "description":"The organization identifier.",
            "type":"string"
        },
        "locRef":{
            "description":"The location identifier.",
            "example":"fdmnh144",
            "type":"string"
        },
        "name":{
            "description":"The location name.",
            "example":"Fred Dome Stadium",
            "type":"string"
        },
        "currency":{
            "description":"The currency of the location. Pricing displayed on menus from the location are in this currency, and all check operations are in this currency. Currency is presented in \n",
            "example":"EUR",
            "type":"string"
        },
        "languages":{
            "description":"Array of language culture reference strings configured for the location. First language listed is the default used if a request is made for an undefined language\n",
            "example":[
                "en-GB",
                "fr-FR",
                "de-DE"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "timezone":{
            "$ref":"#/definitions/Timezone"
        },
        "phoneNumber":{
            "$ref":"#/definitions/PhoneNumber"
        },
        "address":{
            "$ref":"#/definitions/PostalAddress"
        },
        "geoLocation":{
            "$ref":"#/definitions/GeoLocation"
        },
        "posPlatform":{
            "$ref":"#/definitions/PosPlatform"
        },
        "extensions":{
            "$ref":"#/definitions/ExtensionData"
        },
        "notes":{
            "description":"additional details",
            "type":"string"
        },
        "consumerName":{
            "description":"consumer facing name",
            "type":"string"
        }
    },
    "example":{
        "orgShortName":"tfoinc",
        "locRef":"fdmnh144",
        "name":"Fred Dome Stadium",
        "currency":"USD",
        "languages":[
            "en-GB",
            "fr-FR",
            "de-DE"
        ],
        "timezone":{
            "ianaName":"Europe/London",
            "windowsName":"GMT Standard Time",
            "tzIndex":85
        },
        "address":{
            "addressLine1":"144 W 94th St",
            "addressLine2":"Suite 11F",
            "floor":"42A",
            "locality":"New York",
            "region":"NY",
            "postalCode":"10019",
            "country":"USA",
            "notes":"West Entrance"
        },
        "phoneNumber":"(0030) 0456 343 234",
        "geoLocation":{
            "latitude":40.773188,
            "longitude":-73.994835
        },
        "posPlatform":{
            "name":"Oracle.Simphony",
            "version":"19.2.0.1234"
        }
    }
}

{
    "orgShortName":"tfoinc",
    "locRef":"fdmnh144",
    "name":"Fred Dome Stadium",
    "currency":"USD",
    "languages":[
        "en-GB",
        "fr-FR",
        "de-DE"
    ],
    "timezone":{
        "ianaName":"Europe/London",
        "windowsName":"GMT Standard Time",
        "tzIndex":85
    },
    "address":{
        "addressLine1":"144 W 94th St",
        "addressLine2":"Suite 11F",
        "floor":"42A",
        "locality":"New York",
        "region":"NY",
        "postalCode":"10019",
        "country":"USA",
        "notes":"West Entrance"
    },
    "phoneNumber":"(0030) 0456 343 234",
    "geoLocation":{
        "latitude":40.773188,
        "longitude":-73.994835
    },
    "posPlatform":{
        "name":"Oracle.Simphony",
        "version":"19.2.0.1234"
    }
}

• addressLine1: string
  First line of an address
• addressLine2: string
  Second line of an address
• addressLine3: string
  Third line of an address
• country: string
  name of country, or country code
• floor: string
  The floor in a building.
• locality: string
  city/town/village
• notes: string
  Additional address details
• postalcode: string
  postal code, e.g. ZIP in the US
• region: string
  state/county/province

{
    "description":"Represents a postal address",
    "type":"object",
    "properties":{
        "addressLine1":{
            "description":"First line of an address",
            "type":"string"
        },
        "addressLine2":{
            "description":"Second line of an address",
            "type":"string"
        },
        "addressLine3":{
            "description":"Third line of an address",
            "type":"string"
        },
        "floor":{
            "description":"The floor in a building.",
            "type":"string"
        },
        "locality":{
            "description":"city/town/village",
            "type":"string"
        },
        "region":{
            "description":"state/county/province",
            "type":"string"
        },
        "postalcode":{
            "description":"postal code, e.g. ZIP in the US",
            "type":"string"
        },
        "country":{
            "description":"name of country, or country code",
            "type":"string"
        },
        "notes":{
            "description":"Additional address details",
            "type":"string"
        }
    }
}

• string

{
    "description":"Container for extension data",
    "additionalProperties":{
        "type":"string"
    }
}

• latitude: number
  Minimum Value: -90

  Maximum Value: 90

  WGS84 latitude, in degrees
• longitude: number
  Minimum Value: -180

  Maximum Value: 180

  WGS84 Longitude, in degrees

{
    "type":"object",
    "description":"Coordinate of a location",
    "properties":{
        "latitude":{
            "description":"WGS84 latitude, in degrees",
            "type":"number",
            "minimum":-90,
            "maximum":90
        },
        "longitude":{
            "description":"WGS84 Longitude, in degrees",
            "type":"number",
            "minimum":-180,
            "maximum":180
        }
    }
}

• Array of: string

{
    "description":"Array of language culture reference strings configured for the location. First language listed is the default used if a request is made for an undefined language\n",
    "example":[
        "en-GB",
        "fr-FR",
        "de-DE"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

[
    "en-GB",
    "fr-FR",
    "de-DE"
]

• name(required): string
  Name of the platform
• version(required): string
  Version of the platform

{
    "description":"Identifies the POS Platform running at the location.",
    "type":"object",
    "required":[
        "name",
        "version"
    ],
    "properties":{
        "name":{
            "description":"Name of the platform",
            "type":"string"
        },
        "version":{
            "description":"Version of the platform",
            "type":"string"
        }
    }
}

• ianaName: string
  Name in linux OS system
• tzIndex(required): integer
  The integer representation of the Index column from https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values
• windowsName: string
  Name in windows OS system

{
    "description":"Represents the associated timezone",
    "type":"object",
    "required":[
        "tzIndex"
    ],
    "properties":{
        "ianaName":{
            "description":"Name in linux OS system",
            "type":"string"
        },
        "windowsName":{
            "description":"Name in windows OS system",
            "type":"string"
        },
        "tzIndex":{
            "description":"The integer representation of the Index column from https://support.microsoft.com/en-us/help/973627/microsoft-time-zone-index-values",
            "type":"integer"
        }
    }
}

• details: string
  A human-readable explanation specific to this occurrence of the problem.
• instance: string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
• title: string
  A short, human-readable summary of the problem type.
• type: string
  A URI reference [RFC3986](https://tools.ietf.org/html/rfc3986) that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). \n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Required value not specified.",
        "details":"The OrgShortName value is required.",
        "instance":"required_value_missing"
    },
    "properties":{
        "type":{
            "description":"A URI reference [RFC3986](https://tools.ietf.org/html/rfc3986) that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string"
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string"
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "type":"string"
        }
    }
}

{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}