get https://{shopdomain}.myshoplaza.com/openapi/2022-01/orders//risks
Requires
read_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 |
|---|---|---|---|---|
id | string | Yes | The unique ID of the order. | 633130-00000015 |
Response Description
Public Response Fields
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
assessment | array of strings | List of general risk assessments for the order. | ["The Location of IP address used to place the order"] |
info[].title | string | The title or name of the risk category. | "OpenAPI" |
info[].describe | string | Detailed description of the risk, including the risk level and context. | {"level":"high"} |
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" |