Update Order Risk

PUT 
/openapi/2022-01/orders/:order_id/risks/:id

Modifies the risk level, detail reasons, or custom properties of an existing risk record on the order. The record is located by its id; the order itself is unchanged.

Request

Path Parameters

order_id stringrequired

Order's ID

id stringrequired

Risk's ID

application/json

Body

Body

risk object

levelstringrequired

Risk level, such as: low, medium, high

detailsstring[]required

Risk details list

properties object

Custom properties

keystring

value

Example

{
  "risk": {
    "level": "string",
    "details": [
      "string"
    ],
    "properties": {
      "key": "string"
    }
  }
}

Responses

200

200

application/json

Schema

Schema

risk object
idstring
Example: 372997190408224746
order_idstring
Example: 633130-00000015
levelstring
Example: medium
valuestring[]
properties object
keystring
Example: value
created_atstring
Example: 2024-04-25T06:37:40Z
updated_atstring
Example: 2024-04-25T07:38:11Z

Example

{
  "risk": {
    "id": "372997190408224746",
    "order_id": "633130-00000015",
    "level": "medium",
    "value": [
      "qqqqq"
    ],
    "properties": {
      "key": "value"
    },
    "created_at": "2024-04-25T06:37:40Z",
    "updated_at": "2024-04-25T07:38:11Z"
  }
}

Result

{
  "risk": {
    "id": "372997190408224746",
    "order_id": "633130-00000015",
    "level": "medium",
    "value": [
      "qqqqq"
    ],
    "properties": {
      "key": "value"
    },
    "created_at": "2024-04-25T06:37:40Z",
    "updated_at": "2024-04-25T07:38:11Z"
  }
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Details is required"
  ]
}

Result

{
  "errors": [
    "Details is required",
    "Level is required"
  ]
}