Skip to content

IntegerAttribute ​

Type: schema

TypeScript Definition ​

typescript
IntegerAttribute: {{
            id?: $Read<string>;
            name?: string;
            slug?: $Read<string>;
            kind?: $Read<components["schemas"]["CustomerAttributeKind"]>;
            /** @description Where a `linked` attribute's values come from; `null` for the other kinds. */
            link?: $Read<null | components["schemas"]["CustomerAttributeLink"]>;
            is_linked?: $Read<boolean>;
            /** @description `null` when no value is set for this customer. */
            value?: number | null;
            /** @enum {unknown} */
            attribute_type?: "Integer";
            is_readonly?: $Read<boolean>;
            /** @description Whether the attribute is pinned to the top of the customer profile. */
            is_pinned?: boolean;
            active?: boolean;
            is_visible?: boolean;
            is_filterable?: boolean;
            /** Format: date-time */
            last_updated_at?: $Read<string>;
        };
        /**
         * InventoryAction
         * @enum {unknown}
         */
}

Component References ​

ReferenceResolves To
components["schemas"]["CustomerAttributeKind"]CustomerAttributeKind
components["schemas"]["CustomerAttributeLink"]CustomerAttributeLink

OpenAPI Schema ​

json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string"
    },
    "slug": {
      "type": "string",
      "readOnly": true
    },
    "kind": {
      "$ref": "#/components/schemas/CustomerAttributeKind",
      "readOnly": true
    },
    "link": {
      "description": "Where a `linked` attribute's values come from; `null` for the other kinds.",
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/components/schemas/CustomerAttributeLink"
        }
      ],
      "readOnly": true
    },
    "is_linked": {
      "type": "boolean",
      "readOnly": true
    },
    "value": {
      "description": "`null` when no value is set for this customer.",
      "type": [
        "integer",
        "null"
      ]
    },
    "attribute_type": {
      "enum": [
        "Integer"
      ]
    },
    "is_readonly": {
      "type": "boolean",
      "readOnly": true
    },
    "is_pinned": {
      "description": "Whether the attribute is pinned to the top of the customer profile.",
      "type": "boolean"
    },
    "active": {
      "type": "boolean"
    },
    "is_visible": {
      "type": "boolean"
    },
    "is_filterable": {
      "type": "boolean"
    },
    "last_updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    }
  },
  "title": "IntegerAttribute",
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: