Otter · Schema

RequiredAddress

Address.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name	Type	Description
fullAddress	string	Full, human comprehensible address. It is usually formatted in the order appropriate for your locale. Currently only populated for cases in which only single-line address is available.
postalCode	string	Postal code of the address.
city	string	The city/town portion of the address.
state	string	Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, or a prefecture.
countryCode	string	CLDR country code. See http://cldr.unicode.org/
addressLines	array	Address lines (e.g. street, PO Box, or company name) or the full single line address (e.g. street, city, state, country, zip).
linesOfAddress	array	Deprecated: use addressLines. Address lines (e.g. street, PO Box, or company name) or the full single line address (e.g. street, city, state, country, zip).
location	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "RequiredAddress",
  "description": "Address.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-required-address-schema.json",
  "type": "object",
  "properties": {
    "fullAddress": {
      "type": "string",
      "nullable": true,
      "description": "Full, human comprehensible address. It is usually formatted in the order appropriate for your locale. Currently only populated for cases in which only single-line address is available.",
      "example": "123 Sample Street Ste 100, San Francisco, CA 94103"
    },
    "postalCode": {
      "type": "string",
      "description": "Postal code of the address.",
      "example": "20500"
    },
    "city": {
      "type": "string",
      "description": "The city/town portion of the address.",
      "example": "Washington"
    },
    "state": {
      "type": "string",
      "description": "Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, or a prefecture.",
      "example": "DC"
    },
    "countryCode": {
      "type": "string",
      "description": "CLDR country code. See http://cldr.unicode.org/",
      "example": "US"
    },
    "addressLines": {
      "type": "array",
      "nullable": true,
      "description": "Address lines (e.g. street, PO Box, or company name) or the full single line address (e.g. street, city, state, country, zip).",
      "example": [
        "1600 Pennsylvania Avenue NW",
        "123 Sample Street Ste 100, San Francisco, CA 94103"
      ],
      "items": {
        "type": "string"
      }
    },
    "linesOfAddress": {
      "type": "array",
      "nullable": true,
      "deprecated": true,
      "description": "Deprecated: use addressLines. Address lines (e.g. street, PO Box, or company name) or the full single line address (e.g. street, city, state, country, zip).",
      "example": [
        "1600 Pennsylvania Avenue NW",
        "123 Sample Street Ste 100, San Francisco, CA 94103"
      ],
      "items": {
        "type": "string"
      }
    },
    "location": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-location-schema.json"
    }
  }
}