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-10 (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-07 (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-04

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 ima