Orders > Order Risks > orderRisksCreate
Commerce APIOrdersOrder RisksorderRisksCreate
orderRisksCreate
POST:order_risks.json

Description

Save order risk evaluation to an order.

Permission bit: "order_risks.create"

Topic: Order Risks

Arguments

data: OrderRiskCreate!

Main argument for mutations.


order_id: String!

Unique order identifier. See also: Unique Identifiers

Example: "or_EQzGqWoY"


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

billing_address: OrderRiskBillingAddressCreate


display: Boolean

Display this score or not

Example: true


external: Boolean

Whether this score comes from an external service or from an internal one

Example: true


message: String

Message describing the problem with order

Example: ""

Valid when: message's length doesn't exceed 4096 characters


order_canceled: Boolean

If order was canceled or not by risk evaluation service

Example: false


risk_level: RiskLevel!

Risk level classification


score: Float!

Risk score, from 0.0 to 1.0, 0 is the lowest risk, 1 is maximum risk

Example: 0.0

Valid when: score is in range: 0.0 ≤ score ≤ 1.0


shipping: OrderRiskShippingCreate


shipping_address: OrderRiskShippingAddressCreate


Result

OrderRisk

Preview (typescript)

Loading module