get
https://{subdomain}.myshoplaza.com/openapi/2025-06/file
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.
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 | Required | Description | Example |
|---|---|---|---|---|
cursor | string | No | cursor for pagination | 1 |
page_size | int32 | No | 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. | 20 |
folder | string | No | The folder name to fetch files from. Defaults to "all_upload". Allowed values: -product - all_upload | product |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
code | string | "success" | Response status code |
message | string | Descriptive message of the response | |
data.files | array | List of files. | See below for structure. |
data.upload_link | string | Direct link to access the uploaded file. | https://cdn.shoplazza.com/ 7ebb4faa8d92e1d627edf9ca61a98993.png |
data.file_uri | string | Unique identifier of the file. | 7ebb4faa8d92e1d627edf9ca61a98993.png |
data.folder | string | The folder where the file is stored. | upload |
data.size | int | File size in bytes. | 6842 |
data.type | string | MIME type of the file. | image/png |
data.origin_link | string | The original link of the file if uploaded via URL. | "" |
data.desc | string | File description. | "" |
data.aspect_ratio | string | Aspect ratio of the file. | "1.2500000" |
data.width | int | Width of the file in pixels. | 250 |
data.height | int | Height of the file in pixels. | 200 |
data.created_at | string | Timestamp when the file was created. | "2024-04-23T09:32:57+08:00" |
data.updated_at | string | Timestamp when the file was last updated. | "2024-04-23T09:32:57+08:00" |
data.cursor | string | Pagination token | "next123" |
data.has_more | boolean | More items available | true |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |