salesOrderSummary

Requires at least one of the permissions sales:sales_order:list or sales:sales_order:read.

Order counts and totals for the sales order list, scoped to the caller's customer visibility. Needs the sales order read or list permission.

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 SalesOrderSummary {
  salesOrderSummary {
    confirmedOrders
    deliveredOrders
    draftOrders
    lastUpdated
    pendingOrders
    pendingPaymentsValue
    recentOrders {
      id
      customerPoNumber
      orderNumber
      sourceQuoteNumber
      trackingNumber
      creatorName
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SalesOrderSummary {\n  salesOrderSummary {\n    confirmedOrders\n    deliveredOrders\n    draftOrders\n    lastUpdated\n    pendingOrders\n    pendingPaymentsValue\n    recentOrders {\n      id\n      customerPoNumber\n      orderNumber\n      sourceQuoteNumber\n      trackingNumber\n      creatorName\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "salesOrderSummary": {
      "confirmedOrders": 0,
      "deliveredOrders": 0,
      "draftOrders": 0,
      "lastUpdated": "2025-01-15T00:00:00Z",
      "pendingOrders": 0,
      "pendingPaymentsValue": 0,
      "recentOrders": [
        {
          "id": "id",
          "customerPoNumber": "string",
          "orderNumber": "string",
          "sourceQuoteNumber": "string",
          "trackingNumber": "string",
          "creatorName": "string"
        }
      ]
    }
  }
}

salesOrderSummary: SalesOrderSummary!

Type

SalesOrderSummary object

Counts and values across sales orders, for the dashboard.