Skip to content

AdditionalProductDetails

Type: schema

TypeScript Definition

typescript
AdditionalProductDetails: {{
            description: string | null;
            hsn_code: string | null;
            videos: components["schemas"]["ProductVideo"][];
            shipping: components["schemas"]["ProductShipping"];
            /** @description An array of product IDs */
            upselling_product_ids: (string | null)[];
            /** @description An array of product IDs */
            crossselling_product_ids: string[];
            seo: components["schemas"]["Seo"];
            metadata: {
                [key: string]: string;
            } | null;
        };
        /**
         * AnalyticsEvent
         * @description Model for analytics event
         */
}

Component References

ReferenceResolves To
components["schemas"]["ProductVideo"]ProductVideo
components["schemas"]["ProductShipping"]ProductShipping
components["schemas"]["Seo"]Seo

OpenAPI Schema

json
{
  "title": "AdditionalProductDetails",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/AdditionalProductDetails",
    "description": "API reference for the AdditionalProductDetails schema"
  },
  "required": [
    "description",
    "hsn_code",
    "videos",
    "shipping",
    "upselling_product_ids",
    "crossselling_product_ids",
    "seo",
    "metadata"
  ],
  "properties": {
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "hsn_code": {
      "type": [
        "string",
        "null"
      ]
    },
    "videos": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ProductVideo"
      }
    },
    "shipping": {
      "$ref": "#/components/schemas/ProductShipping"
    },
    "upselling_product_ids": {
      "description": "An array of product IDs",
      "type": "array",
      "items": {
        "type": [
          "string",
          "null"
        ],
        "pattern": "^[a-zA-Z0-9]{26}$",
        "examples": [
          "01F3Z7KG06J4ACWH1C4926KJEB"
        ]
      }
    },
    "crossselling_product_ids": {
      "description": "An array of product IDs",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "^[A-Za-z0-9]{26}$",
        "examples": [
          "01F3Z7KG06J4ACWH1C4926KJEB"
        ]
      }
    },
    "seo": {
      "$ref": "#/components/schemas/Seo"
    },
    "metadata": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": "string"
      }
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: