Lightspeed Commerce · Schema

Customer Base

CommercePoint-of-SaleRetailRestaurantInventoryLoyaltyPaymentsE-CommerceOmnichannelCanada

Properties

Name Type Description
company_name stringnull Company name.
custom_field_1 stringnull Custom field 1. Can be used to store random data.
custom_field_2 stringnull Custom field 2.
custom_field_3 stringnull Custom field 3.
custom_field_4 stringnull Custom field 4.
customer_code string Customer code used for claiming loyalty.
customer_group_id string Customer group ID.
date_of_birth string Birthday.
do_not_email boolean Indicates whether the customer opted out of email communications.
email stringnull Customer's email address.
enable_loyalty boolean
enable_promotional_sms boolean Indicates whether the customer opted in to SMS communications.
fax stringnull Fax no.
first_name stringnull Customer's first name.
gender stringnull Customer's gender. Can be `M`, `F` or null.
last_name stringnull Customer 's last name.
mobile stringnull Mobile phone no.
note stringnull Customer note.
on_account_limit numbernull Customer's OnAccount Limit.
phone stringnull Phone no.
physical_address_1 stringnull Physical address, line 1.
physical_address_2 stringnull Physical address, line 2.
physical_city stringnull Physical address, city.
physical_country_id stringnull Physical address, country code.
physical_postcode stringnull Physical address, post code.
physical_state stringnull Physical address, state.
physical_suburb stringnull Physical address, suburb.
postal_address_1 stringnull Postal address, line 1.
postal_address_2 stringnull Postal address, line 2.
postal_city stringnull Postal address, city.
postal_country_id stringnull Postal address, country code.
postal_postcode stringnull Postal address, post code.
postal_state stringnull Postal address, state.
postal_suburb stringnull Postal address, suburb.
tax_id stringnull Customer's tax ID.
twitter stringnull Twitter handle.
website stringnull Website URL.
View JSON Schema on GitHub

JSON Schema

lightspeed-customer-base-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-customer-base-schema.json",
  "title": "Customer Base",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lightspeed-customers-api-openapi.yml#/components/schemas/CustomerBase",
  "properties": {
    "company_name": {
      "description": "Company name.",
      "type": [
        "string",
        "null"
      ]
    },
    "custom_field_1": {
      "description": "Custom field 1. Can be used to store random data.",
      "type": [
        "string",
        "null"
      ]
    },
    "custom_field_2": {
      "description": "Custom field 2.",
      "type": [
        "string",
        "null"
      ]
    },
    "custom_field_3": {
      "description": "Custom field 3.",
      "type": [
        "string",
        "null"
      ]
    },
    "custom_field_4": {
      "description": "Custom field 4.",
      "type": [
        "string",
        "null"
      ]
    },
    "customer_code": {
      "description": "Customer code used for claiming loyalty.",
      "type": "string"
    },
    "customer_group_id": {
      "description": "Customer group ID.",
      "type": "string"
    },
    "date_of_birth": {
      "description": "Birthday.",
      "type": "string"
    },
    "do_not_email": {
      "default": false,
      "description": "Indicates whether the customer opted out of email communications.",
      "type": "boolean"
    },
    "email": {
      "description": "Customer's email address.",
      "type": [
        "string",
        "null"
      ]
    },
    "enable_loyalty": {
      "type": "boolean"
    },
    "enable_promotional_sms": {
      "default": false,
      "description": "Indicates whether the customer opted in to SMS communications.",
      "type": "boolean"
    },
    "fax": {
      "description": "Fax no.",
      "type": [
        "string",
        "null"
      ]
    },
    "first_name": {
      "description": "Customer's first name.",
      "type": [
        "string",
        "null"
      ]
    },
    "gender": {
      "description": "Customer's gender. Can be `M`, `F` or null.",
      "type": [
        "string",
        "null"
      ]
    },
    "last_name": {
      "description": "Customer 's last name.",
      "type": [
        "string",
        "null"
      ]
    },
    "mobile": {
      "description": "Mobile phone no.",
      "type": [
        "string",
        "null"
      ]
    },
    "note": {
      "description": "Customer note.",
      "type": [
        "string",
        "null"
      ]
    },
    "on_account_limit": {
      "description": "Customer's OnAccount Limit.",
      "format": "double",
      "type": [
        "number",
        "null"
      ]
    },
    "phone": {
      "description": "Phone no.",
      "type": [
        "string",
        "null"
      ]
    },
    "physical_address_1": {
      "description": "Physical address, line 1.",
      "type": [
        "string",
        "null"
      ]
    },
    "physical_address_2": {
      "description": "Physical address, line 2.",
      "type": [
        "string",
        "null"
      ]
    },
    "physical_city": {
      "description": "Physical address, city.",
      "type": [
        "string",
        "null"
      ]
    },
    "physical_country_id": {
      "description": "Physical address, country code.",
      "type": [
        "string",
        "null"
      ]
    },
    "physical_postcode": {
      "description": "Physical address, post code.",
      "type": [
        "string",
        "null"
      ]
    },
    "physical_state": {
      "description": "Physical address, state.",
      "type": [
        "string",
        "null"
      ]
    },
    "physical_suburb": {
      "description": "Physical address, suburb.",
      "type": [
        "string",
        "null"
      ]
    },
    "postal_address_1": {
      "description": "Postal address, line 1.",
      "type": [
        "string",
        "null"
      ]
    },
    "postal_address_2": {
      "description": "Postal address, line 2.",
      "type": [
        "string",
        "null"
      ]
    },
    "postal_city": {
      "description": "Postal address, city.",
      "type": [
        "string",
        "null"
      ]
    },
    "postal_country_id": {
      "description": "Postal address, country code.",
      "type": [
        "string",
        "null"
      ]
    },
    "postal_postcode": {
      "description": "Postal address, post code.",
      "type": [
        "string",
        "null"
      ]
    },
    "postal_state": {
      "description": "Postal address, state.",
      "type": [
        "string",
        "null"
      ]
    },
    "postal_suburb": {
      "description": "Postal address, suburb.",
      "type": [
        "string",
        "null"
      ]
    },
    "tax_id": {
      "description": "Customer's tax ID.",
      "type": [
        "string",
        "null"
      ]
    },
    "twitter": {
      "description": "Twitter handle.",
      "type": [
        "string",
        "null"
      ]
    },
    "website": {
      "description": "Website URL.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "first_name",
    "last_name"
  ],
  "type": "object"
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema 
curl "https://apis.io/api/v1/json-schemas/lightspeed-customer-base"
All schemas 
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.