API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

OrderRisk object

Version unstable

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk

Version 2021-01 (Release candidate)

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk

Version 2020-10 (Latest)

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk

Version 2020-07

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk

Version 2020-04

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk

Version 2020-01

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk

Version 2019-10 (Unsupported)

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk

Version 2019-07 (Unsupported)

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk

Version 2019-04 (Unsupported)

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

display (Boolean!)

Whether the risk level is shown in the Shopify admin. If false, then this order risk is ignored when Shopify determines the overall risk level for the order.

level (OrderRiskLevel)

The likelihood that an order is fraudulent, based on this order risk.

The level can be set by Shopify risk analysis or by an app.

message (String)

The risk message that's shown to the merchant in the Shopify admin.

Types that return OrderRisk