AdminUploadsResource
This class is used to send requests to Admin Upload API Routes. All its method
are available in the JS Client under the medusa.admin.uploads
property.
All methods in this class require authentication.
The methods in this class are used to upload any type of resources. For example, they can be used to upload CSV files that are used to import products into the store.
Related Guide: How to upload CSV file when importing a product.
Methods
create
Upload a file or multiple files to a public bucket or storage. The file upload is handled by the file service installed on the Medusa backend.
Example
Parameters
file
AdminCreateUploadPayloadRequiredReturns
ResponsePromise
ResponsePromise<AdminUploadsRes>RequiredResolves to the uploaded file details.
ResponsePromise
ResponsePromise<AdminUploadsRes>RequiredcreateProtected
Upload a file to an ACL or a non-public bucket. The file upload is handled by the file service installed on the Medusa backend.
Example
Parameters
file
AdminCreateUploadPayloadRequiredReturns
ResponsePromise
ResponsePromise<AdminUploadsRes>RequiredResolves to the uploaded file details.
ResponsePromise
ResponsePromise<AdminUploadsRes>Requireddelete
Delete an uploaded file from storage. The file is deleted using the installed file service on the Medusa backend.
Example
Parameters
The uploaded file to delete.
customHeaders
Record<string, any>RequiredDefault: {}
Returns
ResponsePromise
ResponsePromise<DeleteResponse>RequiredResolves to the deletion operation's details.
ResponsePromise
ResponsePromise<DeleteResponse>RequiredgetPresignedDownloadUrl
Create and retrieve a presigned or public download URL for a file. The URL creation is handled by the file service installed on the Medusa backend.
Example
Parameters
The uploaded file to get a presigned download URL for.
customHeaders
Record<string, any>RequiredDefault: {}
Returns
ResponsePromise
ResponsePromise<AdminUploadsDownloadUrlRes>RequiredResolves to the download URL details.
ResponsePromise
ResponsePromise<AdminUploadsDownloadUrlRes>Required_createPayload
Parameters
file
AdminCreateUploadPayloadRequiredReturns
FormData
FormDataRequired