Order Risk

Version 2019-10

Order risks show the results of fraud checks that have been completed on an order. They appear in the Fraud analysis section of an order's details page in the Shopify admin.

The fraud analysis from your app shows each of the resulting messages from the order risks that your app has completed. It also shows the overall risk level for the order, which is determined by the order risk with the most severe recommendation. When determining an order's risk level, Shopify takes into account only those order risks that have the display property set to true.

What you can do with Order Risk

The Shopify API lets you do the following with the Order Risk resource. More detailed versions of these general actions may be available:

Order Risk properties

cause_cancel
"cause_cancel": false

Whether this order risk is severe enough to force the cancellation of the order. If true, then this order risk is included in the Order canceled message that's shown on the details page of the canceled order.

Note: Setting this property to true does not cancel the order. Use this property only if your app automatically cancels the order using the Order resource. If your app doesn't automatically cancel orders based on order risks, then leave this property set to false.

checkout_id
"checkout_id": 901414060

The ID of the checkout that the order risk belongs to.

display
"display": true

Whether the order risk is displayed on the order details page in the Shopify admin. If false, then this order risk is ignored when Shopify determines your app's overall risk level for the order.

This property can't be changed after an order risk is created.

id
"id": 284138680

A unique numeric identifier for the order risk.

merchant_message
deprecated
"merchant_message": "This order came from an anonymous proxy."

The message that's displayed to the merchant to indicate the results of the fraud check. The message is displayed only if display is set totrue.

Use message instead.

message
"message": "This order came from an anonymous proxy."

The message that's displayed to the merchant to in