Restaurant Brands International · JSON Structure

Channel Customer Structure

Customer personal details

Type: object Properties: 6 Required: 2
Fortune 500FranchisingHospitalityNYSE QSRQuick Service RestaurantsRestaurants

Customer is a JSON Structure definition published by Restaurant Brands International, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id externalReferenceId name username phone email

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/restaurant-brands/refs/heads/main/json-structure/channel-customer-structure.json",
  "name": "Customer",
  "description": "Customer personal details",
  "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": "guest@example.com"
    }
  },
  "required": [
    "name",
    "email"
  ]
}