File
The input fields that are required to create a file object.
Anchor to FieldsFields
- alt (String)
- contentType (FileContentType)
- duplicateResolutionMode (FileCreateInputDuplicateResolutionMode)
- filename (String)
- originalSource (String)
- parentDirectoryId (ID)
- parentDirectoryPath (String)
- •String
The alt text description of the file for screen readers and accessibility.
- Anchor to contentTypecontent•File
Type Content Type The file content type. If omitted, then Shopify will attempt to determine the content type during file processing.
Show enum values
- Anchor to duplicateResolutionModeduplicate•File
Resolution Mode Create Input Duplicate Resolution Mode Default:APPEND_UUID How to handle if filename is already in use.
Show enum values
- Anchor to filenamefilename•String
The name of the file. If provided, then the file is created with the specified filename. If not provided, then the filename from the
is used.- Anchor to originalSourceoriginal•String
Source The source URL of the file. An external URL can be used for images, generic files, or external videos. Videos and 3D models require a staged upload URL.
- Anchor to parentDirectoryIdparent•ID
Directory Id The ID of the parent directory to create the file or directory in. Cannot be used together with parentDirectoryPath.
- Anchor to parentDirectoryPathparent•String
Directory Path The full parent directory path to create the file or directory in (e.g. 'public/assets/images'). Files can only be created under the default 'public' directory. For directories, this is always the parent directory path; provide filename as the directory name. Cannot be used together with parentDirectoryId.