Skip to content

MultiSelectAttribute

Type: schema

Description

Attribute for multi-select values

TypeScript Definition

typescript
MultiSelectAttribute: {{
            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: "multi-select";
            /** @description For multi-select attributes */
            value: string[];
        };
        /**
         * NetbankingPayment
         * @description Payments using payment gateway netbanking option.
         */
}

OpenAPI Schema

json
{
  "title": "MultiSelectAttribute",
  "description": "Attribute for multi-select values",
  "type": "object",
  "readOnly": true,
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/MultiSelectAttribute",
    "description": "API reference for the MultiSelectAttribute 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": "multi-select"
    },
    "value": {
      "description": "For multi-select attributes",
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: