Skip to content

Attribute ​

Type: schema

TypeScript Definition ​

typescript
Attribute: {{
            id?: $Read<string>;
            name?: string;
            /** @enum {unknown} */
            attribute_type?: "text" | "number" | "boolean" | "date" | "single-select" | "multi-select" | "color";
            is_visible?: boolean;
            is_filterable?: boolean;
            active?: boolean;
            supports_variant_creation?: boolean;
            /** Format: int32 */
            product_count?: $Read<number>;
            /** Format: date-time */
            created_at?: $Read<string>;
            /** Format: date-time */
            modified_at?: $Read<string>;
        };
        /** AttributeBasicDetail */
}

OpenAPI Schema ​

json
{
  "title": "Attribute",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "attribute_type": {
      "enum": [
        "text",
        "number",
        "boolean",
        "date",
        "single-select",
        "multi-select",
        "color"
      ]
    },
    "is_visible": {
      "type": "boolean"
    },
    "is_filterable": {
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    },
    "supports_variant_creation": {
      "type": "boolean"
    },
    "product_count": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "x-tags": [
    "Catalog"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: