Order Risk

Version 2019-04

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:

POST /admin/api/2019-04/orders/{order_id}/risks.json Creates an order risk for an order
GET /admin/api/2019-04/orders/{order_id}/risks.json Retrieves a list of all order risks for an order
GET /admin/api/2019-04/orders/{order_id}/risks/{risk_id}.json Retrieves a single order risk by its ID
PUT /admin/api/2019-04/orders/{order_id}/risks/{risk_id}.json Updates an order risk
DELETE /admin/api/2019-04/orders/{order_id}/risks/{risk_id}.json Deletes an order risk for an order

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 to`true`. Use `message` instead.
message	`"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 to`true`.
order_id	`"order_id": 450789469` The ID of the order that the order risk belongs to.
recommendation	`"recommendation": "cancel"` The recommended action given to the merchant. Valid values: cancel: There is a high level of risk that this order is fraudulent. The merchant should cancel the order. investigate: There is a medium level of risk that this order is fraudulent. The merchant should investigate the order. accept: There is a low level of risk that this order is fraudulent. The order risk found no indication of fraud.
score	`"score": 1.0` 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	`"source": "External"` The source of the order risk.

Endpoints

POST /admin/api/2019-04/orders/{order_id}/risks.json

Creates an order risk for an order

Create an order risk showing a fraud risk for proxy detection

POST /admin/api/2020-04/orders/450789469/risks.json

{
  "risk": {
    "message": "This order came from an anonymous proxy",
    "recommendation": "cancel",
    "score": 1.0,
    "source": "External",
    "cause_cancel": true,
    "display": true
  }
}

View Response

HTTP/1.1 201 Created
{
  "risk": {
    "id": 700140155,
    "order_id": 450789469,
    "checkout_id": 901414060,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order came from an anonymous proxy",
    "merchant_message": "This order came from an anonymous proxy"
  }
}

GET /admin/api/2019-04/orders/{order_id}/risks.json

Retrieves a list of all order risks for an order.

Retrieve all order risks for an order

GET /admin/api/2019-07/orders/450789469/risks.json

View Response

HTTP/1.1 200 OK
{
  "risks": [
    {
      "id": 284138680,
      "order_id": 450789469,
      "checkout_id": null,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order was placed from a proxy IP",
      "merchant_message": "This order was placed from a proxy IP"
    },
    {
      "id": 700140156,
      "order_id": 450789469,
      "checkout_id": 901414060,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order came from an anonymous proxy",
      "merchant_message": "This order came from an anonymous proxy"
    }
  ]
}

GET /admin/api/2019-04/orders/{order_id}/risks/{risk_id}.json

Retrieves a single order risk by its ID

Retrieve a single order risk

GET /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order was placed from a proxy IP",
    "merchant_message": "This order was placed from a proxy IP"
  }
}

PUT /admin/api/2019-04/orders/{order_id}/risks/{risk_id}.json

Updates an order risk

Update an existing order risk for an order

PUT /admin/api/2020-04/orders/450789469/risks/284138680.json

{
  "risk": {
    "id": 284138680,
    "message": "After further review, this is a legitimate order",
    "recommendation": "accept",
    "source": "External",
    "cause_cancel": false,
    "score": 0.0
  }
}

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "0.0",
    "recommendation": "accept",
    "display": true,
    "cause_cancel": false,
    "message": "After further review, this is a legitimate order",
    "merchant_message": "After further review, this is a legitimate order"
  }
}

DELETE /admin/api/2019-04/orders/{order_id}/risks/{risk_id}.json

Deletes an order risk for an order

Delete an order risk for an order

DELETE /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
}

Version 2019-07

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:

POST /admin/api/2019-07/orders/{order_id}/risks.json Creates an order risk for an order
GET /admin/api/2019-07/orders/{order_id}/risks.json Retrieves a list of all order risks for an order
GET /admin/api/2019-07/orders/{order_id}/risks/{risk_id}.json Retrieves a single order risk by its ID
PUT /admin/api/2019-07/orders/{order_id}/risks/{risk_id}.json Updates an order risk
DELETE /admin/api/2019-07/orders/{order_id}/risks/{risk_id}.json Deletes an order risk for an order

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 to`true`. Use `message` instead.
message	`"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 to`true`.
order_id	`"order_id": 450789469` The ID of the order that the order risk belongs to.
recommendation	`"recommendation": "cancel"` The recommended action given to the merchant. Valid values: cancel: There is a high level of risk that this order is fraudulent. The merchant should cancel the order. investigate: There is a medium level of risk that this order is fraudulent. The merchant should investigate the order. accept: There is a low level of risk that this order is fraudulent. The order risk found no indication of fraud.
score	`"score": 1.0` 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	`"source": "External"` The source of the order risk.

Endpoints

POST /admin/api/2019-07/orders/{order_id}/risks.json

Creates an order risk for an order

Create an order risk showing a fraud risk for proxy detection

POST /admin/api/2020-04/orders/450789469/risks.json

{
  "risk": {
    "message": "This order came from an anonymous proxy",
    "recommendation": "cancel",
    "score": 1.0,
    "source": "External",
    "cause_cancel": true,
    "display": true
  }
}

View Response

HTTP/1.1 201 Created
{
  "risk": {
    "id": 700140155,
    "order_id": 450789469,
    "checkout_id": 901414060,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order came from an anonymous proxy",
    "merchant_message": "This order came from an anonymous proxy"
  }
}

GET /admin/api/2019-07/orders/{order_id}/risks.json

Retrieves a list of all order risks for an order.

Retrieve all order risks for an order

GET /admin/api/2019-07/orders/450789469/risks.json

View Response

HTTP/1.1 200 OK
{
  "risks": [
    {
      "id": 284138680,
      "order_id": 450789469,
      "checkout_id": null,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order was placed from a proxy IP",
      "merchant_message": "This order was placed from a proxy IP"
    },
    {
      "id": 700140156,
      "order_id": 450789469,
      "checkout_id": 901414060,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order came from an anonymous proxy",
      "merchant_message": "This order came from an anonymous proxy"
    }
  ]
}

GET /admin/api/2019-07/orders/{order_id}/risks/{risk_id}.json

Retrieves a single order risk by its ID

Retrieve a single order risk

GET /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order was placed from a proxy IP",
    "merchant_message": "This order was placed from a proxy IP"
  }
}

PUT /admin/api/2019-07/orders/{order_id}/risks/{risk_id}.json

Updates an order risk

Update an existing order risk for an order

PUT /admin/api/2020-04/orders/450789469/risks/284138680.json

{
  "risk": {
    "id": 284138680,
    "message": "After further review, this is a legitimate order",
    "recommendation": "accept",
    "source": "External",
    "cause_cancel": false,
    "score": 0.0
  }
}

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "0.0",
    "recommendation": "accept",
    "display": true,
    "cause_cancel": false,
    "message": "After further review, this is a legitimate order",
    "merchant_message": "After further review, this is a legitimate order"
  }
}

DELETE /admin/api/2019-07/orders/{order_id}/risks/{risk_id}.json

Deletes an order risk for an order

Delete an order risk for an order

DELETE /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
}

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:

POST /admin/api/2019-10/orders/{order_id}/risks.json Creates an order risk for an order
GET /admin/api/2019-10/orders/{order_id}/risks.json Retrieves a list of all order risks for an order
GET /admin/api/2019-10/orders/{order_id}/risks/{risk_id}.json Retrieves a single order risk by its ID
PUT /admin/api/2019-10/orders/{order_id}/risks/{risk_id}.json Updates an order risk
DELETE /admin/api/2019-10/orders/{order_id}/risks/{risk_id}.json Deletes an order risk for an order

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 to`true`. Use `message` instead.
message	`"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 to`true`.
order_id	`"order_id": 450789469` The ID of the order that the order risk belongs to.
recommendation	`"recommendation": "cancel"` The recommended action given to the merchant. Valid values: cancel: There is a high level of risk that this order is fraudulent. The merchant should cancel the order. investigate: There is a medium level of risk that this order is fraudulent. The merchant should investigate the order. accept: There is a low level of risk that this order is fraudulent. The order risk found no indication of fraud.
score	`"score": 1.0` 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	`"source": "External"` The source of the order risk.

Endpoints

POST /admin/api/2019-10/orders/{order_id}/risks.json

Creates an order risk for an order

Create an order risk showing a fraud risk for proxy detection

POST /admin/api/2020-04/orders/450789469/risks.json

{
  "risk": {
    "message": "This order came from an anonymous proxy",
    "recommendation": "cancel",
    "score": 1.0,
    "source": "External",
    "cause_cancel": true,
    "display": true
  }
}

View Response

HTTP/1.1 201 Created
{
  "risk": {
    "id": 700140155,
    "order_id": 450789469,
    "checkout_id": 901414060,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order came from an anonymous proxy",
    "merchant_message": "This order came from an anonymous proxy"
  }
}

GET /admin/api/2019-10/orders/{order_id}/risks.json

Retrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

Retrieve all order risks for an order

GET /admin/api/2020-04/orders/450789469/risks.json

View Response

HTTP/1.1 200 OK
{
  "risks": [
    {
      "id": 284138680,
      "order_id": 450789469,
      "checkout_id": null,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order was placed from a proxy IP",
      "merchant_message": "This order was placed from a proxy IP"
    },
    {
      "id": 700140154,
      "order_id": 450789469,
      "checkout_id": 901414060,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order came from an anonymous proxy",
      "merchant_message": "This order came from an anonymous proxy"
    }
  ]
}

GET /admin/api/2019-10/orders/{order_id}/risks/{risk_id}.json

Retrieves a single order risk by its ID

Retrieve a single order risk

GET /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order was placed from a proxy IP",
    "merchant_message": "This order was placed from a proxy IP"
  }
}

PUT /admin/api/2019-10/orders/{order_id}/risks/{risk_id}.json

Updates an order risk

Update an existing order risk for an order

PUT /admin/api/2020-04/orders/450789469/risks/284138680.json

{
  "risk": {
    "id": 284138680,
    "message": "After further review, this is a legitimate order",
    "recommendation": "accept",
    "source": "External",
    "cause_cancel": false,
    "score": 0.0
  }
}

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "0.0",
    "recommendation": "accept",
    "display": true,
    "cause_cancel": false,
    "message": "After further review, this is a legitimate order",
    "merchant_message": "After further review, this is a legitimate order"
  }
}

DELETE /admin/api/2019-10/orders/{order_id}/risks/{risk_id}.json

Deletes an order risk for an order

Delete an order risk for an order

DELETE /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
}

Version 2020-01

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:

POST /admin/api/2020-01/orders/{order_id}/risks.json Creates an order risk for an order
GET /admin/api/2020-01/orders/{order_id}/risks.json Retrieves a list of all order risks for an order
GET /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json Retrieves a single order risk by its ID
PUT /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json Updates an order risk
DELETE /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json Deletes an order risk for an order

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 to`true`. Use `message` instead.
message	`"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 to`true`.
order_id	`"order_id": 450789469` The ID of the order that the order risk belongs to.
recommendation	`"recommendation": "cancel"` The recommended action given to the merchant. Valid values: cancel: There is a high level of risk that this order is fraudulent. The merchant should cancel the order. investigate: There is a medium level of risk that this order is fraudulent. The merchant should investigate the order. accept: There is a low level of risk that this order is fraudulent. The order risk found no indication of fraud.
score	`"score": 1.0` 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	`"source": "External"` The source of the order risk.

Endpoints

POST /admin/api/2020-01/orders/{order_id}/risks.json

Creates an order risk for an order

Create an order risk showing a fraud risk for proxy detection

POST /admin/api/2020-04/orders/450789469/risks.json

{
  "risk": {
    "message": "This order came from an anonymous proxy",
    "recommendation": "cancel",
    "score": 1.0,
    "source": "External",
    "cause_cancel": true,
    "display": true
  }
}

View Response

HTTP/1.1 201 Created
{
  "risk": {
    "id": 700140155,
    "order_id": 450789469,
    "checkout_id": 901414060,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order came from an anonymous proxy",
    "merchant_message": "This order came from an anonymous proxy"
  }
}

GET /admin/api/2020-01/orders/{order_id}/risks.json

Retrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

Retrieve all order risks for an order

GET /admin/api/2020-04/orders/450789469/risks.json

View Response

HTTP/1.1 200 OK
{
  "risks": [
    {
      "id": 284138680,
      "order_id": 450789469,
      "checkout_id": null,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order was placed from a proxy IP",
      "merchant_message": "This order was placed from a proxy IP"
    },
    {
      "id": 700140154,
      "order_id": 450789469,
      "checkout_id": 901414060,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order came from an anonymous proxy",
      "merchant_message": "This order came from an anonymous proxy"
    }
  ]
}

GET /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json

Retrieves a single order risk by its ID

Retrieve a single order risk

GET /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order was placed from a proxy IP",
    "merchant_message": "This order was placed from a proxy IP"
  }
}

PUT /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json

Updates an order risk

Update an existing order risk for an order

PUT /admin/api/2020-04/orders/450789469/risks/284138680.json

{
  "risk": {
    "id": 284138680,
    "message": "After further review, this is a legitimate order",
    "recommendation": "accept",
    "source": "External",
    "cause_cancel": false,
    "score": 0.0
  }
}

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "0.0",
    "recommendation": "accept",
    "display": true,
    "cause_cancel": false,
    "message": "After further review, this is a legitimate order",
    "merchant_message": "After further review, this is a legitimate order"
  }
}

DELETE /admin/api/2020-01/orders/{order_id}/risks/{risk_id}.json

Deletes an order risk for an order

Delete an order risk for an order

DELETE /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
}

Version 2020-04 (Latest)

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:

POST /admin/api/2020-04/orders/{order_id}/risks.json Creates an order risk for an order
GET /admin/api/2020-04/orders/{order_id}/risks.json Retrieves a list of all order risks for an order
GET /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json Retrieves a single order risk by its ID
PUT /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json Updates an order risk
DELETE /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json Deletes an order risk for an order

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 to`true`. Use `message` instead.
message	`"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 to`true`.
order_id	`"order_id": 450789469` The ID of the order that the order risk belongs to.
recommendation	`"recommendation": "cancel"` The recommended action given to the merchant. Valid values: cancel: There is a high level of risk that this order is fraudulent. The merchant should cancel the order. investigate: There is a medium level of risk that this order is fraudulent. The merchant should investigate the order. accept: There is a low level of risk that this order is fraudulent. The order risk found no indication of fraud.
score	`"score": 1.0` 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	`"source": "External"` The source of the order risk.

Endpoints

POST /admin/api/2020-04/orders/{order_id}/risks.json

Creates an order risk for an order

Create an order risk showing a fraud risk for proxy detection

POST /admin/api/2020-04/orders/450789469/risks.json

{
  "risk": {
    "message": "This order came from an anonymous proxy",
    "recommendation": "cancel",
    "score": 1.0,
    "source": "External",
    "cause_cancel": true,
    "display": true
  }
}

View Response

HTTP/1.1 201 Created
{
  "risk": {
    "id": 700140155,
    "order_id": 450789469,
    "checkout_id": 901414060,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order came from an anonymous proxy",
    "merchant_message": "This order came from an anonymous proxy"
  }
}

GET /admin/api/2020-04/orders/{order_id}/risks.json

Retrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

Retrieve all order risks for an order

GET /admin/api/2020-04/orders/450789469/risks.json

View Response

HTTP/1.1 200 OK
{
  "risks": [
    {
      "id": 284138680,
      "order_id": 450789469,
      "checkout_id": null,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order was placed from a proxy IP",
      "merchant_message": "This order was placed from a proxy IP"
    },
    {
      "id": 700140154,
      "order_id": 450789469,
      "checkout_id": 901414060,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order came from an anonymous proxy",
      "merchant_message": "This order came from an anonymous proxy"
    }
  ]
}

GET /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json

Retrieves a single order risk by its ID

Retrieve a single order risk

GET /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order was placed from a proxy IP",
    "merchant_message": "This order was placed from a proxy IP"
  }
}

PUT /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json

Updates an order risk

Update an existing order risk for an order

PUT /admin/api/2020-04/orders/450789469/risks/284138680.json

{
  "risk": {
    "id": 284138680,
    "message": "After further review, this is a legitimate order",
    "recommendation": "accept",
    "source": "External",
    "cause_cancel": false,
    "score": 0.0
  }
}

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "0.0",
    "recommendation": "accept",
    "display": true,
    "cause_cancel": false,
    "message": "After further review, this is a legitimate order",
    "merchant_message": "After further review, this is a legitimate order"
  }
}

DELETE /admin/api/2020-04/orders/{order_id}/risks/{risk_id}.json

Deletes an order risk for an order

Delete an order risk for an order

DELETE /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
}

Version 2020-07 (Release candidate)

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:

POST /admin/api/2020-07/orders/{order_id}/risks.json Creates an order risk for an order
GET /admin/api/2020-07/orders/{order_id}/risks.json Retrieves a list of all order risks for an order
GET /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json Retrieves a single order risk by its ID
PUT /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json Updates an order risk
DELETE /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json Deletes an order risk for an order

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 to`true`. Use `message` instead.
message	`"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 to`true`.
order_id	`"order_id": 450789469` The ID of the order that the order risk belongs to.
recommendation	`"recommendation": "cancel"` The recommended action given to the merchant. Valid values: cancel: There is a high level of risk that this order is fraudulent. The merchant should cancel the order. investigate: There is a medium level of risk that this order is fraudulent. The merchant should investigate the order. accept: There is a low level of risk that this order is fraudulent. The order risk found no indication of fraud.
score	`"score": 1.0` 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	`"source": "External"` The source of the order risk.

Endpoints

POST /admin/api/2020-07/orders/{order_id}/risks.json

Creates an order risk for an order

Create an order risk showing a fraud risk for proxy detection

POST /admin/api/2020-04/orders/450789469/risks.json

{
  "risk": {
    "message": "This order came from an anonymous proxy",
    "recommendation": "cancel",
    "score": 1.0,
    "source": "External",
    "cause_cancel": true,
    "display": true
  }
}

View Response

HTTP/1.1 201 Created
{
  "risk": {
    "id": 700140155,
    "order_id": 450789469,
    "checkout_id": 901414060,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order came from an anonymous proxy",
    "merchant_message": "This order came from an anonymous proxy"
  }
}

GET /admin/api/2020-07/orders/{order_id}/risks.json

Retrieves a list of all order risks for an order. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

Retrieve all order risks for an order

GET /admin/api/2020-04/orders/450789469/risks.json

View Response

HTTP/1.1 200 OK
{
  "risks": [
    {
      "id": 284138680,
      "order_id": 450789469,
      "checkout_id": null,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order was placed from a proxy IP",
      "merchant_message": "This order was placed from a proxy IP"
    },
    {
      "id": 700140154,
      "order_id": 450789469,
      "checkout_id": 901414060,
      "source": "External",
      "score": "1.0",
      "recommendation": "cancel",
      "display": true,
      "cause_cancel": true,
      "message": "This order came from an anonymous proxy",
      "merchant_message": "This order came from an anonymous proxy"
    }
  ]
}

GET /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json

Retrieves a single order risk by its ID

Retrieve a single order risk

GET /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "1.0",
    "recommendation": "cancel",
    "display": true,
    "cause_cancel": true,
    "message": "This order was placed from a proxy IP",
    "merchant_message": "This order was placed from a proxy IP"
  }
}

PUT /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json

Updates an order risk

Update an existing order risk for an order

PUT /admin/api/2020-04/orders/450789469/risks/284138680.json

{
  "risk": {
    "id": 284138680,
    "message": "After further review, this is a legitimate order",
    "recommendation": "accept",
    "source": "External",
    "cause_cancel": false,
    "score": 0.0
  }
}

View Response

HTTP/1.1 200 OK
{
  "risk": {
    "id": 284138680,
    "order_id": 450789469,
    "checkout_id": null,
    "source": "External",
    "score": "0.0",
    "recommendation": "accept",
    "display": true,
    "cause_cancel": false,
    "message": "After further review, this is a legitimate order",
    "merchant_message": "After further review, this is a legitimate order"
  }
}

DELETE /admin/api/2020-07/orders/{order_id}/risks/{risk_id}.json

Deletes an order risk for an order

Delete an order risk for an order

DELETE /admin/api/2020-04/orders/450789469/risks/284138680.json

View Response

HTTP/1.1 200 OK
{
}