Get File Details

GET 
/openapi/2022-01/file/:file_uri

Retrieve detailed metadata and access information about a specific file using its unique file_uri. This endpoint is commonly used to fetch file properties, such as the name, size, type, and access URL.

Request

Path Parameters

file_uri stringrequired

The unique identifier of the file. This must be a valid alphanumeric string representing the file’s URI.

Responses

200

200

application/json

Schema

Schema

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.090041356+08:00
updated_atstring
Example: 2024-04-23T09:32:57.090041356+08:00

Example

{
  "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.090041356+08:00",
  "updated_at": "2024-04-23T09:32:57.090041356+08:00"
}

Result

{
    "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.090041356+08:00",
    "updated_at": "2024-04-23T09:32:57.090041356+08:00"
}

400

400

application/json

Schema

Schema

errorsstring
Example: request status not ok

Example

{
  "errors": "request status not ok"
}

Result

{ "errors": "request status not ok" }

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "data is null"
  ]
}

Result

{
  "errors": [
    "data is null"
  ]
}