Otter · JSON Structure

Public Api View Credential Structure

ViewCredential schema from Public API (Otter Public API).

Type: object Properties: 5 Required: 2
RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

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

Properties

key label value inputType selectOptions

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-view-credential-structure.json",
  "name": "ViewCredential",
  "description": "ViewCredential schema from Public API (Otter Public API).",
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "The key of the credential.",
      "example": "userEmail"
    },
    "label": {
      "type": "string",
      "description": "The friendly name of the credential.",
      "example": "User Email"
    },
    "value": {
      "type": "string",
      "description": "The value of the credential. Only returned if the Store ID was provided in the request.",
      "example": "test-user@gmail.com"
    },
    "inputType": {
      "type": "string",
      "description": "The type of input",
      "enum": [
        "TEXT",
        "SELECT",
        "MULTI_SELECT"
      ],
      "default": "TEXT",
      "example": "TEXT"
    },
    "selectOptions": {
      "type": "array",
      "description": "options to select when type is `SELECT` or `MULTI_SELECT`",
      "items": {
        "type": "string"
      }
    }
  },
  "required": [
    "key",
    "label"
  ]
}