delete https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders//risks/
Requires
write_orderaccess scope. More access scope
The Delete Order Risk API allows merchants to remove a specific risk entry associated with an order. This is particularly useful when a risk has been mitigated or deemed no longer relevant.
This API is especially useful for:
- Cleaning up outdated or resolved risks from the system.
- Managing risks dynamically as the status of orders changes.
- Improving the accuracy of order risk assessments.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
order_id | string | Yes | The unique ID of the order. | 19653511576161 |
id | string | Yes | The unique ID of the risk entry to be deleted. | 54648070439338 |
Response Description
Public Response Fields
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 | "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 orderID is not found | "Unable to find resource" |
| 422 | invalid format | ID format error | "ID format error" |