Otter · Schema

Person

The recipient information.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
name string The person's name as it should be displayed.
phone string The person's phone number.
phoneCode string A code or extension of the phone number.
email string The person's email address.
personalIdentifiers object
View JSON Schema on GitHub

JSON Schema

public-api-person-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Person",
  "description": "The recipient information.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-person-schema.json",
  "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 protected]"
    },
    "personalIdentifiers": {
      "$ref": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-personal-identifiers-schema.json"
    }
  }
}