delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/file/
This API deletes a specific file identified by its file_uri. It sends a DELETE request to the backend server, and upon success, the file is permanently removed from the system.
The Delete File API removes a specific file identified by its file_uri. It sends a DELETE request to the backend server, and upon success, the file is permanently removed from the system.
This API is especially useful for:
- Cleaning up unused or outdated files in the system.
- Ensuring secure removal of sensitive data from storage.
- Managing file lifecycle efficiently within the platform.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Description | Required | Example |
|---|---|---|---|---|
file_uri | string | A unique identifier of the file to delete, formatted as a valid URI string representing the file’s path. | Yes | 7ebb4faa8d92e1d627edf9ca61a98993.png |
Response Explanation
Public Response Parameters
Success Response
| Status Code | Description |
|---|---|
| 200 | File successfully deleted. |
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
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized |