VariantDetail

Type: schema

TypeScript Definition

VariantDetail: {components["schemas"]["Variant"] & {
            /**
             * @example physical
             * @enum {string}
             */
            product_type: "physical" | "digital" | "bundle"
}

Component References

Reference	Resolves To
components["schemas"]["Variant"]	Variant

OpenAPI Schema

{
  "title": "VariantDetail",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/VariantDetail",
    "description": "API reference for the VariantDetail schema"
  },
  "allOf": [
    {
      "$ref": "#/components/schemas/Variant"
    },
    {
      "type": "object",
      "required": [
        "product_type",
        "description",
        "category_ids",
        "tags",
        "reviews_rating_sum",
        "reviews_count",
        "hsn_code",
        "variant_options",
        "product_attributes",
        "variant_attributes",
        "videos",
        "shipping",
        "seo",
        "metadata"
      ],
      "properties": {
        "product_type": {
          "type": "string",
          "enum": [
            "physical",
            "digital",
            "bundle"
          ],
          "examples": [
            "physical"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "category_ids": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "tags": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "reviews_rating_sum": {
          "type": [
            "number",
            "null"
          ]
        },
        "reviews_count": {
          "type": "integer"
        },
        "hsn_code": {
          "type": [
            "string",
            "null"
          ]
        },
        "variant_options": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/VariantOption"
          }
        },
        "product_attributes": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductAttribute"
          }
        },
        "variant_attributes": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductAttribute"
          }
        },
        "videos": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/ProductVideo"
          }
        },
        "shipping": {
          "$ref": "#/components/schemas/ProductShipping"
        },
        "seo": {
          "$ref": "#/components/schemas/Seo"
        },
        "metadata": {
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    }
  ],
  "examples": []
}

---

Auto-generated from OpenAPI spec and TypeScript definitions