get https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders//risks/
Requires
read_orderaccess scope. More access scope
Order Risk Detail API
The Order Risk Detail API retrieves the details of a specific risk associated with an order, providing insights into flagged risks for better decision-making.
This API is especially useful for:
- Reviewing specific risks flagged for an order.
- Enhancing fraud detection and order management processes.
- Providing detailed explanations for 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 |
id | string | Yes | The unique ID of the risk. | 372997190468224746 |
Response Description
Public Response Fields
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
risk.id | string | The unique ID of the risk. | 372997190468224746 |
risk.order_id | string | The unique ID of the associated order. | 633130-00000015 |
risk.level | string | Risk level for the order. Possible values: low, medium, high. | low |
risk.value | array of strings | Details explaining the reason for the risk. | ["wrong order price"] |
properties.key | string | Key for custom properties related to the risk. | key |
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
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 | |
| 422 | Unprocessable Entity | ID is invalid or empty | "Invalid ID" |
| 404 | Not Found | The record provided is not found | "Record not found" |