Flipdish · JSON Structure

Customers User Info Structure

User information

Type: object Properties: 27

RestaurantOnline OrderingMobile AppsPoint of SaleOrdersMenuPaymentsWebhooks

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

Properties

PhoneNumber Email EmailConfirmed PreventFromUsingCards IsUserPhoneNumberBlocked UserWhiteLabels UserId UserName CustomerName HasLoggedIn DisableAppRatingControl GloballyOptedOut CompletedOrderCount CancelledOrderCount OrderTotalValue TsMostRecentOrder TsFirstOrder IsRestaurantUser Installs DeliveryLocations PaymentAccounts LanguageId CurrentLanguageName Languages SalesForceContactId StripeCustomerId UserMonthlyCommissions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/flipdish/refs/heads/main/json-structure/customers-user-info-structure.json",
  "name": "UserInfo",
  "description": "User information",
  "type": "object",
  "properties": {
    "PhoneNumber": {
      "description": "The user's phone number.",
      "type": "string",
      "example": "+353000000000"
    },
    "Email": {
      "description": "The user's email address.",
      "type": "string",
      "example": "owner@example.com"
    },
    "EmailConfirmed": {
      "description": "Indicates if the user's email address has been confirmed.",
      "type": "boolean",
      "example": true
    },
    "PreventFromUsingCards": {
      "description": "Indicates if the user is prevented from using cards.",
      "type": "boolean",
      "example": true
    },
    "IsUserPhoneNumberBlocked": {
      "description": "Indicates if the user's phone number is blocked.",
      "type": "boolean",
      "example": true
    },
    "UserWhiteLabels": {
      "description": "List of white label information associated with the user.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserWhiteLabelInfo"
      },
      "example": []
    },
    "UserId": {
      "description": "The unique identifier for the user.",
      "type": "int32",
      "example": 500123
    },
    "UserName": {
      "description": "The user's username.",
      "type": "string",
      "example": "Example Name"
    },
    "CustomerName": {
      "description": "The customer's name.",
      "type": "string",
      "example": "Example Name"
    },
    "HasLoggedIn": {
      "description": "Indicates if the user has logged in.",
      "type": "boolean",
      "example": true
    },
    "DisableAppRatingControl": {
      "description": "Indicates if the app rating control is disabled for the user.",
      "type": "boolean",
      "example": true
    },
    "GloballyOptedOut": {
      "description": "Indicates if the user has globally opted out.",
      "type": "boolean",
      "example": true
    },
    "CompletedOrderCount": {
      "description": "The number of completed orders by the user.",
      "type": "int32",
      "example": 3
    },
    "CancelledOrderCount": {
      "description": "The number of cancelled orders by the user.",
      "type": "int32",
      "example": 3
    },
    "OrderTotalValue": {
      "description": "The total value of orders placed by the user.",
      "type": "double",
      "example": 12.5
    },
    "TsMostRecentOrder": {
      "description": "The timestamp of the user's most recent order.",
      "type": "datetime",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    },
    "TsFirstOrder": {
      "description": "The timestamp of the user's first order.",
      "type": "datetime",
      "nullable": true,
      "example": "2026-06-02T12:00:00Z"
    },
    "IsRestaurantUser": {
      "description": "Indicates if the user is a restaurant user.",
      "type": "boolean",
      "example": true
    },
    "Installs": {
      "description": "List of app installs associated with the user.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AppInstall"
      },
      "example": []
    },
    "DeliveryLocations": {
      "description": "List of delivery locations associated with the user.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DeliveryLocation"
      },
      "example": []
    },
    "PaymentAccounts": {
      "description": "List of payment accounts associated with the user.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PaymentAccount"
      },
      "example": []
    },
    "LanguageId": {
      "description": "The language identifier for the user.",
      "type": "string",
      "example": "500123"
    },
    "CurrentLanguageName": {
      "description": "Current language name for the user.",
      "type": "string",
      "example": "Example Name"
    },
    "Languages": {
      "description": "Available languages that the user can choose from.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Language"
      },
      "example": []
    },
    "SalesForceContactId": {
      "description": "The Salesforce contact ID for the user.",
      "type": "string",
      "example": "500123"
    },
    "StripeCustomerId": {
      "description": "The Stripe customer ID for the user.",
      "type": "string",
      "example": "500123"
    },
    "UserMonthlyCommissions": {
      "description": "User's monthly commissions.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/UserMonthlyCommission"
      },
      "example": []
    }
  }
}