🔒
Requires read_order access scope. More access scope

The Order Risk List API provides a list of risks associated with a specific order. This helps merchants review all flagged risks for the given order in a paginated format.

This API is especially useful for:

Fetching all risks flagged for an order.
Facilitating review and risk management processes.
Enabling data-driven decision-making regarding flagged risks.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Query Parameters

Parameter	Type	Required	Description	Example
`page`	int32	No	Page number for pagination. Default is `1`.	`1`
`per_page`	int32	No	Limit per page for pagination. Maximum is `100`.	`10`

Body Parameters

Parameter	Type	Required	Description	Example
`risk`	object	Yes	The order risk object containing risk details.	`{...}`
`risk.level`	string	Yes	Risk level for the order. Possible values: `low`, `medium`, `high`.	`low`
`risk.values`	array of strings	No	List of risk details explaining the reason for the risk.	`["wrong order price"]`
`properties`	object	No	Custom properties for the order risk.	`{ "key": "value" }`
`properties.key`	string	No	Key for the custom property.	`key`

Response Description

Public Response Fields

📘
Public Response Parameters

Success Response

Field	Type	Description	Example
`total`	int	Total number of risks for the given order.	`4`
`risks[].id`	string	The unique ID of the risk.	`372997190468224746`
`risks[].order_id`	string	The unique ID of the associated order.	`633130-00000015`
`risks[].level`	string	Risk level for the order. Possible values: `low`, `medium`, `high`.	`low`
`risks[].value`	array of strings	Details explaining the reason for the risk.	`["wrong order price"]`
`risks[].properties.key`	string	Key for custom properties related to the risk.	`key`
`risks[].created_at`	string	Timestamp when the risk was created (ISO 8601 format).	`2024-04-25T06:37:40Z`
`risks[].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`
404	Not Found	Unable to find resource	Unable to find resource