Choose a version:

FileStatus

enum

The possible statuses for a file object.

Anchor to Valid valuesValid values

Anchor to FAILEDFAILED: File processing has failed.
Anchor to PROCESSINGPROCESSING: File is being processed.
Anchor to READYREADY: File is ready to be displayed.
Anchor to UPLOADEDUPLOADED: File has been uploaded but hasn't been processed.

Was this section helpful?

Anchor to FieldsFields

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

Was this section helpful?