---
title: "external_video"

doc_type: static
doc_category: static
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/sline/object/external-video'
  md: 'https://developer.shopline.com/docs/sline/object/external-video.md'
---

# external_video


    A video hosted on a platform external to SHOPLINE.

    



    <div>
    
        #### Properties

        
<ObjectProperty 
    name="alt"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
The text displayed when the video cannot be shown.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="aspect_ratio"
    types={[<Mdx>float</Mdx>]}
>
<ObjectSummary>
The aspect ratio of the video player.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="external_id"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
The unique identifier for the video on the external hosting platform.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="host"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
The name of the external video hosting platform. Only YouTube and Vimeo are supported.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="id"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
The unique identifier for the video assigned by the SHOPLINE system.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="media_type"
    types={[<Mdx>string</Mdx>]}
>
<ObjectSummary>
The media type.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="position"
    types={[<Mdx>integer</Mdx>]}
>
<ObjectSummary>
The position of the video in a list or a page. The property determines the display order when multiple videos are present.


</ObjectSummary>
</ObjectProperty>
        
<ObjectProperty 
    name="preview_image"
    types={[<Mdx>[image](https://developer.shopline.com/docs/sline/object/image.md)</Mdx>]}
>
<ObjectSummary>
The preview image of the video, displayed as the video thumbnail or cover before loading.


</ObjectSummary>
</ObjectProperty>
        
    
    </div>