salesOrderConfirmPreview

Requires permission sales:sales_order:read.

What the approval rules would decide if this sales order were confirmed now (pass, needs approval or blocked), checked without confirming or changing it. Returns null when no approval rule on confirming orders is enabled or the order cannot be confirmed from its status. Outcome NOT_CHECKED means another change was using the order's records; the rules are checked again on confirm. Reps see only orders for their own customers.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query SalesOrderConfirmPreview($id: ID!) {
  salesOrderConfirmPreview(id: $id) {
    code
    controlId
    message
    outcome
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SalesOrderConfirmPreview($id: ID!) {\n  salesOrderConfirmPreview(id: $id) {\n    code\n    controlId\n    message\n    outcome\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "salesOrderConfirmPreview": {
      "code": "string",
      "controlId": "string",
      "message": "string",
      "outcome": "string"
    }
  }
}

salesOrderConfirmPreview(
  id: ID!
): SalesOrderConfirmPreview

Arguments

salesOrderConfirmPreview.id ● ID! non-null scalar

The ID of the sales order.

Type

SalesOrderConfirmPreview object

What the approval rules would decide if this sales order were confirmed now, checked without confirming it.