Choose a version:

Media

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.

Represents a media interface.

Anchor to FieldsFields

Anchor to altalt

•String

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

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 previewpreview

•MediaPreviewImage

The preview image for the media.

Anchor to statusstatus

•MediaStatus!

non-null

Current status of the media.

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 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": "",

"id": "",

"mediaContentType": "",

"mediaErrors": "",

"mediaWarnings": "",

"preview": "",

"status": ""

}

Variables

{
	"alt": "",
	"id": "",
	"mediaContentType": "",
	"mediaErrors": "",
	"mediaWarnings": "",
	"preview": "",
	"status": ""
}

Schema

interface Media {
  alt: String
  id: ID!
  mediaContentType: MediaContentType!
  mediaErrors: [MediaError!]!
  mediaWarnings: [MediaWarning!]!
  preview: MediaPreviewImage
  status: MediaStatus!
}