TextAttribute

Type: schema

Description

Attribute for text values

TypeScript Definition

TextAttribute: {{
            id: string;
            name: string;
            /** @description A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type` */
            key: string;
            /**
             * @description discriminator enum property added by openapi-typescript
             * @enum {string}
             */
            type: "text";
            /** @description For text attributes */
            value: string;
        };
        /**
         * UpdateCartItem
         * @description Schema for updating a cart item, including adding, removing, or adjusting the quantity of a product or variant.
         */
}

OpenAPI Schema

{
  "title": "TextAttribute",
  "description": "Attribute for text values",
  "type": "object",
  "readOnly": true,
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/TextAttribute",
    "description": "API reference for the TextAttribute schema"
  },
  "required": [
    "id",
    "name",
    "key",
    "type",
    "value"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "key": {
      "description": "A lookup safe version of the name that is lowercased and spaces are replaced with underscores. For instance, if name is `Product Type`, key will be `product_type`",
      "type": "string"
    },
    "type": {
      "type": "string",
      "example": "text"
    },
    "value": {
      "description": "For text attributes",
      "type": "string"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions