get https://{shopdomain}.myshoplaza.com/openapi/2022-01/file/
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.
The Get File Details API retrieves 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.
This API is especially useful for:
- Fetching specific file metadata for management purposes.
- Verifying file upload details and properties.
- Accessing the upload link for downloaded or shared files.
Request Parameters
Public Request Parameters
Path Parameters
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.Missing or invalid data |
| 404 | Not Found | Missing or invalid data |
| 500 | StatusInternalServerError | 1.Aborted 2.Unimplemented 3.Unauthenticated 4.DeadlineExceeded 5. Response message parsing error |