Skip to main content
Shopify.devDocs
Log inSign up
Anchor to ExternalVideo

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 FieldsFields

Anchor to altalt
•
String

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

Anchor to createdAtcreatedAt
•
DateTime!non-null

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

Anchor to embedUrlembedUrl
•
URL!non-null

The embed URL of the video for the respective host.

Anchor to fileErrorsfileErrors
•
[FileError!]!non-null

Any errors that have occurred on the file.

Anchor to fileStatusfileStatus
•
FileStatus!non-null

The status of the file.

Anchor to hosthost
•
MediaHost!non-null

The host of the external video.

Anchor to idid
•
ID!non-null

A globally-unique ID.

Anchor to mediaContentTypemediaContentType
•
MediaContentType!non-null

The media content type.

Anchor to mediaErrorsmediaErrors
•
[MediaError!]!non-null

Any errors which have occurred on the media.

Anchor to mediaWarningsmediaWarnings
•
[MediaWarning!]!non-null

The warnings attached to the media.

Anchor to originUrloriginUrl
•
URL!non-null

The origin URL of the video on the respective host.

Anchor to previewpreview
•
MediaPreviewImage

The preview image for the media.

Anchor to statusstatus
•
MediaStatus!non-null

Current status of the media.

Anchor to updatedAtupdatedAt
•
DateTime!non-null

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

Anchor to embeddedUrlembeddedUrl
•
URL!non-nullDeprecated

The URL. Use originUrl instead.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?