get
https://{subdomain}.myshoplaza.com/openapi/2025-06/orders//risks/list
Provides a list of risks associated with a specific order.
Requiresread_orderaccess scope. More access scope
The Order Risk List API provides a list of risks associated with a specific order. This helps merchants review all flagged risks for the given order in a paginated format.
This API is especially useful for:
- Fetching all risks flagged for an order.
- Facilitating review and risk management processes.
- Enabling data-driven decision-making regarding flagged risks.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
order_id | string | Yes | The unique ID of the order. | 633130-00000015 |
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
cursor | string | Yes | Cursor for pagination, use the cursor from the response to retrieve the next page. | abc123 |
page_size | int32 | Yes | A limit on the number of objects to be returned. Ranges from 1 to 100. Default is 10. | 10 |
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.risks | array of object | ||
data.cursor | string | abc123 | Cursor for pagination, use the cursor from the response to retrieve the next page. |
data.has_more | bool | true | Whether more comments are available |
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 | array of objects | 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 |