get
https://{subdomain}.myshoplaza.com/openapi/2025-06/orders//risks
Provides detailed risk assessment information for a specific order.
Requiresread_orderaccess scope. More access scope
The Order Risk API provides detailed risk assessment information for a specific order. This allows merchants to better understand the potential risks associated with an order.
This API is especially useful for:
- Reviewing detailed risk assessments for an order.
- Identifying possible fraudulent or risky activities.
- Making data-driven decisions on whether to proceed with fulfilling the order.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
order_id | string | Yes | Unique identifier for the order | ord_123456 |
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.assessments | array of strings | ["high_risk_country", "unusual_payment_method"] | List of general risk assessments for the order |
data.infos | array of objects | [ {...}, {...} ] | Detailed risk category information |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |