get
https://{subdomain}.myshoplaza.com/openapi/2025-06/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)
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).
This API is especially useful for:
- Monitoring the progress of file upload tasks.
- Fetching details of successfully uploaded files, including the
upload_link. - Identifying files that failed to upload for troubleshooting.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Description | Example |
|---|---|---|---|
task_id | string | The unique identifier for the upload task. | 300b5e33-3ac5-41c5-9819-7e2e8aad6a98 |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
code | string | Response status code | Success |
data | object | Contains upload task details and file lists | |
data.task_id | string | Unique identifier for the upload task | 300b5e33-3ac5-41c5- 9819-7e2e8aad6a98 |
data.total | integer | Total number of files in the upload task | 1 |
data.finished | integer | Number of files successfully processed | 1 |
data.status | integer | Upload task status (0 = completed, 1 = in progress, etc.) | 0 |
data.success_list | array | List of success_list | |
data.success_list[].file_uri | string | Unique identifier of the successfully uploaded file | 30b62fd57.jpeg |
data.success_list[].origin_link | string | Original URL of the uploaded file if uploaded via URL | https://picx.zhimg.com/... |
data.success_list[].upload_link | string | Direct CDN link to access the uploaded file | https://cdn.shoplazza.com/... |
data.failure_list | array | List of files that failed to upload | [] |
data.origin_list | array | List of original file URLs from the upload request | ["https://picx.zhimg.com/..."] |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |