Tock · Schema

tockExternalIntegrationAttribute

tockExternalIntegrationAttribute schema from Tock Guest Model

HospitalityReservationsRestaurantsWineriesTicketed EventsTakeoutDeliveryExperiencesDiningAmerican Express

Properties

Name Type Description
businessId string A unique identifier for the business. Used internally by Tock.
patronId string A unique identifier for the patron that will be the same as Patron.id. Used internally by Tock.
type string The name of the external system this attribute originated from.
attribute string The name of the attribute assigned to this guest in the external system.
stringValue string If the attribute value is a string type, this field will be the resulting value of the attribute.
intValue string If the attribute value is a number type, this field will be the resulting value of the attribute.
View JSON Schema on GitHub

JSON Schema

guest-profile-external-integration-attribute-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tock/refs/heads/main/json-schema/guest-profile-external-integration-attribute-schema.json",
  "title": "tockExternalIntegrationAttribute",
  "description": "tockExternalIntegrationAttribute schema from Tock Guest Model",
  "type": "object",
  "properties": {
    "businessId": {
      "type": "string",
      "format": "uint64",
      "description": "A unique identifier for the business. Used internally by Tock."
    },
    "patronId": {
      "type": "string",
      "format": "uint64",
      "description": "A unique identifier for the patron that will be the same as Patron.id. Used internally by Tock."
    },
    "type": {
      "type": "string",
      "description": "The name of the external system this attribute originated from."
    },
    "attribute": {
      "type": "string",
      "description": "The name of the attribute assigned to this guest in the external system."
    },
    "stringValue": {
      "type": "string",
      "description": "If the attribute value is a string type, this field will be the resulting value of the attribute."
    },
    "intValue": {
      "type": "string",
      "description": "If the attribute value is a number type, this field will be the resulting value of the attribute."
    }
  }
}