Lightspeed · Schema

Customer

A customer record.

POSRetailRestaurantEcommerce

Properties

Name Type Description
customerID string Unique customer identifier.
firstName string Customer first name.
lastName string Customer last name.
company string Customer company name.
contactID string Identifier of the related contact record.
discountID string Default discount applied to the customer.
taxCategoryID string Tax category for the customer.
Contact object Contact details associated with a customer.
View JSON Schema on GitHub

JSON Schema

retail-r-series-customer-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Customer",
  "description": "A customer record.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed-pos/refs/heads/main/json-schema/retail-r-series-customer-schema.json",
  "type": "object",
  "properties": {
    "customerID": {
      "type": "string",
      "description": "Unique customer identifier."
    },
    "firstName": {
      "type": "string",
      "description": "Customer first name."
    },
    "lastName": {
      "type": "string",
      "description": "Customer last name."
    },
    "company": {
      "type": "string",
      "description": "Customer company name."
    },
    "contactID": {
      "type": "string",
      "description": "Identifier of the related contact record."
    },
    "discountID": {
      "type": "string",
      "description": "Default discount applied to the customer."
    },
    "taxCategoryID": {
      "type": "string",
      "description": "Tax category for the customer."
    },
    "Contact": {
      "type": "object",
      "description": "Contact details associated with a customer.",
      "properties": {
        "contactID": {
          "type": "string",
          "description": "Unique contact identifier."
        },
        "custom": {
          "type": "string",
          "description": "Custom contact field."
        },
        "noEmail": {
          "type": "boolean",
          "description": "Whether the contact opted out of email."
        },
        "noPhone": {
          "type": "boolean",
          "description": "Whether the contact opted out of phone contact."
        },
        "noMail": {
          "type": "boolean",
          "description": "Whether the contact opted out of mail."
        }
      }
    }
  }
}