commissionOrderGroups

Requires permission commissions:commission:read.

The commission ledger's by-order view: a page of orders, each with the commission rows of its chain. It takes the same filters as commissions; send skip and take to page, and use commissionOrderGroupsCount for the total. Needs the commission read 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 CommissionOrderGroups {
  commissionOrderGroups {
    orderNumber
    salesOrderId
    commissions {
      id
      orderNumber
      customerName
      repName
      status
      createdAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CommissionOrderGroups {\n  commissionOrderGroups {\n    orderNumber\n    salesOrderId\n    commissions {\n      id\n      orderNumber\n      customerName\n      repName\n      status\n      createdAt\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "commissionOrderGroups": [
      {
        "orderNumber": "string",
        "salesOrderId": "string",
        "commissions": [
          {
            "id": "id",
            "orderNumber": "string",
            "customerName": "string",
            "repName": "string",
            "status": "LOCKED",
            "createdAt": "2025-01-15T00:00:00Z"
          }
        ]
      }
    ]
  }
}

commissionOrderGroups(
  filters: CommissionFiltersInput
  skip: Int
  take: Int
): [CommissionOrderGroup!]!

Arguments

commissionOrderGroups.filters ● CommissionFiltersInput input

Optional filters, the same as commissions.

commissionOrderGroups.skip ● Int scalar

Number of orders to skip. Send with take for paging.

commissionOrderGroups.take ● Int scalar

Number of orders to return.

Type

CommissionOrderGroup object

One order of the ledger with every commission row it produced, one per member of the chain.