delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/app-proxies/
Requires
write_app_proxyaccess scope.
The Delete App Proxy API is used to remove a specific APP_Proxy instance from a Shoplazza store. This action is irreversible and permanently deletes the proxy configuration.
This API is especially useful for:
- Cleaning up unused or outdated app proxy configurations.
- Managing app proxy setups efficiently for a store.
- Ensuring only necessary proxy instances are active.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | The ID of the app proxy to delete. | 1231321 |
Response Explanation
Public Response Parameters
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 |
|---|---|---|---|
errors | Array | [ "file number error"] | A list of errors encountered during the request processing. |
| 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 | |
| 422 | Unprocessable Entity | App Proxy id is invalid or empty | "errors": "id param err" |
| 404 | Not Found | App Proxy is not found. | "No record found." |