Customer Address Base

CommercePoint-of-SaleRetailRestaurantInventoryLoyaltyPaymentsE-CommerceOmnichannelCanada

Properties

Name	Type	Description
address_line_1	string	Primary address line (street address, P.O. box, etc.).
address_line_2	stringnull	Secondary address line (apartment, suite, unit, building, floor, etc.).
city	string	City or town name.
country_code	string	ISO 3166-1 alpha-2 country code (e.g., US, NZ, AU).
postcode	string	Postal code or ZIP code.
state	stringnull	State, province, or region name.
state_code	stringnull	State or province code. Required for US and CA.
suburb	stringnull	Suburb or district.
type	string	The type of address.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-customer-address-base-schema.json",
  "title": "Customer Address Base",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lightspeed-customer-addresses-api-openapi.yml#/components/schemas/CustomerAddressBase",
  "properties": {
    "address_line_1": {
      "description": "Primary address line (street address, P.O. box, etc.).",
      "maxLength": 50,
      "type": "string"
    },
    "address_line_2": {
      "description": "Secondary address line (apartment, suite, unit, building, floor, etc.).",
      "maxLength": 50,
      "type": [
        "string",
        "null"
      ]
    },
    "city": {
      "description": "City or town name.",
      "maxLength": 28,
      "type": "string"
    },
    "country_code": {
      "description": "ISO 3166-1 alpha-2 country code (e.g., US, NZ, AU).",
      "type": "string"
    },
    "postcode": {
      "description": "Postal code or ZIP code.",
      "type": "string"
    },
    "state": {
      "description": "State, province, or region name.",
      "maxLength": 35,
      "type": [
        "string",
        "null"
      ]
    },
    "state_code": {
      "description": "State or province code. Required for US and CA.",
      "type": [
        "string",
        "null"
      ]
    },
    "suburb": {
      "description": "Suburb or district.",
      "type": [
        "string",
        "null"
      ]
    },
    "type": {
      "description": "The type of address.",
      "enum": [
        "BILLING",
        "SHIPPING"
      ],
      "type": "string"
    }
  },
  "required": [
    "address_line_1",
    "city",
    "postcode",
    "country_code",
    "type"
  ],
  "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-address-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.