Files
Requires access scope, access scope or access scope.
An error that happens during the execution of a Files API query or mutation.
Anchor to FieldsFields
- Anchor to codecode•Files
Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- •mutation
Acknowledges file update failure by resetting FAILED status to READY and clearing any media errors.
- Anchor to fileIdsfile•[ID!]!required
Ids Specifies the file(s) to acknowledge the failed updates of.
Arguments
- Anchor to filesfiles•[File!]
The updated file(s).
- Anchor to userErrorsuser•[Files
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates file assets using an external URL or for files that were previously uploaded using the stagedUploadsCreate mutation. These files are added to the Files page in Shopify admin.
Files are processed asynchronously. Some data is not available until processing is completed. Check fileStatus to know when the files are READY or FAILED. See the FileStatus for the complete set of possible fileStatus values.
To get a list of all files, use the files query.
- Anchor to filesfiles•[File
Create Input!]!required List of new files to be created.
Arguments
- Anchor to filesfiles•[File!]
The newly created files.
- Anchor to userErrorsuser•[Files
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes existing file assets that were uploaded to Shopify.
- Anchor to fileIdsfile•[ID!]!required
Ids The IDs of the files to be deleted.
Arguments
- Anchor to deletedFileIdsdeleted•[ID!]
File Ids The IDs of the deleted files.
- Anchor to userErrorsuser•[Files
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates an existing file asset that was uploaded to Shopify.
- Anchor to filesfiles•[File
Update Input!]!required List of files to be updated.
Arguments
- Anchor to filesfiles•[File!]
The list of updated files.
- Anchor to userErrorsuser•[Files
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields