post https://{shopdomain}.myshoplaza.com/openapi/2022-01/file
The Create Upload File Task API allows users to create an upload task for a list of original file URLs. The backend processes the provided URLs and assigns a unique task ID for tracking the upload progress.
This API is especially useful for:
- Automating file uploads for various applications.
- Managing and tracking the upload process via task IDs.
- Simplifying bulk file uploads in an efficient manner.
Request Parameters
Public Request Parameters
Body Parameters
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
original_source_list | array of strings | Yes | A list of original file URLs to be uploaded. Each URL must be a valid link pointing to a file. | ["https://picx.zhimig.com/v2-3b4fc7e3a1195a081d0259246c38debc_720w.jpg?source=172ae18b"] |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
task_id | string | Unique ID assigned to the task. | 300b5e33-3ac5-41c5-9819-7e2e8aad6a98 |
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 Details
| ErrorCode | Description | Possible reasons |
|---|---|---|
| 400 | Bad Request | 1. Backend status indicates failure 2.Invalid domain url or credentials 3. empty body params 4.Missing or empty task_id |
| 500 | StatusInternalServerError | 1.Aborted 2.Unimplemented 3.Unauthenticated 4.DeadlineExceeded 5. Response message parsing error |