OrderRisks
Create, update, delete, and query order risks.
Table-Specific Information
Select
The cmdlet uses the Shopify API to process WHERE clause conditions built with the following column and operator. The cmdlet processes other filters client-side within the cmdlet.
- Id supports the '=,IN' comparison operators.
- OrderId supports the '=,IN' comparison operators.
For example, the following queries are processed server side:
SELECT * FROM OrderRisks
SELECT * FROM OrderRisks WHERE Id = 123
SELECT * FROM OrderRisks WHERE OrderId = 123
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Long | True |
A unique numeric identifier for the order risk. | |
CauseCancel | Bool | False |
Whether this order risk is severe enough to force the cancellation of the order. | |
CheckoutId | Long | True |
The ID of the checkout that the order risk belongs to. | |
Display | Bool | False |
Whether the order risk is displayed on the order details page in the Shopify admin. | |
Message | String | False |
The message that's displayed to the merchant to indicate the results of the fraud check. | |
OrderId | Long | True |
Orders.Id |
The ID of the order that the order risk belongs to. |
Recommendation | String | False |
The recommended action given to the merchant. | |
Score | Decimal | False |
For internal use only. A number between 0 and 1 that's assigned to the order. The closer the score is to 1, the more likely it is that the order is fraudulent. | |
Source | String | False |
The source of the order risk. |