The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.
Requires
orders
access scope.
The Order Risk resource allows you to create, retrieve, update, and delete order risks. Order risks represent the results of fraud checks that have been completed for an order.
Usage notes
- This resource is deprecated in version 2024-04. Please refer to the GraphQL api for Order#field-order-risk
- When determining an order's risk level, Shopify takes into account only those order risks that have the display property set to
true
. Orders with a display set tofalse
will not be returned through the Order Risk resource. It's not advised to create order risks with a display set tofalse
. This property might be removed in future API versions. - Risk assessments will favor the most severe risk recommendation for an order. Keep this in mind when creating new order risks.
Was this section helpful?
Properties
cause_cancel
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
deprecated
The ID of the checkout that the order risk belongs to.
display
deprecated
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.It's not advised to create order risks with a display set to false
.
id
deprecated
A unique numeric identifier for the order risk.
merchant_message
deprecated
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
.message
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
.order_id
->id
The ID of the order that the order risk belongs to.
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
->provider
The source of the order risk.
Was this section helpful?
Creates an order risk for an order
api_version
string
required
order_id
string
required
Was this section helpful?
Path parameters
string
required
Was this section helpful?
Retrieves a list of all order risks for an order. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.
api_version
string
required
order_id
string
required
Was this section helpful?
Path parameters
string
required
Was this section helpful?
Retrieves a single order risk by its ID
api_version
string
required
order_id
string
required
risk_id
string
required
Was this section helpful?
Was this section helpful?
Updates an order risk
api_version
string
required
order_id
string
required
risk_id
string
required
Was this section helpful?
Was this section helpful?
Deletes an order risk for an order
api_version
string
required
order_id
string
required
risk_id
string
required
Was this section helpful?
Was this section helpful?