Skip to content

AssociatedOption

Type: schema

Description

An object where each key is an option name, and the value describes the option details.

TypeScript Definition

typescript
AssociatedOption: {{
            [key: string]: components["schemas"]["ColorOption"] | components["schemas"]["SingleSelectOption"];
        };
        /** AutoScaleBasedOnAmount */
}

Component References

ReferenceResolves To
components["schemas"]["ColorOption"]ColorOption
components["schemas"]["SingleSelectOption"]SingleSelectOption

OpenAPI Schema

json
{
  "title": "AssociatedOption",
  "description": "An object where each key is an option name, and the value describes the option details.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/AssociatedOption",
    "description": "API reference for the AssociatedOption schema"
  },
  "additionalProperties": {
    "oneOf": [
      {
        "$ref": "#/components/schemas/ColorOption"
      },
      {
        "$ref": "#/components/schemas/SingleSelectOption"
      }
    ]
  },
  "examples": [
    {
      "background_color": {
        "name": "Background Color",
        "value": {
          "name": "Blue",
          "hexcode": "#0000FF"
        },
        "type": "color"
      },
      "size": {
        "name": "Size",
        "value": "Large",
        "type": "single-select"
      }
    }
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: