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, read_images access scope or read_quick_sale 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

Anchor to ExternalVideo ExternalVideo •OBJECT: Represents a video hosted outside of Shopify.
Anchor to GenericFile GenericFile •OBJECT: Represents any file other than HTML.
Anchor to MediaImage 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 Model3d Model3d •OBJECT: Represents a Shopify hosted 3D model.
Anchor to Video Video •OBJECT: Represents a Shopify hosted video.

Was this section helpful?

{

"alt": "",

"createdAt": "",

"fileErrors": "",

"fileStatus": "",

"id": "",

"preview": "",

"updatedAt": ""

}

Variables

{
	"alt": "",
	"createdAt": "",
	"fileErrors": "",
	"fileStatus": "",
	"id": "",
	"preview": "",
	"updatedAt": ""
}

Schema

interface File {
  alt: String
  createdAt: DateTime!
  fileErrors: [FileError!]!
  fileStatus: FileStatus!
  id: ID!
  preview: MediaPreviewImage
  updatedAt: DateTime!
}