put
https://{subdomain}.myshoplaza.com/openapi/2025-06/orders//risks/
Allows merchants to modify the risk level and associated details of an order.
Requireswrite_orderaccess scope. More access scope
The Update Order Risk API allows merchants to modify the risk level and associated details of an order. This enables businesses to reassess risks dynamically and adjust mitigation strategies accordingly.
This API is especially useful for:
- Updating the risk assessment of an order after manual or automated review.
- Customizing risk management workflows for specific orders.
- Enhancing order security by adjusting risk details dynamically.
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. | 54648070439338 |
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
risk.level | string | Yes | Risk level for the order. Possible values: low, medium, high | high |
risk.details | array of strings | No | List of risk details explaining the reason for the risk | ["Suspicious payment method", "Unusual shipping address"] |
risk.properties | object | No | Custom key-value pairs for additional risk information | "properties": { "risk_source": "manual_review", "reviewer_id": "user_123", "is_high_priority": true, "verification_steps": ["phone_call", "id_check"] }, |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "success" | Status code of the API response |
message | string | "Order retrieved successfully" | Descriptive message about the response |
data.risk | object | risk object |
Risk Object Structure
| Field | Type | Description | Example |
|---|---|---|---|
id | string | The unique ID of the created risk. | 372997190468224746 |
order_id | string | The unique ID of the order associated with the risk. | 633130-00000015 |
level | string | Risk level for the order. Possible values: low, medium, high. | low |
details | array of strings | List of reasons or details for the risk. | ["wrong order price"] |
properties | Custom key-value pairs for additional risk information | "properties": { "risk_source": "manual_review", "reviewer_id": "user_123", "is_high_priority": true, "verification_steps": ["phone_call", "id_check"] }, | |
created_at | string | Timestamp when the risk was created (ISO 8601 format). | 2024-04-25T06:37:40Z |
updated_at | string | Timestamp when the risk was last updated (ISO 8601 format). | 2024-04-25T06:37:40Z |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |