Skip to content

ProductVideo

Type: schema

TypeScript Definition

typescript
ProductVideo: {{
            title: string | null;
            alternate_text: string | null;
            sort_order: number;
            video_preview_url: string;
            video_stream_hls_url: string;
            video_stream_dash_url: string;
            image_thumbnail_url: string;
            /** @description in seconds */
            video_duration: number;
        };
        /** Promotion */
}

OpenAPI Schema

json
{
  "title": "ProductVideo",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/ProductVideo",
    "description": "API reference for the ProductVideo schema"
  },
  "required": [
    "title",
    "alternate_text",
    "sort_order",
    "video_preview_url",
    "video_stream_hls_url",
    "video_stream_dash_url",
    "image_thumbnail_url",
    "video_duration"
  ],
  "properties": {
    "title": {
      "type": [
        "string",
        "null"
      ]
    },
    "alternate_text": {
      "type": [
        "string",
        "null"
      ]
    },
    "sort_order": {
      "type": "integer"
    },
    "video_preview_url": {
      "type": "string"
    },
    "video_stream_hls_url": {
      "type": "string"
    },
    "video_stream_dash_url": {
      "type": "string"
    },
    "image_thumbnail_url": {
      "type": "string"
    },
    "video_duration": {
      "description": "in seconds",
      "type": "integer"
    }
  },
  "examples": []
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: