Anchor to section titled 'undefined'order
order
mutation
2024-10latest
Requires write access scope. Also: Access to orders is required to provide risk assessments.
Create a risk assessment for an order.
Anchor to section titled 'Arguments'
Arguments
The input fields required to create a risk assessment.
Was this section helpful?
Anchor to section titled 'OrderRiskAssessmentCreatePayload returns'
OrderRiskAssessmentCreatePayload returns
The order risk assessment created.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: orderRiskAssessmentCreate
Query Reference for MUTATION: orderRiskAssessmentCreate
"mutation orderRiskAssessmentCreate($orderRiskAssessmentInput: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $orderRiskAssessmentInput) {\n orderRiskAssessment {\n # OrderRiskAssessment fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: orderRiskAssessmentCreate
"{\n \"orderRiskAssessmentInput\": {\n \"facts\": [\n {\n \"description\": \"<your-description>\",\n \"sentiment\": \"NEGATIVE\"\n }\n ],\n \"orderId\": \"gid://shopify/<objectName>/10079785100\",\n \"riskLevel\": \"HIGH\"\n }\n}"Schema Reference for MUTATION: orderRiskAssessmentCreate
"input OrderRiskAssessmentCreateInput {\n facts: [OrderRiskAssessmentFactInput!]!\n orderId: ID!\n riskLevel: RiskAssessmentResult!\n}\n\ninput OrderRiskAssessmentFactInput {\n description: String!\n sentiment: RiskFactSentiment!\n}\n"Display Examples for MUTATION: orderRiskAssessmentCreate
[
{
"example": {
"type_name": "orderriskassessmentcreate",
"title": "Create a risk assessment for an order",
"description": "Create a risk assessment for an order, providing a few facts.",
"query_string": "mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n}",
"variables": {
"input": {
"orderId": "gid://shopify/Order/148977776",
"riskLevel": "LOW",
"facts": [
{
"description": "Payment verification successful.",
"sentiment": "POSITIVE"
},
{
"description": "Buyer verification inconclusive.",
"sentiment": "NEUTRAL"
}
]
}
},
"response": {
"data": {
"orderRiskAssessmentCreate": {
"userErrors": [],
"orderRiskAssessment": {
"facts": [
{
"description": "Payment verification successful.",
"sentiment": "POSITIVE"
},
{
"description": "Buyer verification inconclusive.",
"sentiment": "NEUTRAL"
}
],
"provider": {
"title": "Risk API client"
},
"riskLevel": "LOW"
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/reviews/test/unit/graph_api/admin/mutations/order_risk_assessment_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) { orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) { userErrors { field message } orderRiskAssessment { facts { description sentiment } provider { title } riskLevel } } }\",\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/148977776\",\n \"riskLevel\": \"LOW\",\n \"facts\": [\n {\n \"description\": \"Payment verification successful.\",\n \"sentiment\": \"POSITIVE\"\n },\n {\n \"description\": \"Buyer verification inconclusive.\",\n \"sentiment\": \"NEUTRAL\"\n }\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/148977776\",\n \"riskLevel\": \"LOW\",\n \"facts\": [\n {\n \"description\": \"Payment verification successful.\",\n \"sentiment\": \"POSITIVE\"\n },\n {\n \"description\": \"Buyer verification inconclusive.\",\n \"sentiment\": \"NEUTRAL\"\n }\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/148977776\",\n \"riskLevel\": \"LOW\",\n \"facts\": [{\"description\"=>\"Payment verification successful.\", \"sentiment\"=>\"POSITIVE\"}, {\"description\"=>\"Buyer verification inconclusive.\", \"sentiment\"=>\"NEUTRAL\"}]\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/148977776\",\n \"riskLevel\": \"LOW\",\n \"facts\": [\n {\n \"description\": \"Payment verification successful.\",\n \"sentiment\": \"POSITIVE\"\n },\n {\n \"description\": \"Buyer verification inconclusive.\",\n \"sentiment\": \"NEUTRAL\"\n }\n ]\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"orderId\" => \"gid://shopify/Order/148977776\",\n \"riskLevel\" => \"LOW\",\n \"facts\" => [{\"description\"=>\"Payment verification successful.\", \"sentiment\"=>\"POSITIVE\"}, {\"description\"=>\"Buyer verification inconclusive.\", \"sentiment\"=>\"NEUTRAL\"}],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
},
{
"example": {
"type_name": "orderriskassessmentcreate",
"title": "Create a risk assessment for an order, in the pending state",
"description": "Create a risk assessment for an order, in the pending state.",
"query_string": "mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n}",
"variables": {
"input": {
"orderId": "gid://shopify/Order/148977776",
"riskLevel": "PENDING",
"facts": [
{
"description": "Analysis is underway.",
"sentiment": "NEUTRAL"
}
]
}
},
"response": {
"data": {
"orderRiskAssessmentCreate": {
"userErrors": [],
"orderRiskAssessment": {
"facts": [
{
"description": "Analysis is underway.",
"sentiment": "NEUTRAL"
}
],
"provider": {
"title": "Risk API client"
},
"riskLevel": "PENDING"
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/reviews/test/unit/graph_api/admin/mutations/order_risk_assessment_create_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) { orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) { userErrors { field message } orderRiskAssessment { facts { description sentiment } provider { title } riskLevel } } }\",\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/148977776\",\n \"riskLevel\": \"PENDING\",\n \"facts\": [\n {\n \"description\": \"Analysis is underway.\",\n \"sentiment\": \"NEUTRAL\"\n }\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/148977776\",\n \"riskLevel\": \"PENDING\",\n \"facts\": [\n {\n \"description\": \"Analysis is underway.\",\n \"sentiment\": \"NEUTRAL\"\n }\n ]\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/148977776\",\n \"riskLevel\": \"PENDING\",\n \"facts\": [{\"description\"=>\"Analysis is underway.\", \"sentiment\"=>\"NEUTRAL\"}]\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"orderId\": \"gid://shopify/Order/148977776\",\n \"riskLevel\": \"PENDING\",\n \"facts\": [\n {\n \"description\": \"Analysis is underway.\",\n \"sentiment\": \"NEUTRAL\"\n }\n ]\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {\n orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {\n userErrors {\n field\n message\n }\n orderRiskAssessment {\n facts {\n description\n sentiment\n }\n provider {\n title\n }\n riskLevel\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"orderId\" => \"gid://shopify/Order/148977776\",\n \"riskLevel\" => \"PENDING\",\n \"facts\" => [{\"description\"=>\"Analysis is underway.\", \"sentiment\"=>\"NEUTRAL\"}],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": []
}
]