Skip to main content
enum

Possible error codes that can be returned by FilesUserError.

Anchor to ALT_VALUE_LIMIT_EXCEEDEDALT_VALUE_LIMIT_EXCEEDED

The alt value exceeds the maximum limit of 512 characters.

Anchor to BATCH_DIRECTORY_MUTATION_NOT_ALLOWEDBATCH_DIRECTORY_MUTATION_NOT_ALLOWED

A directory rename or move must be submitted on its own. It cannot be combined with other file updates in the same request.

The input value is blank.

The search term must not be blank.

Anchor to DIRECTORY_ITEM_LIMIT_EXCEEDEDDIRECTORY_ITEM_LIMIT_EXCEEDED

A directory contains too many items.

Anchor to DIRECTORY_NESTED_ITEM_LIMIT_EXCEEDEDDIRECTORY_NESTED_ITEM_LIMIT_EXCEEDED

A directory contains too many items, including items in nested directories.

A directory must be empty before it can be deleted.

Anchor to DIRECTORY_SHOP_LIMIT_EXCEEDEDDIRECTORY_SHOP_LIMIT_EXCEEDED

The shop has reached the maximum number of directories.

File does not exist.

File has a pending operation.

Anchor to FILENAME_ALREADY_EXISTSFILENAME_ALREADY_EXISTS

The provided filename already exists.

The input value is invalid.

Anchor to INVALID_DIRECTORY_MOVEINVALID_DIRECTORY_MOVE

Cannot move a directory into itself or a directory nested within it.

Anchor to INVALID_DUPLICATE_MODE_FOR_TYPEINVALID_DUPLICATE_MODE_FOR_TYPE

Duplicate resolution mode is not supported for this file type.

Anchor to INVALID_DUPLICATE_RESOLUTION_MODEINVALID_DUPLICATE_RESOLUTION_MODE

Invalid duplicate resolution mode provided.

Anchor to INVALID_FAILED_MEDIA_STATEINVALID_FAILED_MEDIA_STATE

File cannot be updated in a failed state.

The provided filename is invalid.

Anchor to INVALID_FILENAME_EXTENSIONINVALID_FILENAME_EXTENSION

Invalid filename extension.

Anchor to INVALID_IMAGE_SOURCE_URLINVALID_IMAGE_SOURCE_URL

Invalid image source url value provided.

Search query isn't supported.

Anchor to MEDIA_CANNOT_BE_MODIFIEDMEDIA_CANNOT_BE_MODIFIED

Media cannot be modified. It is currently being modified by another operation.

Anchor to MISMATCHED_FILENAME_AND_ORIGINAL_SOURCEMISMATCHED_FILENAME_AND_ORIGINAL_SOURCE

Cannot create file with custom filename which does not match original source extension.

At least one argument is required.

Anchor to MISSING_FILENAME_FOR_DUPLICATE_MODE_REPLACEMISSING_FILENAME_FOR_DUPLICATE_MODE_REPLACE

Duplicate resolution mode REPLACE cannot be used without specifying filename.

Anchor to NON_IMAGE_MEDIA_PER_SHOP_LIMIT_EXCEEDEDNON_IMAGE_MEDIA_PER_SHOP_LIMIT_EXCEEDED

Exceeded the limit of non-image media per shop.

The file is not in the READY state.

Anchor to PRODUCT_MEDIA_LIMIT_EXCEEDEDPRODUCT_MEDIA_LIMIT_EXCEEDED

Exceeded the limit of media per product.

One or more associated products are suspended.

Anchor to REFERENCE_TARGET_DOES_NOT_EXISTREFERENCE_TARGET_DOES_NOT_EXIST

The target resource does not exist.

Anchor to RESERVED_DIRECTORY_NAMERESERVED_DIRECTORY_NAME

The directory name is reserved and cannot be used.

Specify one argument: search, IDs, or deleteAll.

Anchor to TOO_MANY_FILE_REFERENCETOO_MANY_FILE_REFERENCE

Cannot add more than 10000 references to a file.

The file type is not supported.

Anchor to UNACCEPTABLE_TRIAL_ASSETUNACCEPTABLE_TRIAL_ASSET

The file is not supported on trial accounts. Select a plan to upload this file.

Anchor to UNACCEPTABLE_UNVERIFIED_TRIAL_ASSETUNACCEPTABLE_UNVERIFIED_TRIAL_ASSET

The file is not supported on trial accounts that have not validated their email. Either select a plan or verify the shop owner email to upload this file.

Anchor to UNSUPPORTED_FILE_REFERENCEUNSUPPORTED_FILE_REFERENCE

The file type is not supported for referencing.

Anchor to UNSUPPORTED_MEDIA_TYPE_FOR_FILENAME_UPDATEUNSUPPORTED_MEDIA_TYPE_FOR_FILENAME_UPDATE

Filename update is only supported on Image and GenericFile.

Anchor to USER_FILE_OUTSIDE_USER_DIRECTORYUSER_FILE_OUTSIDE_USER_DIRECTORY

User-restricted files must be placed within the user's own directory.

Anchor to WRITE_RESTRICTED_FILES_REQUIREDWRITE_RESTRICTED_FILES_REQUIRED

Cannot replace restricted files without write_restricted_files.


Was this section helpful?

•OBJECT

An error that happens during the execution of a Files API query or mutation.


Was this section helpful?