Customer

Customer personal details

Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Properties

Name Type Description
id string Internal user ID
externalReferenceId object
name string Customers's name. Format will depend on the context (full name, first name and initials, etc)
username string Customer's username in the given context
phone object
email string Customer's email
View JSON Schema on GitHub

JSON Schema

channel-customer-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Customer",
  "description": "Customer personal details",
  "$id": "https://raw.githubusercontent.com/api-evangelist/restaurant-brands/refs/heads/main/json-schema/channel-customer-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Internal user ID",
      "example": "500123"
    },
    "externalReferenceId": {
      "$ref": "#/components/schemas/ExternalReferenceId"
    },
    "name": {
      "type": "string",
      "description": "Customers's name. Format will depend on the context (full name, first name and initials, etc)\n",
      "example": "Whopper"
    },
    "username": {
      "type": "string",
      "description": "Customer's username in the given context",
      "example": "example"
    },
    "phone": {
      "$ref": "#/components/schemas/Phone"
    },
    "email": {
      "type": "string",
      "description": "Customer's email",
      "format": "email",
      "example": "[email protected]"
    }
  },
  "required": [
    "name",
    "email"
  ]
}