API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

ExternalVideo object

Version unstable

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • host (MediaHost!)

    The host of the external video.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2021-07 (Release candidate)

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • host (MediaHost!)

    The host of the external video.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2021-04 (Latest)

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • host (MediaHost!)

    The host of the external video.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2021-01

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2020-10

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2020-07

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2020-04 (Unsupported)

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2020-01 (Unsupported)

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2019-10 (Unsupported)

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2019-07 (Unsupported)

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements

Version 2019-04 (Unsupported)

Represents a video hosted outside of Shopify.

Required access

read_products access scope.

Fields

  • alt (String)

    A word or phrase to share the nature or contents of a media.

  • embeddedUrl (URL!)

    The URL.

  • id (ID!)

    Globally unique identifier.

  • mediaContentType (MediaContentType!)

    The media content type.

  • mediaErrors ([MediaError!]!)

    Any errors which have occurred on the media.

  • preview (MediaPreviewImage)

    The preview image for the media.

  • status (MediaStatus!)

    Current status of the media.

Implements