delete https://{subdomain}.myshoplaza.com/openapi/2022-01/price_rules/
Requires
price_rulesaccess scope. More access scope
The Delete Price Rule API allows you to remove an existing price rule from the system using its unique ID.
This API is especially useful for:
- Removing outdated or no longer applicable discount rules.
- Cleaning up rules that are incorrectly configured.
- Automating the deletion process for expired promotional campaigns.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
price_rule_id | string | Yes | 91f9a466-7c8c-46e7-9774-64874a641534 | ID of the price rule to delete. |
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 | [ "invalid line_item id"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "store is not active" | 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 | |
| 404 | Not Found | The ID provided is not existed. | Not Found |