This API retrieves the status and details of an upload task that was previously created using the task ID (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 |
|---|---|---|---|
task_id | string | The unique identifier for the upload task. | 300b5e33-3ac5-41c5-9819-7e2e8aad6a98 |
total | int | Total number of files in the upload task. | 1 |
finished | int | Number of files successfully processed. | 1 |
status | int | Status of the upload task (0 = completed, 1 = in progress, etc.). | 0 |
success_list | array | A list of successfully uploaded files, including file_uri, origin_link, and upload_link. | [{"file_uri": "652c51e6ea5273f8e0b5c3a30b62fd57.jpeg", "origin_link": "https://picx.zhimg.com/v2-3b4fc7e3a1195a081d0259246c38debc_720w.jpg?source=172ae18b", "upload_link": "https://cdn.shoplazza.com/652c51e6ea5273f8e0b5c3a30b62fd57.jpeg"}] |
failure_list | array | A list of files that failed to upload. | [] |
origin_list | array | A list of original file URLs from the upload request. | ["https://picx.zhimg.com/v2-3b4fc7e3a1195a081d0259246c38debc_720w.jpg?source=172ae18b"] |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| ErrorCode | Description | Possible reasons |
|---|---|---|
| 400 | Bad Request | 1. Backend status indicates failure 2.Invalid domain url or credentials 3.Missing or empty task_id |
| 404 | Not Found | Missing or invalid data |
| 500 | StatusInternalServerError | 1.Aborted 2.Unimplemented 3.Unauthenticated 4.DeadlineExceeded 5. Response message parsing error |