salesOrdersCount

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

Count the sales orders that match the same filters as salesOrders, without returning the orders. 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 SalesOrdersCount {
  salesOrdersCount
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SalesOrdersCount {\n  salesOrdersCount\n}"
}
EOF

Response:

{
  "data": {
    "salesOrdersCount": 0
  }
}

salesOrdersCount(
  filters: SalesOrderFiltersInput
): Int!

Arguments

salesOrdersCount.filters ● SalesOrderFiltersInput input

The same filters as salesOrders.

Type

Int scalar

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.