Otter · JSON Structure

Public Api Required Person Structure

Details about the customer who placed the order.

Type: object Properties: 5
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

name phone phoneCode email personalIdentifiers

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/otter/refs/heads/main/json-structure/public-api-required-person-structure.json",
  "name": "RequiredPerson",
  "description": "Details about the customer who placed the order.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "description": "The person's name as it should be displayed.",
      "example": "Jane Doe",
      "maxLength": 255
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "description": "The person's phone number.",
      "example": "+1-555-555-5555",
      "maxLength": 25
    },
    "phoneCode": {
      "type": "string",
      "nullable": true,
      "description": "A code or extension of the phone number.",
      "example": "111 11 111",
      "maxLength": 25
    },
    "email": {
      "type": "string",
      "nullable": true,
      "description": "The person's email address.",
      "example": "email@email.com"
    },
    "personalIdentifiers": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-personal-identifiers-schema.json"
    }
  }
}