Choose a version:

File

interface

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.

A file interface.

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 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 idid •ID! non-null: A globally-unique ID.
Anchor to previewpreview •MediaPreviewImage: The preview image for the media.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was last updated.

Was this section helpful?

Anchor to Types implemented inTypes implemented in

ExternalVideo

•OBJECT

Represents a video hosted outside of Shopify.

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

GenericFile

•OBJECT

Represents any file other than HTML.

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 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 idid •ID! non-null: A globally-unique ID.
Anchor to mimeTypemimeType •String: The generic file's MIME type.
Anchor to originalFileSizeoriginalFileSize •Int: The generic file's size in bytes.
Anchor to previewpreview •MediaPreviewImage: The preview image for the media.
Anchor to updatedAtupdatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was last updated.
Anchor to urlurl •URL: The generic file's URL.

MediaImage

•OBJECT

The MediaImage object represents an image hosted on Shopify's content delivery network (CDN). Shopify CDN is a content system that serves as the primary way to store, manage, and deliver visual content for products, variants, and other resources across the Shopify platform.

The MediaImage object provides information to:

Store and display product and variant images across online stores, admin interfaces, and mobile apps.
Retrieve visual branding elements, including logos, banners, favicons, and background images in checkout flows.
Retrieve signed URLs for secure, time-limited access to original image files.

Each MediaImage object provides both the processed image data (with automatic optimization and CDN delivery) and access to the original source file. The image processing is handled asynchronously, so images might not be immediately available after upload. The status field indicates when processing is complete and the image is ready for use.

The MediaImage object implements the Media interface alongside other media types, like videos and 3D models.

Learn about managing media for products, product variants, and asynchronous media management.

Anchor to altalt •String: A word or phrase to share the nature or contents of a media.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was created.
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 idid •ID! non-null: A globally-unique ID.
Anchor to imageimage •Image: The image for the media. Returns null until status is READY.
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 mimeTypemimeType •String: The MIME type of the image.
Anchor to originalSourceoriginalSource •MediaImageOriginalSource: The original source of the image.
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 metafieldmetafield •Metafield Deprecated
Anchor to metafieldsmetafields •MetafieldConnection! non-nullDeprecated

Model3d

•OBJECT

Represents a Shopify hosted 3D model.

Anchor to altalt •String: A word or phrase to describe the contents or the function of a file.
Anchor to boundingBoxboundingBox •Model3dBoundingBox: The 3d model's bounding box information.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was created.
Anchor to fileErrorsfileErrors •[FileError!]! non-null: Any errors that have occurred on the file.
Anchor to filenamefilename •String! non-null: The 3d model's filename.
Anchor to fileStatusfileStatus •FileStatus! non-null: The status of the file.
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 originalSourceoriginalSource •Model3dSource: The 3d model's original source.
Anchor to previewpreview •MediaPreviewImage: The preview image for the media.
Anchor to sourcessources •[Model3dSource!]! non-null: The 3d model's sources.
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.

Video

•OBJECT

Represents a Shopify hosted video.

Anchor to altalt •String: A word or phrase to share the nature or contents of a media.
Anchor to createdAtcreatedAt •DateTime! non-null: The date and time (ISO 8601 format) when the file was created.
Anchor to durationduration •Int: The video's duration in milliseconds. This value is null unless the video's status field is READY.
Anchor to fileErrorsfileErrors •[FileError!]! non-null: Any errors that have occurred on the file.
Anchor to filenamefilename •String! non-null: The video's filename.
Anchor to fileStatusfileStatus •FileStatus! non-null: The status of the file.
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 originalSourceoriginalSource •VideoSource: The video's original source. This value is null unless the video's status field is READY.
Anchor to previewpreview •MediaPreviewImage: The preview image for the media.
Anchor to sourcessources •[VideoSource!]! non-null: The video's sources. This value is empty unless the video's status field is READY.
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.

Was this section helpful?