Clover · Schema

Customer

Clover Customer resource. Schema derived from the Clover Platform REST API v3 reference.

RestaurantPOSPaymentsRetailSMBHardware

Properties

Name	Type	Description
id	string	Unique identifier.
merchant	object
firstName	string	First/given name of the customer. Note: Length of first name cannot be more than 64 characters.
lastName	string	Last name/surname of the customer. Note: Length of last name cannot be more than 64 characters.
marketingAllowed	boolean	Indicates if the customer allows receiving of marketing communication.
customerSince	integer	Date of start of customer association with the merchant.
orders	array
addresses	array
emailAddresses	array
phoneNumbers	array
cards	array
metadata	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Customer",
  "description": "Clover Customer resource. Schema derived from the Clover Platform REST API v3 reference.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clover/refs/heads/main/json-schema/platform-rest-api-customer-schema.json",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier.",
      "example": "9ABCDEF1234567"
    },
    "merchant": {
      "type": "object",
      "example": {}
    },
    "firstName": {
      "type": "string",
      "description": "First/given name of the customer. Note: Length of first name cannot be more than 64 characters.",
      "example": "Example firstName"
    },
    "lastName": {
      "type": "string",
      "description": "Last name/surname of the customer. Note: Length of last name cannot be more than 64 characters.",
      "example": "Example lastName"
    },
    "marketingAllowed": {
      "type": "boolean",
      "description": "Indicates if the customer allows receiving of marketing communication.",
      "example": true
    },
    "customerSince": {
      "type": "integer",
      "format": "int64",
      "description": "Date of start of customer association with the merchant.",
      "example": 1718153645000
    },
    "orders": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "example": []
    },
    "addresses": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "example": []
    },
    "emailAddresses": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "example": []
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "example": []
    },
    "cards": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "example": []
    },
    "metadata": {
      "type": "object",
      "example": {}
    }
  }
}