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-10 (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 2021-07 (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 2021-04

Represents a fraud check on an order.

Required access

read_orders access scope.

Fields

  • display (