Anchor to section titled 'undefined'

ExternalVideo
object

Requires read_products access scope, read_files access scope, read_themes access scope, read_orders access scope, read_draft_orders access scope or read_images access scope.

Represents a video hosted outside of Shopify.

Anchor to section titled 'Fields'

Fields

Anchor to ExternalVideo.alt
alt
String

A word or phrase to describe the contents or the function of a file.

Anchor to ExternalVideo.createdAt
createdAt
DateTime!
non-null

The date and time (ISO 8601 format) when the file was created.

Anchor to ExternalVideo.embedUrl
embedUrl
URL!
non-null

The embed URL of the video for the respective host.

Anchor to ExternalVideo.fileErrors
fileErrors
[FileError!]!
non-null

Any errors that have occurred on the file.

Anchor to ExternalVideo.fileStatus
fileStatus
FileStatus!
non-null

The status of the file.

Anchor to ExternalVideo.host
host
MediaHost!
non-null

The host of the external video.

Anchor to ExternalVideo.id
id
ID!
non-null

A globally-unique ID.

Anchor to ExternalVideo.mediaContentType
mediaContentType
MediaContentType!
non-null

The media content type.

Anchor to ExternalVideo.mediaErrors
mediaErrors
[MediaError!]!
non-null

Any errors which have occurred on the media.

Anchor to ExternalVideo.mediaWarnings
mediaWarnings
[MediaWarning!]!
non-null

The warnings attached to the media.

Anchor to ExternalVideo.originUrl
originUrl
URL!
non-null

The origin URL of the video on the respective host.

Anchor to ExternalVideo.preview
preview
MediaPreviewImage

The preview image for the media.

Anchor to ExternalVideo.status
status
MediaStatus!
non-null

Current status of the media.

Anchor to ExternalVideo.updatedAt
updatedAt
DateTime!
non-null

The date and time (ISO 8601 format) when the file was last updated.

Anchor to ExternalVideo.updateStatus
updateStatus
FileStatus

Status resulting from the latest update operation. See fileErrors for details.

Was this section helpful?
Map
  • No referencing fields
    • ExternalVideo
    Anchor to section titled 'Implements'

    Implements

    Anchor to File
    File
    interface
    Anchor to Media
    Media
    interface
    Anchor to Node
    Node
    interface
    Was this section helpful?
    ||-
    ExternalVideo Implements
    ExternalVideo

    Implements