Get File List

GET 
/openapi/2022-01/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.

Request

Query Parameters

page int32
Page number; Defaults to 1 if not specified. Must be a positive integer.
Default value: 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.
Default value: 20
folder string
The folder name to fetch files from. Defaults to "folder". Allowed values: -product - all_upload
Default value: product

Responses

200

200

application/json

Schema

Schema

files object[]
Array [
upload_linkstring
Example: https://cdn.shoplazza.com/7ebb4faa8d92e1d627edf9ca61a98993.png
file_uristring
Example: 7ebb4faa8d92e1d627edf9ca61a98993.png
folderstring
Example: upload
sizeinteger
Default value: 0
Example: 6842
typestring
Example: image/png
origin_linkstring
Example:
descstring
Example:
aspect_ratiostring
Example: 1.2500000
widthinteger
Default value: 0
Example: 250
heightinteger
Default value: 0
Example: 200
created_atstring
Example: 2024-04-23T09:32:57+08:00
updated_atstring
Example: 2024-04-23T09:32:57+08:00
]

Example

{
  "files": [
    {
      "upload_link": "https://cdn.shoplazza.com/7ebb4faa8d92e1d627edf9ca61a98993.png",
      "file_uri": "7ebb4faa8d92e1d627edf9ca61a98993.png",
      "folder": "upload",
      "size": 6842,
      "type": "image/png",
      "origin_link": "",
      "desc": "",
      "aspect_ratio": "1.2500000",
      "width": 250,
      "height": 200,
      "created_at": "2024-04-23T09:32:57+08:00",
      "updated_at": "2024-04-23T09:32:57+08:00"
    }
  ]
}

Result

{
    "files": [
        {
            "upload_link": "https://cdn.shoplazza.com/7ebb4faa8d92e1d627edf9ca61a98993.png",
            "file_uri": "7ebb4faa8d92e1d627edf9ca61a98993.png",
            "folder": "upload",
            "size": 6842,
            "type": "image/png",
            "origin_link": "",
            "desc": "",
            "aspect_ratio": "1.2500000",
            "width": 250,
            "height": 200,
            "created_at": "2024-04-23T09:32:57+08:00",
            "updated_at": "2024-04-23T09:32:57+08:00"
        },
        {
            "upload_link": "https://cdn.shoplazza.com/652c51e6ea5273f8e0b5c3a30b62fd57.jpeg",
            "file_uri": "652c51e6ea5273f8e0b5c3a30b62fd57.jpeg",
            "folder": "url_upload",
            "size": 0,
            "type": "image/jpg",
            "origin_link": "",
            "desc": "",
            "aspect_ratio": "1.5032680",
            "width": 690,
            "height": 459,
            "created_at": "2024-04-23T09:25:54+08:00",
            "updated_at": "2024-04-23T09:25:54+08:00"
        }
    ]
}

400

400

text/plain

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Unauthorized"
  ]
}

Result

{
  "errors": ["Unauthorized"]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "limit must be greater than 0"
  ]
}

Result

{
  "errors": ["limit must be greater than 0"]
}