CustomerGroup

Type: schema

TypeScript Definition

CustomerGroup: {{
            readonly id: string;
            name: string;
            description: string | null;
            /** @description first record will be treated as default if not changed. */
            is_default: boolean;
            /** @default true */
            active: boolean;
        };
        /** CustomerLoyalty */
}

OpenAPI Schema

{
  "title": "CustomerGroup",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerGroup",
    "description": "API reference for the CustomerGroup schema"
  },
  "required": [
    "id",
    "name",
    "description",
    "is_default",
    "active"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "is_default": {
      "description": "first record will be treated as default if not changed.",
      "type": "boolean"
    },
    "active": {
      "type": "boolean",
      "default": true
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions