orderRiskAssessmentCreate

mutation

Requires write_orders access scope. Also: Access to orders is required to provide risk assessments.

Create a risk assessment for an order.

Arguments

Anchor to orderRiskAssessmentInputorderRiskAssessmentInput • OrderRiskAssessmentCreateInput!required: The input fields required to create a risk assessment.

Was this section helpful?

Anchor to OrderRiskAssessmentCreatePayload returnsOrderRiskAssessmentCreatePayload returns

Anchor to orderRiskAssessmentorderRiskAssessment • OrderRiskAssessment: The order risk assessment created.
Anchor to userErrorsuserErrors • [OrderRiskAssessmentCreateUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Create a risk assessment for an order
Create a risk assessment for an order, in the pending state
Creates an order risk for an order
orderRiskAssessmentCreate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation OrderRiskAssessmentCreate($input: OrderRiskAssessmentCreateInput!) {
6    orderRiskAssessmentCreate(orderRiskAssessmentInput: $input) {
7      userErrors {
8        field
9        message
10      }
11      orderRiskAssessment {
12        facts {
13          description
14          sentiment
15        }
16        provider {
17          title
18        }
19        riskLevel
20      }
21    }
22  }`,
23  {
24    variables: {
25      "input": {
26        "orderId": "gid://shopify/Order/148977776",
27        "riskLevel": "LOW",
28        "facts": [
29          {
30            "description": "Payment verification successful.",
31            "sentiment": "POSITIVE"
32          },
33          {
34            "description": "Buyer verification inconclusive.",
35            "sentiment": "NEUTRAL"
36          }
37        ]
38      }
39    },
40  },
41);
42
43const data = await response.json();
44

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/2024-04/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();

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"
          }
        ]
      }
    },
  },
});

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)

Input variables

JSON

1{
2  "input": {
3    "orderId": "gid://shopify/Order/148977776",
4    "riskLevel": "LOW",
5    "facts": [
6      {
7        "description": "Payment verification successful.",
8        "sentiment": "POSITIVE"
9      },
10      {
11        "description": "Buyer verification inconclusive.",
12        "sentiment": "NEUTRAL"
13      }
14    ]
15  }
16}

Response

JSON

1{
2  "orderRiskAssessmentCreate": {
3    "userErrors": [],
4    "orderRiskAssessment": {
5      "facts": [
6        {
7          "description": "Payment verification successful.",
8          "sentiment": "POSITIVE"
9        },
10        {
11          "description": "Buyer verification inconclusive.",
12          "sentiment": "NEUTRAL"
13        }
14      ],
15      "provider": {
16        "title": "Risk API client"
17      },
18      "riskLevel": "LOW"
19    }
20  }
21}