get https://{shopdomain}.myshoplaza.com/openapi/2022-01/file
This API retrieves a paginated list of files from the specified folder. You can filter files by type and control pagination using the query parameters.
The Get File List API retrieves a paginated list of files from the specified folder. You can filter files by type and control pagination using the query parameters.
This API is especially useful for:
- Fetching stored files in a specific folder.
- Managing and reviewing uploaded files.
- Accessing detailed file metadata such as dimensions, file size, and type.
Request Parameters
Public Request Parameters
Query Parameters
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
page | int32 | Page number; defaults to 1 if not specified. Must be a positive integer. | No | 1 |
limit | int32 | The number of files to retrieve per page. Defaults to 20 if not specified. Must be greater than 0 and less than or equal to 300. | No | 20 |
folder | string | The folder name to fetch files from. Defaults to "product". Allowed values: product, all_upload. | No | product |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
files | array | List of files. | See below for structure. |
upload_link | string | Direct link to access the uploaded file. | https://cdn.shoplazza.com/7ebb4faa8d92e1d627edf9ca61a98993.png |
file_uri | string | Unique identifier of the file. | 7ebb4faa8d92e1d627edf9ca61a98993.png |
folder | string | The folder where the file is stored. | upload |
size | int | File size in bytes. | 6842 |
type | string | MIME type of the file. | image/png |
origin_link | string | The original link of the file if uploaded via URL. | "" |
desc | string | File description. | "" |
aspect_ratio | string | Aspect ratio of the file. | "1.2500000" |
width | int | Width of the file in pixels. | 250 |
height | int | Height of the file in pixels. | 200 |
created_at | string | Timestamp when the file was created. | "2024-04-23T09:32:57+08:00" |
updated_at | string | Timestamp when the file was last updated. | "2024-04-23T09:32:57+08:00" |
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.JSON parsing error |
| 422 | UnprocessableError | Validation errors of limit fied |
| 500 | StatusInternalServerError | 1.Aborted 2.Unimplemented 3.Unauthenticated 4.DeadlineExceeded 5. Response message parsing error |