magento · Schema

Customer

A registered customer account in Adobe Commerce.

Properties

Name	Type	Description
id	integer	Numeric customer entity ID.
group_id	integer	ID of the customer group this customer belongs to.
email	string	Customer email address, used as the login identifier.
firstname	string	Customer first name.
lastname	string	Customer last name.
store_id	integer	ID of the store view where this customer account was created.
website_id	integer	ID of the website scope for this customer account.
created_at	string	ISO 8601 timestamp when the customer account was created.
updated_at	string	ISO 8601 timestamp when the customer account was last updated.
addresses	array	Customer address book entries.
custom_attributes	array	Custom EAV attribute values for this customer.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Customer",
  "title": "Customer",
  "type": "object",
  "description": "A registered customer account in Adobe Commerce.",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Numeric customer entity ID."
    },
    "group_id": {
      "type": "integer",
      "description": "ID of the customer group this customer belongs to."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Customer email address, used as the login identifier."
    },
    "firstname": {
      "type": "string",
      "description": "Customer first name."
    },
    "lastname": {
      "type": "string",
      "description": "Customer last name."
    },
    "store_id": {
      "type": "integer",
      "description": "ID of the store view where this customer account was created."
    },
    "website_id": {
      "type": "integer",
      "description": "ID of the website scope for this customer account."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the customer account was created."
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the customer account was last updated."
    },
    "addresses": {
      "type": "array",
      "description": "Customer address book entries.",
      "items": {
        "$ref": "#/components/schemas/Address"
      }
    },
    "custom_attributes": {
      "type": "array",
      "description": "Custom EAV attribute values for this customer.",
      "items": {
        "$ref": "#/components/schemas/CustomAttribute"
      }
    }
  }
}