File

Upload and manage file assets stored in the merchant's media library.

Files are media and document assets uploaded to the merchant's store for use across products, pages, and content. Merchants and apps use the file library to manage shared static resources.

Provides endpoints to create and query upload tasks, list files, and retrieve or delete a file by URI.

📄️Create Upload File Task

The Create Upload File Task API allows developers to upload files to the server. This endpoint supports uploading multiple files at once.

📄️Get File List

The Get File List API allows developers to retrieve a list of files stored on the server. This endpoint supports pagination and filtering based on the folder name.

📄️Get Upload File Task

The Get Upload File Task API retrieves the status and details of an upload task that was previously created using the task_id. It provides information about the task's progress, the number of files processed, and the results (success and failure lists)

📄️Get File Details

Retrieve detailed metadata and access information about a specific file using its unique file_uri. This endpoint is commonly used to fetch file properties, such as the name, size, type, and access URL.

📄️Delete File

This API deletes a specific file identified by its file_uri. It sends a DELETE request to the backend server, and upon success, the file is permanently removed from the system.