FilesUserError - admin-graphql - OBJECT
Version: 2024-10
Description:
An error that happens during the execution of a Files API query or mutation.
Access Scopes
`read_files` access scope, `read_themes` access scope or `read_images` access scope.
Fields
-
code:
FilesErrorCode -
The error code.
-
field:
String -
The path to the input field that caused the error.
-
message:
String! -
The error message.
Connections
Related queries
Related mutations
-
fileAcknowledgeUpdateFailed
Acknowledges file update failure by resetting FAILED status to READY and clearing any media errors.
-
fileCreate
Creates file assets using an external URL or for files that were previously uploaded using the
[stagedUploadsCreate mutation](https://shopify.dev/api/admin-graphql/latest/mutations/stageduploadscreate).
These files are added to the [Files page](https://shopify.com/admin/settings/files) in Shopify admin.
Files are processed asynchronously. Some data is not available until processing is completed.
Check [fileStatus](https://shopify.dev/api/admin-graphql/latest/interfaces/File#field-file-filestatus)
to know when the files are READY or FAILED. See the [FileStatus](https://shopify.dev/api/admin-graphql/latest/enums/filestatus)
for the complete set of possible fileStatus values.
To get a list of all files, use the [files query](https://shopify.dev/api/admin-graphql/latest/queries/files).
-
fileDelete
Deletes existing file assets that were uploaded to Shopify.
-
fileUpdate
Updates an existing file asset that was uploaded to Shopify.
Related Unions
Examples