Order Risk List

GET 
/openapi/2022-01/orders/:order_id/risks/list

Returns the custom risk records attached to the specified order, paginated via cursor. Each page contains up to page_size records (1-100, default 10); pass the cursor from the previous response to fetch the next page.

Request

Path Parameters

order_id stringrequired

Order's ID

Query Parameters

page int32

Page number

per_page int32

Limit per page

Responses

200

200

application/json

Schema

Schema

totalinteger
Default value: 0
Example: 4
risks object[]
Array [
idstring
Example: 372997190408224746
order_idstring
Example: 633130-00000015
levelstring
Example: low
valuestring[]
properties object
keystring
Example: value
created_atstring
Example: 2024-04-25T06:37:40Z
updated_atstring
Example: 2024-04-25T06:37:40Z
]

Example

{
  "total": 4,
  "risks": [
    {
      "id": "372997190408224746",
      "order_id": "633130-00000015",
      "level": "low",
      "value": [
        "wrong order price"
      ],
      "properties": {
        "key": "value"
      },
      "created_at": "2024-04-25T06:37:40Z",
      "updated_at": "2024-04-25T06:37:40Z"
    }
  ]
}

Result

{
  "total": 4,
  "risks": [
    {
      "id": "372997190408224746",
      "order_id": "633130-00000015",
      "level": "low",
      "value": [
        "wrong order price"
      ],
      "properties": {
        "key": "value"
      },
      "created_at": "2024-04-25T06:37:40Z",
      "updated_at": "2024-04-25T06:37:40Z"
    }
  ]
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Unable to find resource"
  ]
}

Result

{
  "errors": [
    "Unable to find resource"
  ]
}