Add risk fraud

Requires write_orders access scope.

For more info , refer to:

[]

access permission

POST https://{handle}.myshopline.com/admin/openapi/v20250601/orders/v2/:order_id/risks.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Path Parameters

order_id string required
[]
Order id
[]
Example: "21056863763067384710591058"

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

riskobject required
[]
Order risk information
cause_cancel boolean required
[]
Cancel order logo , true- cancel , false- do not cancel
[]
Example: true
checkout_id string
[]
Order associated discard id
[]
Example: 2405664692071577423882
display boolean required
[]
Show the logo on the detail page , true- display , false- not display or not
[]
Example: true
recommendation string required
[]
Fraud risk rating : cancel ( high risk ) 、investigate ( medium risk ) 、accept ( low risk )
[]
Example: cancel
risk_detail_msg_listobject[]
[]
Fraud risk details node
message string required
[]
Fraud risk node details
[]
Example: "risk detail message"
risk_detail_level string required
[]
Fraud risk node details category : cancel ( high risk ) 、investigate ( medium risk ) 、accept ( low risk )
[]
Example: cancel
score string required
[]
Fraud risk score , 0.0-1.0 , 1 score the highest risk
[]
Example: 1.0
source string required
[]
Source logo , fixed to : External- external
[]
Example: External

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

riskobject
[]
Risk fraud information
cause_cancel boolean
[]
Cancel order logo , true- cancel , false- do not cancel
[]
Example: true
checkout_id string
[]
Order associated discard id
[]
Example: "2405664692071577423882"
display boolean
[]
Show the logo on the detail page , true- display , false- not display or not
[]
Example: true
id string
[]
Fraud risk id
[]
Example: "2905664692071577423886"
order_id string
[]
Order serial number
[]
Example: "21056646934598417162363882"
recommendation string
[]
Fraud risk rating : cancel ( high risk ) 、investigate ( medium risk ) 、accept ( low risk )
[]
Example: "cancel"
risk_detail_msg_listobject[]
[]
Fraud risk details node
message string
[]
Fraud risk node details
[]
Example: "risk detail message"
risk_detail_level string
[]
Fraud risk node details category : cancel ( high risk ) 、investigate ( medium risk ) 、accept ( low risk )
[]
Example: cancel
score string
[]
Fraud risk score , 0-1 , 1 score the highest risk score
[]
Example: "1.0"
source string
[]
Source logo , Internal- internal 、External- external
[]
Example: "External"

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

order_id — path required

Authorization — header required

Body

Body required

{
  "risk": {
    "cause_cancel": true,
    "checkout_id": "2405664692071577423882",
    "display": true,
    "recommendation": "cancel",
    "risk_detail_msg_list": [
      {
        "message": "\"risk detail message\"",
        "risk_detail_level": "cancel"
      }
    ],
    "score": "1.0",
    "source": "External"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/orders/v2/order_id/risks.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal