Skip to main content
Anchor to MediaImage

MediaImage

object

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.

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 FieldsFields

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 translationstranslations
•[Translation!]!
non-null

The published translations associated with the resource.

Arguments

Anchor to localelocale
•String!
required

Filters translations locale.

Anchor to marketIdmarketId
•ID

Filters translations by market ID. Use this argument to retrieve content specific to a market.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

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

Deprecated fields

Anchor to metafieldmetafield
•Metafield
Deprecated

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The key for the metafield.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-nullDeprecated

Arguments

Anchor to namespacenamespace
•String

The metafield namespace to filter by. If omitted, all metafields are returned.

Anchor to keyskeys
•[String!]

List of keys of metafields in the format namespace.key, will be returned in the same format.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to FileFile
•interface
Anchor to HasMetafieldsHasMetafields
•interface
Anchor to HasPublishedTranslationsHasPublishedTranslations
•interface
Anchor to MediaMedia
•interface
Anchor to NodeNode
•interface
Was this section helpful?