Requires write_order access scope. More access scope
The Update Order Risk API allows merchants to modify the risk level and associated details of an order. This enables businesses to reassess risks dynamically and adjust mitigation strategies accordingly.
This API is especially useful for:
Updating the risk assessment of an order after manual or automated review.
Customizing risk management workflows for specific orders.
Enhancing order security by adjusting risk details dynamically.
The unique ID of the order associated with the risk.
633130-00000015
risk.level
string
Risk level for the order. Possible values: low, medium, high.
low
risk.value
array of strings
List of reasons or details for the risk.
["wrong order price"]
properties.key
string
Key for the custom property.
key
created_at
string
Timestamp when the risk was created (ISO 8601 format).
2024-04-25T06:37:40Z
updated_at
string
Timestamp when the risk was last updated (ISO 8601 format).
2024-04-25T06:37:40Z
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
Field
Type
Example
Description
errors
Array
[ "file number error"]
A list of errors encountered during the request processing.
Field
Type
Example
Description
error
String
"store is not active"
Indicates an error encountered during the process
Error Detail
Status Code
Message
Possible Reason
Example Response
400
Bad Request
Invalid input format or request structure (e.g., missing required fields or incorrect data types).
Bad Request
Unauthorized
The request is missing valid authentication credentials or the credentials provided are invalid.
Unauthorized
422
Unprocessable Entity
missing required field.
"Details is required"
missing required field.
"Level is required"
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
