Skip to content

AdminCustomerGroup ​

Type: schema

TypeScript Definition ​

typescript
AdminCustomerGroup: {{
            id?: $Read<string>;
            name: string;
            description?: string | null;
            /** @description first record will be treated as default if not changed. */
            is_default?: boolean;
            /** @default true */
            active: boolean;
        };
        /** SellerInfo */
}

OpenAPI Schema ​

json
{
  "title": "CustomerGroup",
  "type": "object",
  "required": [
    "name"
  ],
  "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
    }
  },
  "x-tags": [
    "Store"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: