get https://{shopdomain}.myshoplaza.com/openapi/2022-01/file
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
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 |