Skip to content

CustomerDetail

Type: schema

TypeScript Definition

typescript
CustomerDetail: {{
            readonly id?: string;
            first_name?: string;
            last_name?: string;
            /** @description Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. */
            country_code?: string;
            /** @description 10 digit phone number without country code. */
            phone?: string;
            email?: string;
            readonly is_phone_verified?: boolean;
            readonly is_email_verified?: boolean;
            business?: components["schemas"]["Business"];
        };
        /** CustomerGroup */
}

Component References

ReferenceResolves To
components["schemas"]["Business"]Business

OpenAPI Schema

json
{
  "title": "CustomerDetail",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerDetail",
    "description": "API reference for the CustomerDetail schema"
  },
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$",
      "readOnly": true
    },
    "first_name": {
      "type": "string"
    },
    "last_name": {
      "type": "string"
    },
    "country_code": {
      "description": "Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided.\r\n",
      "type": "string"
    },
    "phone": {
      "description": "10 digit phone number without country code.",
      "type": "string"
    },
    "email": {
      "type": "string"
    },
    "is_phone_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "is_email_verified": {
      "type": "boolean",
      "readOnly": true
    },
    "business": {
      "$ref": "#/components/schemas/Business"
    }
  },
  "examples": []
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: