Anchor to section titled 'undefined'

orderRiskAssessmentCreate
mutation

Requires write_orders 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

Anchor to orderRiskAssessmentInput
orderRiskAssessmentInput
OrderRiskAssessmentCreateInput!
required

The input fields required to create a risk assessment.

Was this section helpful?
Anchor to section titled 'OrderRiskAssessmentCreatePayload returns'

OrderRiskAssessmentCreatePayload returns

Anchor to OrderRiskAssessmentCreatePayload.orderRiskAssessment
orderRiskAssessment
OrderRiskAssessment

The order risk assessment created.

Anchor to OrderRiskAssessmentCreatePayload.userErrors
userErrors
[OrderRiskAssessmentCreateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Hide code
DescriptionCopy
mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {
  orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {
    userErrors {
      field
      message
    }
    orderRiskAssessment {
      facts {
        description
        sentiment
      }
      provider {
        title
      }
      riskLevel
    }
  }
}
curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) { orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) { userErrors { field message } orderRiskAssessment { facts { description sentiment } provider { title } riskLevel } } }",
 "variables": {
    "input": {
      "orderId": "gid://shopify/Order/148977776",
      "riskLevel": "LOW",
      "facts": [
        {
          "description": "Payment verification successful.",
          "sentiment": "POSITIVE"
        },
        {
          "description": "Buyer verification inconclusive.",
          "sentiment": "NEUTRAL"
        }
      ]
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {
    orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {
      userErrors {
        field
        message
      }
      orderRiskAssessment {
        facts {
          description
          sentiment
        }
        provider {
          title
        }
        riskLevel
      }
    }
  }`,
  {
    variables: {
      "input": {
        "orderId": "gid://shopify/Order/148977776",
        "riskLevel": "LOW",
        "facts": [
          {
            "description": "Payment verification successful.",
            "sentiment": "POSITIVE"
          },
          {
            "description": "Buyer verification inconclusive.",
            "sentiment": "NEUTRAL"
          }
        ]
      }
    },
  },
);

const data = await response.json();

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {
    orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {
      userErrors {
        field
        message
      }
      orderRiskAssessment {
        facts {
          description
          sentiment
        }
        provider {
          title
        }
        riskLevel
      }
    }
  }
QUERY

variables = {
  "input": {
    "orderId": "gid://shopify/Order/148977776",
    "riskLevel": "LOW",
    "facts": [{"description"=>"Payment verification successful.", "sentiment"=>"POSITIVE"}, {"description"=>"Buyer verification inconclusive.", "sentiment"=>"NEUTRAL"}]
  }
}

response = client.query(query: query, variables: variables)

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {
      orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {
        userErrors {
          field
          message
        }
        orderRiskAssessment {
          facts {
            description
            sentiment
          }
          provider {
            title
          }
          riskLevel
        }
      }
    }`,
    "variables": {
      "input": {
        "orderId": "gid://shopify/Order/148977776",
        "riskLevel": "LOW",
        "facts": [
          {
            "description": "Payment verification successful.",
            "sentiment": "POSITIVE"
          },
          {
            "description": "Buyer verification inconclusive.",
            "sentiment": "NEUTRAL"
          }
        ]
      }
    },
  },
});

use Shopify\Clients\Graphql;

$client = new Graphql("your-development-store.myshopify.com", $accessToken);
$query = <<<QUERY
  mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {
    orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {
      userErrors {
        field
        message
      }
      orderRiskAssessment {
        facts {
          description
          sentiment
        }
        provider {
          title
        }
        riskLevel
      }
    }
  }
QUERY;

$variables = [
  "input" => [
    "orderId" => "gid://shopify/Order/148977776",
    "riskLevel" => "LOW",
    "facts" => [{"description"=>"Payment verification successful.", "sentiment"=>"POSITIVE"}, {"description"=>"Buyer verification inconclusive.", "sentiment"=>"NEUTRAL"}],
  ],
];

$response = $client->query(["query" => $query, "variables" => $variables]);
Hide code
Input variables
Copy
{
  "input": {
    "orderId": "gid://shopify/Order/148977776",
    "riskLevel": "LOW",
    "facts": [
      {
        "description": "Payment verification successful.",
        "sentiment": "POSITIVE"
      },
      {
        "description": "Buyer verification inconclusive.",
        "sentiment": "NEUTRAL"
      }
    ]
  }
}
Hide code
Response
JSON
{
  "orderRiskAssessmentCreate": {
    "userErrors": [],
    "orderRiskAssessment": {
      "facts": [
        {
          "description": "Payment verification successful.",
          "sentiment": "POSITIVE"
        },
        {
          "description": "Buyer verification inconclusive.",
          "sentiment": "NEUTRAL"
        }
      ],
      "provider": {
        "title": "Risk API client"
      },
      "riskLevel": "LOW"
    }
  }
}